Enhances npm with additional configuration and tool management capabilities, including a key-value store for project setups.
Go to file
2023-08-03 19:28:10 +02:00
.gitea/workflows fix(core): update 2023-08-03 19:22:34 +02:00
.vscode fix(core): update 2023-08-03 19:22:34 +02:00
test fix(core): update 2023-08-03 19:22:34 +02:00
ts fix(core): update 2023-08-03 19:28:10 +02:00
.gitignore fix(core): update 2021-01-27 21:00:49 +00:00
npmextra.json fix(core): update 2023-08-03 19:22:34 +02:00
package.json fix(core): update 2023-08-03 19:28:10 +02:00
pnpm-lock.yaml fix(core): update 2023-08-03 19:22:34 +02:00
readme.md fix(core): update 2023-08-03 19:22:34 +02:00
tsconfig.json fix(core): update 2023-08-03 19:22:34 +02:00

@push.rocks/npmextra

do more with npm

Status for master

Status Category Status Badge
GitLab Pipelines pipeline status
GitLab Pipline Test Coverage coverage report
npm npm downloads per month
Snyk Known Vulnerabilities
TypeScript Support TypeScript
node Support node
Code Style Code Style
PackagePhobia (total standalone install weight) PackagePhobia
PackagePhobia (package size on registry) PackagePhobia
BundlePhobia (total size when bundled) BundlePhobia

Usage

Use TypeScript for best in class instellisense.

Using npmextra for managing toolconfigs

The main purpose of npmextra is to configure different tools using one npmextra.json. This way complex setups avoid additional complexity caused by too many configuration files.

npmextra.json

{
  "sometool": {
    "defaultKey1": "awesomeValueFromConfig"
  }
}
import { Npmextra } from 'npmextra';

let myNpmExtra = new Npmextra('my/path/to/cwd'); // cwd argument is optional
mergedData = myNpmExtra.dataFor('sometool', {
  // gets merged with whatever is in the configfile
  defaultKey1: 'defaultValue1', // so this will get overwritten with "awesomeValueFromConfig"
  defaultKey2: 'defaultValue2', // this one will pass through unaltered
});

Tools that already use the config feature of npmextra

Using the KeyValueStore

Contribution

We are always happy for code contributions. If you are not the code contributing type that is ok. Still, maintaining Open Source repositories takes considerable time and thought. If you like the quality of what we do and our modules are useful to you we would appreciate a little monthly contribution: You can contribute one time or contribute monthly. :)

For further information read the linked docs at the top of this readme.

MIT licensed | © Task Venture Capital GmbH | By using this npm module you agree to our privacy policy