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

require-lint

v2.0.3

Published

Verify that require statements match your package.json

Downloads

1,150

Readme

require-lint

NPM License

Build Status Dependencies Dev dependencies

Parses your code for require statements, and checks that:

  • all required dependencies are mentioned in package.json
  • all dependencies in package.json are still being used
$ npm install -g require-lint
$ require-lint

[require-lint] Missing dependencies: attempt, express
[require-lint] Extraneous dependencies: lodash

Any failed checks will trigger an exit code of 1, and you can choose to fail your build chain.

Note: require-lint doesn't check dev dependencies, since test code doesn't typically have a single entry point

Default behaviour

By default, it looks for a package.json in the current folder.

$ require-lint

It then parses your source from the entry points declared as main and bin:

{
  "main": "./lib/index.js",
  "bin": {
    "foo": "./bin/foo.js",
    "bar": "./bin/bar.js"
  }
}

Options

You can also specify the following options

  • --pkg

The path to your package.json.

$ require-lint --pkg ~/dev/thing/package.json
  • --src

The path to additional entry points. These must be relative to the given package.json. Globs can be used as paths.

$ require-lint --src lib/server.js --src lib/worker.js
  • --require

Any file to be required before processing, for example to load extra compilers like Coffee-Script. These must be absolute paths or available modules.

$ require-lint --require coffee-script/register
  • --ignore-missing

Modules that should not be considered missing, even if they are not declared in package.json. This is not recommended!

$ require-lint --ignore-missing newrelic
  • --ignore-extra

Modules that should not be considered extraneous, even if they are not required. For example you might have a dependency on coffee-script, but not explicitely require it.

$ require-lint --ignore-extra coffee-script

If you would like to use --ignore-extra with multiple dependencies, you can separate them using commas:

$ require-lint --ignore-extra coffee-script,bootstrap,ejs

Static configuration

All options above can also be saved in a .requirelintrc file at the root of your project. For example:

require=coffee-script/register
ignore-missing=newrelic

This makes it easier to check-in your configuration to source-control, although you could equally save your options in package.json, for example:

{
  "scripts": {
    "lint": "require-lint --require=coffee-script/register"
  }
}

Note that the .requirelintrc file can be located at any path supported by the rc package, such as ~/.requirelintrc or /etc/requirelintrc.

Dev notes

$ npm install
$ npm test

Other projects

Note: inspired by dependency-check. This implementation relies on Module._compile to add support Coffee-Script.