https://github.com/antonk52/lilconfig

Zero-dependency nodejs config seeker.
https://github.com/antonk52/lilconfig

config configuration nodejs typescript

Last synced: 18 days ago
JSON representation

Zero-dependency nodejs config seeker.

• Host: GitHub
• URL: https://github.com/antonk52/lilconfig
• Owner: antonk52
• License: mit
• Created: 2020-02-07T16:07:11.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2024-05-09T20:38:39.000Z (6 months ago)
• Last Synced: 2024-05-22T08:43:56.043Z (6 months ago)
• Topics: config, configuration, nodejs, typescript
• Language: JavaScript
• Homepage:
• Size: 966 KB
• Stars: 145
• Watchers: 2
• Forks: 8
• Open Issues: 1
• Metadata Files:
  • Readme: readme.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Lilconfig ⚙️

[![npm version](https://badge.fury.io/js/lilconfig.svg)](https://badge.fury.io/js/lilconfig)

[![install size](https://packagephobia.now.sh/badge?p=lilconfig)](https://packagephobia.now.sh/result?p=lilconfig)

[![Coverage Status](https://coveralls.io/repos/github/antonk52/lilconfig/badge.svg)](https://coveralls.io/github/antonk52/lilconfig)

A zero-dependency alternative to [cosmiconfig](https://www.npmjs.com/package/cosmiconfig) with the same API.

## Installation

```sh

npm install lilconfig

```

## Usage

```js

import {lilconfig, lilconfigSync} from 'lilconfig';

// all keys are optional

const options = {

    stopDir: '/Users/you/some/dir',

    searchPlaces: ['package.json', 'myapp.conf.js'],

    ignoreEmptySearchPlaces: false

}

lilconfig(

    'myapp',

    options // optional

).search() // Promise

lilconfigSync(

    'myapp',

    options // optional

).load(pathToConfig) // LilconfigResult

/**

 * LilconfigResult

 * {

 *   config: any; // your config

 *   filepath: string;

 * }

 */

```

## ESM

ESM configs can be loaded with **async API only**. Specifically `js` files in projects with `"type": "module"` in `package.json` or `mjs` files.

## Difference to `cosmiconfig`

Lilconfig does not intend to be 100% compatible with `cosmiconfig` but tries to mimic it where possible. The key difference is **no** support for yaml files out of the box(`lilconfig` attempts to parse files with no extension as JSON instead of YAML). You can still add the support for YAML files by providing a loader, see an [example](#yaml-loader) below.

### Options difference between the two.

|cosmiconfig option      | lilconfig |

|------------------------|-----------|

|cache                   | ✅        |

|loaders                 | ✅        |

|ignoreEmptySearchPlaces | ✅        |

|packageProp             | ✅        |

|searchPlaces            | ✅        |

|stopDir                 | ✅        |

|transform               | ✅        |

## Loaders examples

### Yaml loader

If you need the YAML support you can provide your own loader

```js

import {lilconfig} from 'lilconfig';

import yaml from 'yaml';

function loadYaml(filepath, content) {

    return yaml.parse(content);

}

const options = {

    loaders: {

        '.yaml': loadYaml,

        '.yml': loadYaml,

        // loader for files with no extension

        noExt: loadYaml

    }

};

lilconfig('myapp', options)

    .search()

    .then(result => {

        result // {config, filepath}

    });

```

## Version correlation

- lilconig v1 → cosmiconfig v6

- lilconig v2 → cosmiconfig v7

- lilconig v3 → cosmiconfig v8