npmpackage.info

Gathering detailed insights and metrics for @shellscape/lilconfig

@shellscape/lilconfig

Zero-dependency nodejs config seeker.

3.2.1

158

MIT

JavaScript

35,480 3.6

Installations

npm install @shellscape/lilconfig

Score

84.6

Supply Chain

99.1

Quality

76.9

Maintenance

100

Vulnerability

100

License

Pull Requests

Open

1

Total

42

Closed

8

Merged

33

Issues

Open

2

Total

13

Closed

11

Releases

v3.1.2 Webpack friendly

v3.1.2

Published on 09 Jun 2024

v3.1.1 Security release

v3.1.1

Published on 18 Feb 2024

v3.1.0 Support ESM config files (async api only)

v3.1.0

Published on 14 Feb 2024

v3.0.0 Cache support

v3.0.0

Published on 19 Nov 2023

v2.1.0 adds support for `.config/<name>rc` files

v2.1.0

Published on 02 Mar 2023

v2.0.6 adds missing LICENSE file

v2.0.6

Published on 10 Jul 2022

View all 13 releases

Developer

antonk52

Developer Guide

BETA

Module System

CommonJS

Min. Node Version

>=14

Typescript Support

Yes

Node Version

18.19.1

NPM Version

10.2.4 Statistics

158 Stars

125 Commits

9 Forks

2 Watching

3 Branches

8 Contributors

Updated on 27 Nov 2024

Languages

JavaScript (99.88%)

CoffeeScript (0.06%)

TypeScript (0.05%)

Total Downloads

Cumulative downloads

Total Downloads

35,480

Last day

-12.2%

1,605

Compared to previous day

Last week

24.9%

7,691

Compared to previous week

Last month

480.1%

30,001

Compared to previous month

Last year

35,480

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dev Dependencies

@biomejs/biome @types/jest @types/node cosmiconfig jest typescript uvu

Versions

Lilconfig ⚙️

A zero-dependency alternative to cosmiconfig with the same API.

Installation

1npm install lilconfig

Usage

1import {lilconfig, lilconfigSync} from 'lilconfig';
2
3// all keys are optional
4const options = {
5    stopDir: '/Users/you/some/dir',
6    searchPlaces: ['package.json', 'myapp.conf.js'],
7    ignoreEmptySearchPlaces: false
8}
9
10lilconfig(
11    'myapp',
12    options // optional
13).search() // Promise<LilconfigResult>
14
15lilconfigSync(
16    'myapp',
17    options // optional
18).load(pathToConfig) // LilconfigResult
19
20/**
21 * LilconfigResult
22 * {
23 *   config: any; // your config
24 *   filepath: string;
25 * }
26 */

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 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

1import {lilconfig} from 'lilconfig';
2import yaml from 'yaml';
3
4function loadYaml(filepath, content) {
5    return yaml.parse(content);
6}
7
8const options = {
9    loaders: {
10        '.yaml': loadYaml,
11        '.yml': loadYaml,
12        // loader for files with no extension
13        noExt: loadYaml
14    }
15};
16
17lilconfig('myapp', options)
18    .search()
19    .then(result => {
20        result // {config, filepath}
21    });

Version correlation

lilconig v1 → cosmiconfig v6
lilconig v2 → cosmiconfig v7
lilconig v3 → cosmiconfig v8

No vulnerabilities found.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

10

License

Determines if the project has defined a license.

7

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

6

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

Reason

dependency not pinned by hash detected -- score normalized to 6

Details

Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/nodejs.yaml:45: update your workflow using https://app.stepsecurity.io/secureworkflow/antonk52/lilconfig/nodejs.yaml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/nodejs.yaml:47: update your workflow using https://app.stepsecurity.io/secureworkflow/antonk52/lilconfig/nodejs.yaml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/nodejs.yaml:61: update your workflow using https://app.stepsecurity.io/secureworkflow/antonk52/lilconfig/nodejs.yaml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/nodejs.yaml:63: update your workflow using https://app.stepsecurity.io/secureworkflow/antonk52/lilconfig/nodejs.yaml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/nodejs.yaml:77: update your workflow using https://app.stepsecurity.io/secureworkflow/antonk52/lilconfig/nodejs.yaml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/nodejs.yaml:79: update your workflow using https://app.stepsecurity.io/secureworkflow/antonk52/lilconfig/nodejs.yaml/master?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/nodejs.yaml:87: update your workflow using https://app.stepsecurity.io/secureworkflow/antonk52/lilconfig/nodejs.yaml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/nodejs.yaml:13: update your workflow using https://app.stepsecurity.io/secureworkflow/antonk52/lilconfig/nodejs.yaml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/nodejs.yaml:15: update your workflow using https://app.stepsecurity.io/secureworkflow/antonk52/lilconfig/nodejs.yaml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/nodejs.yaml:29: update your workflow using https://app.stepsecurity.io/secureworkflow/antonk52/lilconfig/nodejs.yaml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/nodejs.yaml:31: update your workflow using https://app.stepsecurity.io/secureworkflow/antonk52/lilconfig/nodejs.yaml/master?enable=pin
Info: 0 out of 10 GitHub-owned GitHubAction dependencies pinned
Info: 0 out of 1 third-party GitHubAction dependencies pinned
Info: 5 out of 5 npmCommand dependencies pinned

1

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

0

Maintained

Determines if the project is "actively maintained".

0

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Security-Policy

Determines if the project has published a security policy.

0

Fuzzing

Determines if the project uses fuzzing.

0

Branch-Protection

Determines if the default and release branches are protected with GitHub's branch protection settings.

0

SAST

Determines if the project uses static code analysis.

Score

3.6

/10

Last Scanned on 2024-11-25

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More

@shellscape/lilconfig

Installations

Score

Pull Requests

1

42

8

33

Issues

2

13

11

Releases

Developer

antonk52

Developer Guide

CommonJS

>=14

Yes

18.19.1

10.2.4

Statistics

Languages

Total Downloads

35,480

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dev Dependencies

Lilconfig ⚙️

Installation

Usage

ESM

Difference to cosmiconfig

Options difference between the two.

Loaders examples

Yaml loader

Version correlation

10

10

10

7

6

1

0

0

0

0

0

0

0

3.6

/10

Difference to `cosmiconfig`