2016-07-16 23:42:23 +00:00
# npmextra
2016-09-16 20:28:38 +00:00
do more with npm.
2016-07-16 23:42:23 +00:00
2016-07-16 23:54:57 +00:00
npmextra is a hub for a series of js tools that help writing, documenting and maintaining npm modules.
2016-07-18 22:36:19 +00:00
2016-09-16 20:28:38 +00:00
## Availabililty
2016-09-17 16:12:32 +00:00
[](https://www.npmjs.com/package/npmextra)
[](https://gitlab.com/pushrocks/npmextra)
[](https://github.com/pushrocks/npmextra)
[](https://pushrocks.gitlab.io/npmextra/)
2016-09-16 20:28:38 +00:00
## Status for master
2016-09-17 16:12:32 +00:00
[](https://gitlab.com/pushrocks/npmextra/commits/master)
[](https://gitlab.com/pushrocks/npmextra/commits/master)
[](https://david-dm.org/pushrocks/npmextra)
[](https://www.bithound.io/github/pushrocks/npmextra/master/dependencies/npm)
[](https://www.bithound.io/github/pushrocks/npmextra)
2016-09-16 20:28:38 +00:00
[](https://nodejs.org/dist/latest-v6.x/docs/api/)
[](https://nodejs.org/dist/latest-v6.x/docs/api/)
[](http://standardjs.com/)
2016-07-18 22:36:19 +00:00
## Usage
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-16 20:28:38 +00:00
import * as npmextra from 'npmextra'
2016-07-18 22:36:19 +00:00
npmextra.dataFor({
2016-09-16 20:28:38 +00:00
toolName:'sometool',
defaultSettings: { // 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
},
cwd?: string // lets you specifiy a custom current working directory to look for the npmextra.json
})
```
2016-07-18 22:36:19 +00:00
2016-09-16 20:28:38 +00:00
[](https://push.rocks)
