npm commands wrapper for pisco
Any step can ensure that npm install or npm update are correctly executed:
Add package dependency:
npm install pisco-plugin-npm --save
Add plugin on steps/$stepName/config.json plugins:
{
"plugins": [
[...]
"npm"
]
}
{
"npmDependencies": {
"installed": true,
"updated": true,
"baseDir" : "any", (default is '.')
"directory" : "node_modules" (default is 'node_modules')
}
}
- installed (default: false) Ensure that npm install is executed if ${npm.directory} doesn't exists execute npm install.
- updated (default: false) Ensure that
npm update
andnpm prune
are executed. Detect if there are symbolics links and ask user to delete - directory (default: 'node_modules') must to be the same value of
directory
in .npmrc file. - baseDir (default: '.') path to npm.json file relative.
By default the hook is set on check stage
In config.json of your step
{
"stages" : ["check","run"],
"npmDependencies": {
[...]
}
}
Normal use, ensure npm install was executed:
{
"npmDependencies": {
"installed": true
}
}
Check if there are symbolics links and ask user to update:
{
"npmDependencies": {
"updated": true
}
}
Execute npm list ${opts}
Param | Description |
---|---|
opts | array with command options to append to npm list for example [ '--offline', '--json' ] |
returns | a Promise with the complete child_process object result of the execution |
Plugin used to registry npm modules into a public npm registry
How to use this plugin:
-
- Implicit: Calling public addons.
-
- Explicit: By configuration. Checks if npm Registry is well configured.
configure this.params.stages with an array of the stages you want to check if the npm registry is ok.
"stages" : ["check", "run"]
This parameters should be set on the step:
- --registryUrl: [String], default: 'undefined' : Url of the npm registry. by default use what is configured on .npmrc
Note: you can change the repository that artifacts is going to be published by adding a .piscosour/piscosour.json file like this:
{
"params" : {
"registryUrl" : "https://registry.npmjs.org/"
}
}
Return: 0 if everything is Ok or status of the command executed.