Eslint config used in atom-ide-community


Keywords
eslint, config, atomic, plugin, lint, prettier
License
MIT
Install
npm install eslint-config-atomic@1.5.1

Documentation

eslint-config-atomic

This includes the Eslint configuration used in atom-ide-community.

Installation

npm install --save-dev eslint-config-atomic

You should also install the peer dependencies:

npm install -save-dev "eslint"

Usage

Create a .eslintrc.json file at the root of the project with the following content:

{
  "extends": "eslint-config-atomic",
  "ignorePatterns": ["dist/", "node_modules/"]
}

ignorePatterns is the Eslint ignore paths.

Add a lint script to your package.json:

"lint": "eslint . --fix"

Options

  • strict: You can instead use the strict version which throws errors instead of warning:
{
  "extends": "eslint-config-atomic/strict",
  "ignorePatterns": ["dist/", "node_modules/"]
}
  • react: It supports react using eslint-plugin-react.
{
  "extends": "eslint-config-atomic/react",
  "ignorePatterns": ["dist/", "node_modules/"]
}
  • strict-react: Same as the react version but it is strict:
{
  "extends": "eslint-config-atomic/strict-react",
  "ignorePatterns": ["dist/", "node_modules/"]
}

Behind the scenes

This configuration lints JavaScript, TypeScript, CoffeeScript, JSON, and YAML.