key-value-file

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.