npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

key-value-file

v1.0.10

Published

A simple key/value file parser/writer

Downloads

962

Readme

key-value-file

This is a simple key/value file parser/writer. Its initial purpose is to handle parsing of .env files.

The main purpose is to be able to alter .env files programmatically

Usage

Manipulate an existing file

/* my-environment.env

key1 = value1
key2 = 2

key3= Some value with spaces
*/

import { parseFile } from 'key-value-file'

async function myFunc() {
  const kv = await parseFile('my-environment.env')

  kv.rename('key1', 'keyOne')
    .set('key2', 4)
    .delete('key3')
    .set('key4', 'new value')
    .writeFile()
}

This will write the following to my-environment.env:

keyOne = value1
key2 = 4

key4=new value

Create a new file programmatically

KeyValueFile.create('file.ext') loads the file if it exists. Otherwise the file will be created when KeyValueFile.writeFile() is called.

import { KeyValueFile } from 'key-value-file'
const file = KeyValueFile.create('.env')

file
  .set('key1', 'Value 1')
  .set('key2', 'Value 2')
  .addNewline()
  .addComment('Only used in test environment')
  .set('test1', 1)
  .set('test2', 2)
  .writeFile()

This will create a file with the following content:

key1=Value 1
key2=Value 2

# Only used in test environment
test1=1
test2=2

Quick doc

  • async parseFile(path: PathLike): KeyValueFile

  • KeyValueFile

    • path Property that returns the file path of the key/value file.

    • set(key: string, value: string | number): this Set the value of key to value. If key doesn't exist it is created.

    • get(key: string): string | undefined Returns the value of key, or undefined if the key doesn't exist.

    • delete(key: string): this Delete the key key and its value.

    • rename(key: string, newName: string): this Rename the key key to newName.

    • async writeFile(normalizeWhitespace = false): this Write the current data to the path of KeyValueFile. If normalizeWhitespace is true all excessive whitespace will be removed.

    • toString(normalizeWhitespace = false): string Convert the data to a key/value string. If normalizeWhitespace is true all excessive whitespace will be removed.

TODO

  • ~~Handle missing/empty values~~ (fixed) ~~Things will probably break right now if something like key= occurs.~~

  • Documentation Oh, how we like that.