npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

engine-check

v1.0.1

Published

Enforce node engine version from package.json

Downloads

10,313

Readme

Node engine check

This is a drop-in module to enforce the node engine version specified in your project's package.json.

Usage

Add an "engines" section to your package.json, if you don't have it already.

{
  "name": "my-app",
  ...
  "engines": {
    "node": ">=4.0"
  }
}

Add this to the entry point of your node app:

// index.js
require('engine-check')()
console.log('Hello node >=4.0!')

And then run your app with the correct version of node:

bash$ node -v
v4.3.1

bash$ node index.js
Hello node >=4.0!

bash$ echo $?
0

Or with an outdated one:

bash$ node -v
v0.12.10

bash$ node index.js
Detected node version: 0.12.10. Required node version: >=4.0.

bash$ echo $?
1

Note: the warning is sent to STDERR. If you'd rather not have any output, you can set the silent option:

// index.js
require('engine-check')({ silent: true })
console.log('Hello node >=4.0!')
bash$ node -v
v0.12.10

bash$ node index.js

bash$ echo $?
1

Available options

  • silent (default: false)
    • when true, completely disables all STDERR output
  • debug (default: false)
    • when true, STDERR output becomes more verbose
  • searchRoot (default: the dirname of the main module)
    • where to start searching for the project's package.json
    • use with caution

Caveats

Currently only the "node" engine is checked.

License

Copyright (c) 2016, Peter-Paul van Gemerden. Distributed under the ISC license (see the LICENSE file).