https://github.com/poppa/key-value-file

Simple key/value file parser/writer
https://github.com/poppa/key-value-file

dotenv dotenv-parser keyvalue keyvalue-files nodejs parser typescript

Last synced: 2 months ago
JSON representation

Simple key/value file parser/writer

• Host: GitHub
• URL: https://github.com/poppa/key-value-file
• Owner: poppa
• License: mit
• Created: 2019-09-18T14:33:59.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2024-08-21T04:43:56.000Z (5 months ago)
• Last Synced: 2024-10-11T12:55:34.675Z (3 months ago)
• Topics: dotenv, dotenv-parser, keyvalue, keyvalue-files, nodejs, parser, typescript
• Language: TypeScript
• Size: 1.17 MB
• Stars: 1
• Watchers: 3
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

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

```ts

/* 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.

```ts

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.