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.
• jsfmt Formats your code to the syleguide for you.
• 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 precommit hook:

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

Next, update your package.json to add a new check script and condifure pre-commit to run it:

  "scripts": {
    "check": "mongodb-js-precommit"
  },
  "precommmit": ["check"]

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

Checkout the pre-commit configuration docs for more details.

eslint

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

Todo

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

License

Apache 2.0