Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/cnpm/npminstall

Make `npm install` fast and easy.
https://github.com/cnpm/npminstall

ied npm npm-like package-manager pnpm yarn

Last synced: 29 days ago
JSON representation

Make `npm install` fast and easy.

Awesome Lists containing this project

README 

        
# npminstall



[![NPM version][npm-image]][npm-url]

[![Node CI](https://github.com/cnpm/npminstall/actions/workflows/ci.yml/badge.svg)](https://github.com/cnpm/npminstall/actions/workflows/ci.yml)

[![Test coverage][codecov-image]][codecov-url]

[![Known Vulnerabilities][snyk-image]][snyk-url]

[![npm download][download-image]][download-url]

[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Fcnpm%2Fnpminstall.svg?type=shield)](https://app.fossa.com/projects/git%2Bgithub.com%2Fcnpm%2Fnpminstall?ref=badge_shield)



[npm-image]: https://img.shields.io/npm/v/npminstall.svg?style=flat-square

[npm-url]: https://npmjs.org/package/npminstall

[codecov-image]: https://codecov.io/gh/cnpm/npminstall/branch/master/graph/badge.svg

[codecov-url]: https://codecov.io/gh/cnpm/npminstall

[snyk-image]: https://snyk.io/test/npm/npminstall/badge.svg?style=flat-square

[snyk-url]: https://snyk.io/test/npm/npminstall

[download-image]: https://img.shields.io/npm/dm/npminstall.svg?style=flat-square

[download-url]: https://npmjs.org/package/npminstall



Make `npm install` fast and handy.



## Node.js and Python required



- Node.js >= 14.x

- Python >= 3.x



## Use as Cli



### Install



```bash

$ npm install npminstall -g

```



### Usage



#### In cnpm



It is integrated in [cnpm](https://github.com/cnpm/cnpm).



```bash

$ npm install cnpm -g

# will use npminstall

$ cnpm install

```



#### npminstall



```bash

Usage:



  npminstall

  npminstall 

  npminstall @

  npminstall @

  npminstall @

  npminstall @npm:

  npminstall 

  npminstall 

  npminstall 

  npminstall 

  npminstall /



Can specify one or more: npm install ./foo.tgz bar@stable /some/folder

If no argument is supplied, installs dependencies from ./package.json.



Options:



  --production: won't install devDependencies

  --save, --save-dev, --save-optional: save installed dependencies into package.json

  -g, --global: install devDependencies to global directory which specified in `$ npm config get prefix`

  -r, --registry: specify custom registry

  -c, --china: specify in china, will automatically using chinese npm registry and other binary's mirrors

  -d, --detail: show detail log of installation

  --trace: show memory and cpu usages traces of installation

  --ignore-scripts: ignore all preinstall / install and postinstall scripts during the installation

  --no-optional: ignore optionalDependencies during the installation

  --forbidden-licenses: forbit install packages which used these licenses

  --engine-strict: refuse to install (or even consider installing) any package that claims to not be compatible with the current Node.js version.

  --flatten: flatten dependencies by matching ancestors dependencies

  --registry-only: make sure that all packages are installed from registry. Any package that is installed from remote(e.g.: git, remote url) will lead to a failure of installation.

  --cache-strict: use disk cache even on production env

```



#### npmuninstall



```bash

Usage:



  npmuninstall 

  npmuninstall @

  npmuninstall @ [@]

  npminstall @npm:

```



#### npmlink



```bash

Usage:



  npmlink 

```



## Use as Lib



### Install



```bash

$ npm install npminstall --save

```



### Usage



```js

const npminstall = require('npminstall');



(async () => {

  await npminstall({

    // install root dir

    root: process.cwd(),

    // optional packages need to install, default is package.json's dependencies and devDependencies

    // pkgs: [

    //   { name: 'foo', version: '~1.0.0' },

    // ],

    // install to specific directory, default to root

    // targetDir: '/home/admin/.global/lib',

    // link bin to specific directory (for global install)

    // binDir: '/home/admin/.global/bin',

    // registry, default is https://registry.npmjs.org

    // registry: 'https://registry.npmjs.org',

    // debug: false,

    // storeDir: root + 'node_modules',

    // ignoreScripts: true, // ignore pre/post install scripts, default is `false`

    // forbiddenLicenses: forbit install packages which used these licenses

  });

})().catch(err => {

  console.error(err);

});

```



## Support Features



- [x] all types of npm package

  - [x] a) a folder containing a program described by a package.json file (`npm install file:eslint-rule`)

  - [x] b) a gzipped tarball containing (a) (`npm install ./rule.tgz`)

  - [x] c) a url that resolves to (b) (`npm install https://github.com/indexzero/forever/tarball/v0.5.6`)

  - [x] d) a @ that is published on the registry with (c)

  - [x] e) a @ (see npm-dist-tag) that points to (d)

  - [x] f) a  that has a "latest" tag satisfying (e)

  - [x] g) a  that resolves to (a) (`npm install git://github.com/timaschew/cogent#fix-redirects`)

- [x] All platform support

- [x] global install (`-g, --global`)

- [x] `preinstall`, `install`, `postinstall` scripts

- [x] node-gyp@9, only support Python@3

  - [x] node-pre-gyp

- [x] bin ([email protected], [email protected])

- [x] scoped package

- [x] bundleDependencies / bundledDependencies ([email protected], [email protected])

- [x] optionalDependencies ([email protected])

- [x] peerDependencies ([email protected], [email protected], [email protected])

- [x] deprecate message

- [x] `--production` mode

- [x] `save`, `save-dev`, `save-optional`

- [x] support `ignore-scripts`

- [x] uninstall

- [x] resolutions

- [x] [npm alias](https://github.com/npm/rfcs/blob/latest/implemented/0001-package-aliases.md)

- [x] [npm workspaces](https://docs.npmjs.com/cli/v9/using-npm/workspaces?v=true)



## Different with NPM



This project is inspired by [pnpm](https://github.com/pnpm/pnpm), and has a similar store structure like pnpm. You can read [pnpm vs npm](https://github.com/pnpm/pnpm/blob/master/docs/pnpm-vs-npm.md) to see the different with npm.



### Limitations



- You can't install from [shrinkwrap](https://docs.npmjs.com/cli/shrinkwrap)(and don't want to support for now).

- Peer dependencies are a little trickier to deal with(see rule 1 below).

- You can't publish npm modules with bundleDependencies managed by npminstall(because of rule 2 below).

- `npminstall` will collect all postinstall scripts, and execute them until all dependencies installed.

- If last install failed, better to cleanup node_modules directory before retry.



## `node_modules` directory



Two rules:



1. The latest version of modules will link at `options.storeDir`'s `node_modules`.

2. Module's dependencies will link at module's `node_modules`.



e.g.:



- app: `{ "dependencies": { "debug": "2.2.0" } }` (root)

- [email protected]: `{ "dependencies": { "ms": "0.7.1" } }`



```bash

app/

├── package.json

└── node_modules

    ├── [email protected]@debug

    │   ├── node_modules

    │   │   └── ms -> ../../[email protected]@ms

    ├── _ms0.7.1@ms

    ├── debug -> [email protected]@debug

    └── ms -> [email protected]@ms # for peerDependencies

```



### flattened vs nested



npminstall will always try to install the maximal matched version of semver:



```

root/

  [email protected]

  mod/

    koa@~1.1.0

# will install two different version of koa when use npminstall.

```



you can enable flatten mode by `--flatten` flag, in this mod, npminstall will try to use ancestors' dependencies to minimize the dependence-tree.



```

root/

  [email protected]

  mod/

    koa@~1.1.0



root/

  [email protected]

  mod/

    koa@^1.1.0

# both the same version: 1.1.0



root/

  koa@~1.1.0

  mod/

    koa@^1.1.0

# both the same version: 1.1.2



root/

  mod/

    koa@^1.1.0

  moe/

    koa@~1.1.0

# two different versions

```



**npminstall will always treat `n.x` and `n.m.x` as flattened**



```

root/

  [email protected]

  mod/

    [email protected]

both the same version: 1.1.0



root/

  koa@~1.1.0

  mod/

    [email protected]

both the same version: 1.1.2

```



## Resolutions



support [selective version resolutions](https://yarnpkg.com/en/docs/selective-version-resolutions) like yarn. which lets you define custom package versions inside your dependencies through the resolutions field in your `package.json` file.



resolutions also supports [npm alias](https://docs.npmjs.com/cli/v7/commands/npm-install). It's a workaround feature to fix some archived/inactive/ package by uploading your own bug-fixed version to npm registry.



see use case at [unittest package.json](./test/fixtures/resolutions-alias/package.json).



## Benchmarks



https://github.com/cnpm/npminstall-benchmark



### cnpmjs.org install



- [email protected]

- [email protected]

- [email protected]



cli | real | user | sys

--- | ---  | ---  | ---

npminstall | 0m10.908s | 0m8.733s | 0m4.282s

npminstall with cache | 0m8.815s | 0m7.492s | 0m3.644s

npminstall --no-cache | 0m10.279s | 0m8.255s | 0m3.932s

pnpm | 0m13.509s | 0m11.650s | 0m4.443s

npm | 0m28.171s | 0m26.085s | 0m8.219s

npm with cache | 0m20.939s | 0m19.415s | 0m6.302s



### pnpm benchmark



see https://github.com/pnpm/pnpm#benchmark



```bash

npminstall babel-preset-es2015 browserify chalk debug minimist mkdirp

    real	0m8.929s       user	0m5.606s       sys	0m2.913s

```



```bash

pnpm i babel-preset-es2015 browserify chalk debug minimist mkdirp

    real	0m12.998s      user	0m8.653s       sys	0m3.362s

```



```bash

npm i babel-preset-es2015 browserify chalk debug minimist mkdirp

    real	1m4.729s       user	0m55.589s      sys	0m23.135s

```



## License



[MIT](LICENSE.txt)



## Contributors



|[
fengmk2](https://github.com/fengmk2)
|[
dead-horse](https://github.com/dead-horse)
|[
gemwuu](https://github.com/gemwuu)
|[
semantic-release-bot](https://github.com/semantic-release-bot)
|[
killagu](https://github.com/killagu)
|[
ibigbug](https://github.com/ibigbug)
|

| :---: | :---: | :---: | :---: | :---: | :---: |

|[
vagusX](https://github.com/vagusX)
|[
afc163](https://github.com/afc163)
|[
yesmeck](https://github.com/yesmeck)
|[
popomore](https://github.com/popomore)
|[
we11adam](https://github.com/we11adam)
|[
whatwewant](https://github.com/whatwewant)
|

|[
emma-owen](https://github.com/emma-owen)
|[
weihong1028](https://github.com/weihong1028)
|[
HomyeeKing](https://github.com/HomyeeKing)
|[
nightink](https://github.com/nightink)
|[
XadillaX](https://github.com/XadillaX)
|[
LeoYuan](https://github.com/LeoYuan)
|

|[
cnlon](https://github.com/cnlon)
|[
Moudicat](https://github.com/Moudicat)
|[
hanzhao](https://github.com/hanzhao)
|[
marcbachmann](https://github.com/marcbachmann)
|[
MondoGao](https://github.com/MondoGao)
|[
snyk-bot](https://github.com/snyk-bot)
|

|[
Solais](https://github.com/Solais)
|[
thonatos](https://github.com/thonatos)
|[
atian25](https://github.com/atian25)
|[
tommytroylin](https://github.com/tommytroylin)
|[
wssgcg1213](https://github.com/wssgcg1213)
|[
yibn2008](https://github.com/yibn2008)
|

[
fossabot](https://github.com/fossabot)
|[
hugohua](https://github.com/hugohua)
|[
hyj1991](https://github.com/hyj1991)
|[
mansonchor](https://github.com/mansonchor)
|[
givingwu](https://github.com/givingwu)
|[
Abreto](https://github.com/Abreto)



This project follows the git-contributor [spec](https://github.com/xudafeng/git-contributor), auto updated at `Sat Mar 25 2023 22:23:53 GMT+0800`.