Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/aprilandjan/check-npm-client
check or ensure which npm client(yarn/npm) is currently used
https://github.com/aprilandjan/check-npm-client
ensure-npm-client npm npm-client npm-scripts npm-user-agent yarn
Last synced: 22 days ago
JSON representation
check or ensure which npm client(yarn/npm) is currently used
- Host: GitHub
- URL: https://github.com/aprilandjan/check-npm-client
- Owner: aprilandjan
- License: mit
- Created: 2019-11-02T14:36:12.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2021-05-10T20:06:14.000Z (over 3 years ago)
- Last Synced: 2024-11-11T04:13:45.204Z (3 months ago)
- Topics: ensure-npm-client, npm, npm-client, npm-scripts, npm-user-agent, yarn
- Language: JavaScript
- Homepage: https://www.npmjs.com/package/check-npm-client
- Size: 66.4 KB
- Stars: 3
- Watchers: 3
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# [check-npm-client](https://www.npmjs.com/package/check-npm-client)
[](https://www.npmjs.com/package/check-npm-client) [](https://www.npmjs.com/package/check-npm-client)
`npm` and `yarn` are both npm clients used to manage node.js project dependencies. They are somehow different in some behavior, and thus can affect project running.
This package provides ready-to-use functionality to check current npm client. When used as [pre](https://docs.npmjs.com/misc/scripts#hook-scripts) commands in npm scripts, it will check if the script is executed by specific npm client (`yarn` or `npm`). If it is restricted, then the script execution will be aborted early.
## Usage Scenario
`yarn` uses [yarn.lock](https://yarnpkg.com/lang/en/docs/yarn-lock/) to ensure versions of dependencies, but `npm` use [package-lock.json](https://docs.npmjs.com/files/package-lock.json) to do that instead. If you use `yarn` to install dependencies in a project which is actually managed by `npm` and `package-lock.json`, the actually installed dependencies in `node_modules` might be different due to [semver](https://docs.npmjs.com/misc/semver) behavior, and this could lead to some un-expected exception while code running.
This is common when working with others because people tends to use `yarn` or `npm` as their wishes.
## Installation
```bash
$ npm install check-npm-client
```
or alternatively, with `yarn`:
```bash
$ yarn add check-npm-client
```
## Example
This package provide a command line tool to invoke checking functionality:
```bash
# the user must use `npm` to execute the script
$ check-npm-client --npm-only
# the user must use `yarn` to execute the script
$ check-npm-client --yarn-only
# automatically check according to current working directory lock files if exists
$ check-npm-client
```
Besides, you can use it programmatically:
```javascript
const { checkNpmClient } = require('check-npm-client');
console.log(checkNpmClient('yarn')); // true/false
```
### Ensure before installation
Add the script in your `package.json` to ensure that user must install dependencies with `yarn`:
```json
{
"scripts": {
"preinstall": "npx check-npm-client --yarn-only"
}
}
```
**Note #1**: `npx` is required to execute checking because before your project installation, the command `check-npm-client` won't be available.
**Note #2**: `yarn` and `npm` treat `preinstall` script a little differently. `npm` execute it only before `npm install` (not before `npm install `), but `yarn` always run it before any installation. See [issue](https://github.com/npm/cli/issues/481) here. So if specified as `--yarn-only` and user use `npm` to install another dependency, the `preinstall` will not be invoked (so the ensurance will fail).
### Ensure before any other script
Add the script in your `package.json` to ensure that user must use `npm` to run the script `my-task`:
```json
{
"scripts": {
"premy-task": "check-npm-client --npm-only",
"my-task": "node my-task.js"
}
}
```
## References
-
-
-
-
-
-