eslint-config-mongodb-js

eslint-config-mongodb-js

eslint shareable configs for mongodb-js.

Usage

Shareable configs are designed to work with the extends feature of .eslintrc files. This allows us to easily extend from a base configuration to provide the right rules for all of the extensive range of environments we build modules for:

• mongodb-js
• mongodb-js/node
• mongodb-js/browser
• mongodb-js/shell
• mongodb-js/react

You can learn more about Shareable Configs on the official ESLint website.

Conventions

Our eslint-config is based on eslint-config-airbnb. We make a best effort to explicitly call out any rules we differ from eslint-config-airbnb will include a JSDoc comment of @differ #{dang good reason}.

Examples

To use the mongodb-js shareable config, first run:

npm install --save-dev eslint-config-mongodb-js

The barebones mongodb-js ./.eslintrc file looks like:

{
  "extends": "mongodb-js"
}

If your project runs primarily on the server, your ./.eslintrc might look something like:

{
  "extends": "mongodb-js/node"
}

If you're working on a UI project that uses browserify:

{
  "extends": "mongodb-js/browser"
}

See Also

• mongodb-js-fmt Look no further if you're not a tailor and/or want something that will just magically reformat your code to conform to these best practices.
• mongodb-js-precommit The first line of defense to fighting bugs is not letting bad code into your project in the first place.
• eslint-plugin-mongodb Syntax guidance and best practices reinforcement when using MongoDB node.js driver.

License

Apache 2.0