2016-07-16 23:42:23 +00:00
# npmextra
2017-03-18 15:23:47 +00:00
do more with npm
2016-07-18 22:36:19 +00:00
2016-09-16 20:28:38 +00:00
## Availabililty
2017-03-18 15:23:47 +00:00
[![npm ](https://pushrocks.gitlab.io/assets/repo-button-npm.svg )](https://www.npmjs.com/package/npmextra)
[![git ](https://pushrocks.gitlab.io/assets/repo-button-git.svg )](https://GitLab.com/pushrocks/npmextra)
[![git ](https://pushrocks.gitlab.io/assets/repo-button-mirror.svg )](https://github.com/pushrocks/npmextra)
[![docs ](https://pushrocks.gitlab.io/assets/repo-button-docs.svg )](https://pushrocks.gitlab.io/npmextra/)
2016-09-16 20:28:38 +00:00
## Status for master
2017-03-18 15:23:47 +00:00
[![build status ](https://GitLab.com/pushrocks/npmextra/badges/master/build.svg )](https://GitLab.com/pushrocks/npmextra/commits/master)
[![coverage report ](https://GitLab.com/pushrocks/npmextra/badges/master/coverage.svg )](https://GitLab.com/pushrocks/npmextra/commits/master)
[![npm downloads per month ](https://img.shields.io/npm/dm/npmextra.svg )](https://www.npmjs.com/package/npmextra)
2016-09-17 16:12:32 +00:00
[![Dependency Status ](https://david-dm.org/pushrocks/npmextra.svg )](https://david-dm.org/pushrocks/npmextra)
[![bitHound Dependencies ](https://www.bithound.io/github/pushrocks/npmextra/badges/dependencies.svg )](https://www.bithound.io/github/pushrocks/npmextra/master/dependencies/npm)
[![bitHound Code ](https://www.bithound.io/github/pushrocks/npmextra/badges/code.svg )](https://www.bithound.io/github/pushrocks/npmextra)
2016-09-16 20:28:38 +00:00
[![TypeScript ](https://img.shields.io/badge/TypeScript-2.x-blue.svg )](https://nodejs.org/dist/latest-v6.x/docs/api/)
[![node ](https://img.shields.io/badge/node->=%206.x.x-blue.svg )](https://nodejs.org/dist/latest-v6.x/docs/api/)
[![JavaScript Style Guide ](https://img.shields.io/badge/code%20style-standard-brightgreen.svg )](http://standardjs.com/)
2016-07-18 22:36:19 +00:00
## Usage
2017-03-18 15:23:47 +00:00
Use TypeScript for best in class instellisense.
2016-09-18 14:09:27 +00:00
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.
2016-07-18 22:36:19 +00:00
2016-09-16 20:28:38 +00:00
npmextra.json
```json
{
"sometool": {
"defaultKey1": "awesomeValueFromConfig"
}
}
```
2016-07-18 22:36:19 +00:00
```typescript
2016-09-24 14:52:38 +00:00
import { Npmextra } from 'npmextra'
2016-09-16 20:28:38 +00:00
2016-09-24 14:52:38 +00:00
let myNpmExtra = new Npmextra('my/path/to/cwd') // cwd argument is optional
mergedData = myNpmExtra.dataFor(
'sometool',
{ // gets merged with whatever is in the configfile
2016-09-16 20:28:38 +00:00
defaultKey1: 'defaultValue1', // so this will get overwritten with "awesomeValueFromConfig"
defaultKey2: 'defaultValue2' // this one will pass through unaltered
2016-09-24 14:52:38 +00:00
}
)
2016-09-16 20:28:38 +00:00
```
2016-07-18 22:36:19 +00:00
2017-03-18 15:23:47 +00:00
For further information read the linked docs at the top of this README.
> MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh)
| By using this npm module you agree to our [privacy policy ](https://lossless.gmbH/privacy.html )
[![repo-footer ](https://pushrocks.gitlab.io/assets/repo-footer.svg )](https://push.rocks)