Socket
Socket
Sign inDemoInstall

eslint-config-mongodb-js

Package Overview
Dependencies
266
Maintainers
38
Versions
27
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

    eslint-config-mongodb-js

eslint sharable configs for mongodb-js.


Version published
Weekly downloads
4.7K
increased by9.75%
Maintainers
38
Install size
23.8 MB
Created
Weekly downloads
 

Readme

Source

eslint-config-mongodb-js travis npm

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/compass-plugin
  • mongodb-js/react
  • mongodb-js/node
  • mongodb-js/browser
  • mongodb-js/shell

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}.

Usage

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

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

NOTE You do not need to add multiple extends: [] in your .eslintrc! The inheritance of the mongodb-js/* configs inherits bottom up. For example, mongodb-js/compass-plugin already includes mongodb-js/react.

compass-plugin

If you're building a MongoDB Compass Plugin, your ./.eslintrc should be:

{"extends": "mongodb-js/compass-plugin"}

react

For react modules, your ./.eslintrc should be:

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

node

For vanilla node.js projects, your ./.eslintrc should be:

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

browser

If you're working on a UI project that uses browserify, your ./.eslintrc should be:

{"extends": "mongodb-js/browser"}
  • 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.

Changelog

5.0.0

  • Upgrade to eslint@5 #49

4.0.0

  • Adds mongodb-js/compass-plugin config #48

FAQ

My editor is now showing unexpected errors

Make sure your editor is using the correct version of eslint. If you're using Visual Studio Code, npm i -g eslint@latest will resolve this problem.

License

Apache 2.0

Keywords

FAQs

Last updated on 17 May 2019

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc