Assert that a certain package manager was used when running a yarn/npm script.
yarn and npm have started to diverge in feature set. For example yarn introduced workspaces, which do not work with npm (yet).
To avoid contributors accidentally using the "wrong" package manager and getting hard to debug errors, you can use assert-pm as a postinstall script. It'll cause the installation to fail and warn the user.
yarn add --dev assert-pm
npm install --dev assert-pm
If you are managing your packages with workspaces, you can add it to your parent package.json as postinstall script. Make sure to not add it to packages you do publish as this script will also be run upon installation by users.
"scripts": {
"postinstall": "assert-pm yarn --message"
}
If anyone now runs
npm install
they will get an error:
pmtest@1.0.0 postinstall
> assert-pm yarn
Please use yarn.
npm ERR! code ELIFECYCLE
assert-pm package-manager --message "We are managing our packages using yarn workspaces. Therefore this project requires yarn to install packages."
FAQs
Assert that a certain package manager was used when running a yarn/npm script.
The npm package assert-pm receives a total of 3 weekly downloads. As such, assert-pm popularity was classified as not popular.
We found that assert-pm demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Research
Security News
Socket researchers uncover a malicious npm package posing as a tool for detecting vulnerabilities in Etherium smart contracts.
Security News
Research
A supply chain attack on Rspack's npm packages injected cryptomining malware, potentially impacting thousands of developers.
Research
Security News
Socket researchers discovered a malware campaign on npm delivering the Skuld infostealer via typosquatted packages, exposing sensitive data.