eslint-plugin-mongodb

eslint-plugin-mongodb

Eslint rules for MongoDB best practices.

Usage

1. Install eslint as a dev-dependency:

npm install --save-dev eslint

1. Install eslint-plugin-mongodb as a dev-dependency:

npm install --save-dev eslint-plugin-mongodb

1. Enable the plugin by adding it to your .eslintrc:

plugins:
  - mongodb

1. You can also configure these rules in your .eslintrc. All rules defined in this plugin have to be prefixed by 'mongodb/'

   plugins:
     - mongodb
   rules:
     - mongodb/no-replace: 0
   

Rules

no-replace

Default: 'no_replace': 1

Check update queries to ensure no raw replace is done.

check-numeric-updates

Default: 'check-numeric-updates': 2

Check update queries to ensure numeric operators like $mul and $inc contain numeric values.

check-rename-updates

Default: 'check-rename-updates': 2

Check ``$rename` update operator usage.

How to create a new rule

Avoid wasting your time and follow those steps to suggest a new rule:

• create and issue prefixed by [rule] and followed by it's name
• OR create the rule tests file in the src/lib/rules directory directly, create a branch whose name is the proposed rule name. Finally create a pull request.
• let's discuss about the feature and its implementation details.
• implement the feature.

Contributing

Feel free to push your code if you agree with publishing under the MIT license.

Stats