@open-sauced/check-engines

Never break your dependency tree with npm-install-checks running on npx.

📦 Install

This package is binary and doesn't require installation however you can add it to your repository as a devDependency:

npm install --save-dev @open-sauced/check-engines

🚀 Usage

All you have to do is run the script next to your package.json:

npx @open-sauced/check-engines

🔧 Configuration

The most common use case for this package is to let it run on install and start generic npm scripts:

{
  "scripts": {
    "preinstall": "npx @open-sauced/check-engines",
    "prestart": "npx @open-sauced/check-engines"
  }
}

Or with less copy paste:

{
  "scripts": {
    "engines": "npx @open-sauced/check-engines",
    "preinstall": "npm run engines",
    "prestart": "npm run engines"
  }
}

🤝 Contributing

We encourage you to contribute to Open Sauced! Please check out the Contributing guide for guidelines about how to proceed.

If you decide to fix a bug, make sure to use the conventional commit available at:

npm run push

🍕 Community

Got Questions? Join the conversation in our Discord.
Find Open Sauced videos and release overviews on our YouTube Channel.

⚖️ LICENSE

MIT © Open Sauced