Eslint configurations for Node.js, Angular.js and React.js development


Keywords
eslint, eslint-plugin-react, eslint-plugin-angular, react, angular, javascript, rules, linting, linting-rules, nodejs, reactjs
License
MIT
Install
npm install eslint-config-suddi@5.0.2

Documentation

eslint-config-suddi

CircleCI codecov Codacy Badge npm npm David David license

codecov

npm install --save-dev eslint eslint-config-suddi

Rulesets

There are multiple rulesets provided:

Usage

  • Add ESLint config to your package.json, for running on backend code:
npm install --save-dev eslint eslint-config-suddi
{
    "scripts": {
        "lint": "eslint ."
    },
    "devDependencies": {
        "eslint": "^6.0.0",
        "eslint-config-suddi": "^5.0.0"
    },
    "eslintConfig": {
        "extends": "suddi/backend"
    }
}
  • Add ESLint config to your package.json, for running on React.js code:
npm install --save-dev eslint eslint-config-suddi eslint-plugin-react
{
    "scripts": {
        "lint": "eslint ."
    },
    "devDependencies": {
        "eslint": "^6.0.0",
        "eslint-config-suddi": "^5.0.0",
        "eslint-plugin-react": "^7.0.0"
    },
    "eslintConfig": {
        "extends": "suddi/react"
    }
}
  • Add ESLint config to your package.json, for running on Angular code:
npm install --save-dev eslint eslint-config-suddi eslint-plugin-angular
{
    "scripts": {
        "lint": "eslint ."
    },
    "devDependencies": {
        "eslint": "^6.0.0",
        "eslint-config-suddi": "^5.0.0",
        "eslint-plugin-angular": "^4.0.0"
    },
    "eslintConfig": {
        "extends": "suddi/angular"
    }
}
  • Then apply the linter with npm run lint.

Examples

For examples on use cases and validation samples, please see:

Setup for different editors

Sublime Text

  • Add the following to your ~/.bashrc or ~/.zshrc:
export NVM_DIR="$HOME/.nvm"

if [ -s $NVM_DIR/nvm.sh ]; then
    source $NVM_DIR/nvm.sh
fi
  • Install Package Control
  • Install SublimeLinter and SublimeLinter-contrib-eslint via Package Control
  • Run npm install -g eslint eslint-config-suddi eslint-plugin-react eslint-plugin-angular
  • Restart Sublime Text

Atom

  • Install linter and linter-eslint from within the available packages
  • Run npm install -g eslint eslint-config-suddi eslint-plugin-react eslint-plugin-angular
  • Restart Atom

Webstorm

  • Install ESLint
  • Run npm install -g eslint eslint-config-suddi eslint-plugin-react eslint-plugin-angular
  • Restart Webstorm

Visual Studio Code

  • Select Shell Command: Install ‘code’ command in PATH via Command Palette
  • Install ESLint package from within the available extensions
  • Run npm install -g eslint eslint-config-suddi eslint-plugin-react eslint-plugin-angular
  • Restart Visual Studio Code