BREAKING CHANGE(scope): change to @pushrocks scope
This commit is contained in:
		| @@ -1,13 +1,16 @@ | ||||
| # npmextra | ||||
|  | ||||
| do more with npm | ||||
|  | ||||
| ## 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://www.npmjs.com/package/npmextra) | ||||
| @@ -19,45 +22,45 @@ do more with npm | ||||
| [](http://standardjs.com/) | ||||
|  | ||||
| ## 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 | ||||
|  | ||||
| ```json | ||||
| { | ||||
|     "sometool": { | ||||
|         "defaultKey1": "awesomeValueFromConfig" | ||||
|     } | ||||
|   "sometool": { | ||||
|     "defaultKey1": "awesomeValueFromConfig" | ||||
|   } | ||||
| } | ||||
| ``` | ||||
|  | ||||
| ```typescript | ||||
| import { Npmextra } from 'npmextra' | ||||
| 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 | ||||
|     } | ||||
| ) | ||||
| 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 | ||||
|  | ||||
| * [npmts](https://www.npmjs.com/package/npmts) | ||||
| * [npmci](https://www.npmjs.com/package/npmci) | ||||
| * [npmdocker](https://www.npmjs.com/package/npmdocker) | ||||
| - [npmts](https://www.npmjs.com/package/npmts) | ||||
| - [npmci](https://www.npmjs.com/package/npmci) | ||||
| - [npmdocker](https://www.npmjs.com/package/npmdocker) | ||||
|  | ||||
| ## Using the KeyValueStore | ||||
|  | ||||
|  | ||||
| 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) | ||||
| > | By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy.html) | ||||
|  | ||||
| [](https://push.rocks) | ||||
|   | ||||
		Reference in New Issue
	
	Block a user