didone

didone

Minimalist dotenv-like parser for the browser. Pronounced "dee-doh-neh".

This zero-dependency library is a minimalist dotenv-like parser. Given a string, it returns an array of objects with the following properties:

• key: The key of the variable.
• value: The value of the variable. Multi-line values are supported.
• duplicate: Whether the key is duplicated or not.

DB_HOST=localhost
DB_PORT="5432"
DB_USER=myuser
DB_USER=myuser2 # Duplicate keys are parsed but marked as duplicates

Output

[
  {
    "duplicate": false,
    "key": "DB_HOST",
    "value": "localhost"
  },
  {
    "duplicate": false,
    "key": "DB_PORT",
    "value": "5432"
  },
  {
    "duplicate": false,
    "key": "DB_USER",
    "value": "myuser"
  },
  {
    "duplicate": true,
    "key": "DB_USER",
    "value": "myuser2"
  }
]

Install

npm i didone

Usage

parse

import { parse } from "didone";

const values = parse(
  `
DB_HOST=localhost
DB_PORT="5432" # Quoted values
DB_USER=myuser
  `
);

Options

The default RegExp used to validate env keys is /^[a-zA-Z_.-][a-zA-Z0-9_.-]*$/. This means that keys must be alphanumeric but must not start with a number. However, they can start with or contain underscores, dashes, and periods.

You can customize the RegExp via the regexEnvKey option.

parse("...", {
  regexEnvKey: /^[a-zA-Z][a-zA-Z0-9_.-]*$/,
});

serialize

import { serialize } from "didone";

const text = serialize([
  {
    duplicate: false,
    key: "FOO",
    value: "bar",
  },
]);

console.log(text); // "FOO=bar"

Options

Set removeDuplicates to true to remove duplicate keys.

serialize(values, {
  removeDuplicates: true,
});

Changelog

CHANGELOG.md

License

MIT

Changelog

0.2.0 - 2024-01-13

• Rename parseDotEnv to parse
• Add serialize to serialize parsed values back to text