48 lines
2.4 KiB
Markdown
48 lines
2.4 KiB
Markdown
# npmextra
|
|
do more with npm.
|
|
|
|
npmextra is a hub for a series of js tools that help writing, documenting and maintaining npm modules.
|
|
|
|
## Availabililty
|
|
[](https://www.npmjs.com/package/npmextra)
|
|
[](https://gitlab.com/pushrocks/npmextra)
|
|
[](https://github.com/pushrocks/npmextra)
|
|
[](https://pushrocks.gitlab.io/npmextra/)
|
|
|
|
## Status for master
|
|
[](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)
|
|
[](https://nodejs.org/dist/latest-v6.x/docs/api/)
|
|
[](https://nodejs.org/dist/latest-v6.x/docs/api/)
|
|
[](http://standardjs.com/)
|
|
|
|
## Usage
|
|
The main purpose of npmextra is to configure different tools using one npmextra.json. This way complex setups avaoid complexity through many configuration files.
|
|
|
|
npmextra.json
|
|
```json
|
|
{
|
|
"sometool": {
|
|
"defaultKey1": "awesomeValueFromConfig"
|
|
}
|
|
}
|
|
```
|
|
|
|
```typescript
|
|
import * as npmextra from 'npmextra'
|
|
|
|
npmextra.dataFor({
|
|
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
|
|
})
|
|
```
|
|
|
|
[](https://push.rocks)
|