push.rocks/npmextra
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

update dependencies and readme

Browse Source
This commit is contained in:
Philipp Kunz 2017-07-20 17:13:01 +02:00
parent 09d9fd45cf
commit 07cdcb074d
3 changed files with 10 additions and 26 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
README.md
View File

@ -21,30 +21,6 @@ do more with npm
## Usage ## Usage
Use TypeScript for best in class instellisense. Use TypeScript for best in class instellisense.
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
```json
{
"sometool": {
"defaultKey1": "awesomeValueFromConfig"
}
}
```
```typescript
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
}
)
```
For further information read the linked docs at the top of this README. For further information read the linked docs at the top of this README.
> MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh) > MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh)

7
docs/index.md
View File

@ -21,6 +21,7 @@ do more with npm
## Usage ## Usage
Use TypeScript for best in class instellisense. 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. 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 npmextra.json
@ -45,6 +46,12 @@ mergedData = myNpmExtra.dataFor(
) )
``` ```
### Tools that already use the config feature of npmextra
* [npmts](https://www.npmjs.com/package/npmts)
* [npmci](https://www.npmjs.com/package/npmci)
* [npmdocker](https://www.npmjs.com/package/npmdocker)
For further information read the linked docs at the top of this README. For further information read the linked docs at the top of this README.
> MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh) > MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh)

5
package.json
View File

@ -23,9 +23,10 @@
"smartlodash": "^1.0.1", "smartlodash": "^1.0.1",
"smartpath": "^3.2.8", "smartpath": "^3.2.8",
"smartq": "^1.1.6", "smartq": "^1.1.6",
"tapbundle": "^1.1.1",
"taskbuffer": "^1.0.22", "taskbuffer": "^1.0.22",
"typings-global": "^1.0.19" "typings-global": "^1.0.19"
}, },
"devDependencies": {} "devDependencies": {
"tapbundle": "^1.1.1"
}
} }