4.1.0 • Published 5 years ago

eslint-config-node v4.1.0

Weekly downloads
29,499
License
ISC
Repository
github
Last release
5 years ago

Pluggable ESLint config for Node.js that you can import, extend and override

Join the chat at https://gitter.im/kunalgolani/eslint-config npm version npm downloads GitHub issues Deps Dev Deps

Node.js: Safety Checks and Best Practices with a bias toward code concision / brevity

Usage

In your js project directory:

npm install --save-dev eslint-config-node

And in your .eslintrc.yaml:

extends:
  - node

Alternatively, in your .eslintrc.js or .eslintrc.json:

{
  "extends": ["node"]
}

To add a git-hook to your commits, consider using husky

npm install --save-dev husky

And in your package.json:

  "scripts": {
    "precommit": "eslint ."
  }

Config

This config is biased and opinionated, and errs on the side of too many rules instead of too few. Think of this as a superset of your repo's lint config, and discard what you don't like in it. It's easy to override and disable the rules you find inconvenient.

env:
  node: true

enables Node.js features and global variables

extends: esnext

includes config and rules from eslint-config-esnext

rules:

selected from here, configured to:

  • no-path-concat: disallow string concatenation with __dirname and __filename
  • no-process-exit: disallow the use of process.exit()
  • no-sync: disallow synchronous methods; set to warn only

Node.js Style Guide