3.0.9 • Published 3 years ago

@pushrocks/npmextra v3.0.9

Weekly downloads
13
License
MIT
Repository
gitlab
Last release
3 years ago

@pushrocks/npmextra

do more with npm

Availabililty and Links

Status for master

Status CategoryStatus Badge
GitLab Pipelinespipeline status
GitLab Pipline Test Coveragecoverage report
npmnpm downloads per month
SnykKnown Vulnerabilities
TypeScript SupportTypeScript
node Supportnode
Code StyleCode Style
PackagePhobia (total standalone install weight)PackagePhobia
PackagePhobia (package size on registry)PackagePhobia
BundlePhobia (total size when bundled)BundlePhobia
Platform supportSupports Windows 10 Supports Mac OS X

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 | © Lossless GmbH | By using this npm module you agree to our privacy policy

repo-footer