install-group
Dependency grouping for npm install
Motivation
npm no longer auto installs peerDependencies
npm only recognizes dependencies, devDependencies and optionalDependencies
your workflow might require declaring a new type of Dependencies that doesn't fit any of the above
zero dependencies
How it works
install-group simply takes an argument dependencies, compares it against your package.json and runs npm install for any dependency listed under that group using npm install
Example
install-group [dependencies] --package [name] < options > copy
install-group peer --package @ahmadnassri/build-essential --global copy
executed result
npm install --global @ahmadnassri/eslint-config@^1.1.1 @ahmadnassri/remark-config@^1.0.0 @ahmadnassri/semantic-release-config@^1.0.6 editorconfig-checker@^1.3.3 eslint@^5.7.0 install-peerdeps@^1.9.0 node-release-lines@^1.3.1 npm-run-all@^4.1.3 remark-cli@^6.0.0 semantic-release@^15.10.5 updated@^1.1.0 copy
Install
npm install install-group copy
CLI
use as a CLI
Usage
install-group [dependencies] --package [name] < options > copy
parameter required default description dependencies✅ -dependencies to install from target packagepackage❌ -package name to pull from npm registry options❌ -list of CLI parameters to pass to npm install
Notes :
if no --package parameter is provided, install-group will scan local package.json file for dependencies
dependencies can be any value in package.json regardless of what npm officially supports
API
use as a module
scan({ dependencies, package, cwd })
argument required default description dependencies✅ proddependencies to install from target packagepackage❌ -package name to pull from npm registry cwd❌ process.cwd()working directory, path to package.json
Notes :
if no package is provided, install-group will scan local package.json file at cwd for dependencies
dependencies can be any value in package.json regardless of what npm officially supports
const scan = require ( "install-group" );
// scan local package.json
scan ({ dependencies: "foo" });
// scan a package from npm registry
scan ({ dependencies: "peer" , package: "@ahmadnassri/build-essential" }); copy
result example
[
"@ahmadnassri/eslint-config@^1.1.1" ,
"@ahmadnassri/remark-config@^1.0.0" ,
"@ahmadnassri/semantic-release-config@^1.0.6" ,
"editorconfig-checker@^1.3.3" ,
"eslint@^5.7.0" ,
"install-peerdeps@^1.9.0" ,
"node-release-lines@^1.3.1" ,
"npm-run-all@^4.1.3" ,
"remark-cli@^6.0.0" ,
"semantic-release@^15.10.5" ,
"updated@^1.1.0"
] copy
Author: Ahmad Nassri •
Twitter: @AhmadNassri