mongodb-js-precommit

mongodb-js-precommit

Standard linting, formatting and more for mongodb-js projects.

Usage

mongodb-js-precommit provides a shortcut to the following useful tools:

• dependency-check Makes sure you didn't forget to update your package.json with new dependencies or remove dependencies your module isn't using anymore.
• eslint Makes sure your code conforms to the syleguide for cases that aren't just simple formatting and are probably bugs.

Example

First, install pre-commit, which actually sets up the git pre-commit hook:

npm install --save-dev mongodb-js-precommit

Next, update your package.json to add a new check script:

  "scripts": {
    "check": "mongodb-js-precommit"
  }

To test that everything is working correctly, you can run:

npm run check

Now, sit back, relax and think about what you're going to do with your new found free time that would have been spent on code reviews.

Configuration

mongodb-js-precommit is easily configurable via your package.json.

dependency-check

• entries[] extra entry points for dependency-check
• ignore[] module names for dependency-check to ignore

  "dependency-check": {
    "entries": ["bin/mongodb-js-precommit.js"],
    "ignore": ["mongodb-js-precommit", "mocha"]
  }

precommit

This should just work no config required...

eslint

For more information, checkout eslint-config-mongodb-js.

Todo

• npm-check-updates Can we safely update dependency versions to latest safely?
• npm audit Are you using any modules with known security vulnerabilites?

License

Apache 2.0