Son CV dans un terminal web en Javascript!
https://terminal-cv.gregandev.fr
You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
greglebreton
4e8a693745
|
2 years ago | |
---|---|---|
.. | ||
dist | 2 years ago | |
package.json | 2 years ago | |
readme.md | 2 years ago |
readme.md
Lilconfig ⚙️
A zero-dependency alternative to cosmiconfig with the same API.
Installation
npm install lilconfig
Usage
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<LilconfigResult>
lilconfigSync(
'myapp',
options // optional
).load(pathToConfig) // LilconfigResult
/**
* LilconfigResult
* {
* config: any; // your config
* filepath: string;
* }
*/
Difference to cosmiconfig
Lilconfig does not intend to be 100% compatible with cosmiconfig
but tries to mimic it where possible. The key differences are:
- 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 below. - no cache
Options difference between the two.
cosmiconfig option | lilconfig |
---|---|
cache | ❌ |
loaders | ✅ |
ignoreEmptySearchPlaces | ✅ |
packageProp | ✅ |
searchPlaces | ✅ |
stopDir | ✅ |
transform | ✅ |
Loaders example
If you need the YAML support you can provide your own loader
import {lilconig} from 'lilconfig';
import yaml from 'yaml';
const options = {
loaders: {
'.yaml': (filepath, content) => {
return yaml.parse(content);
},
// loader for files with no extension
noExt: (filepath, content) => {
return yaml.parse(content);
}
}
};
lilconfig('myapp', options)
.search()
.then(result => {
result // {config, filepath}
});
Version correlation
- lilconig v1 → cosmiconfig v6
- lilconig v2 → cosmiconfig v7