@anrom/eslint-config

Installation

Note: You may already have this configured by a scaffolder. Check the presence of .eslintrc.yaml in your directory and @anrom/eslint-config in package.json -> devDependencies

1. Install @anrom/eslint-config as a development dependency:

   npm i -D @anrom/eslint-config

2. Create an .eslintrc.yaml file in your project root with the following contents:

   extends:
     - '@anrom'

   If you're updating an old repository that has a production-level project, please also use "legacy" rules. In this case your .eslintrc.yaml file should have this content:

   extends:
     - '@anrom'
     - '@anrom/eslint-config/legacy'

Updating

Whenever an update is going to be released for this package - developers will be notified. To update the package to the latest version, run

npm i -D @anrom/eslint-config@latest

In case of any other breaking changes that will require you to make any additional steps - they will be mentioned in this section in the latest version of this manual. It will always have the following URL: https://www.npmjs.com/package/@anrom/eslint-config

IDE Settings

JetBrains IDEs (WebStorm, IntelliJ IDEA)

1. Open IDE settings (⌘+, in macOS or Ctrl+Alt+S in Windows/Linux)

2. Go to Languages & Frameworks > JavaScript > Code Quality Tools > ESLint or just type "esl" in search bar:

3. Select "Automatic ESLint configuration" and check the box "Run eslint --fix" on save":

4. Save the configuration.

5. To ensure that config was applied, go to any of your .js, .mjs or .jsx file in ./src folder, type in any code that causes ESLint error or warning and ensure it's highlighted. For example current configuration softly discourages developers from using plain console.log:

Visual Studio Code

1. Go to VS Marketplace and install ESLint extension by clicking "Install" button and then allowing the browser to open VS Code and clicking "Install" again on the extension's page

2. Restart VS Code

3. Open your settings.json file. The quickest way to open this file is to enter search (either F1 or ⌘+Shift+P / Ctrl+Shift+P) ane enter "user json" - you will see a suggestion "Preferences: Open User Settings (JSON)"

4. Add the following code to your Settings.json:

   "editor.codeActionsOnSave": {
     "source.fixAll.eslint": true
   }

5. To ensure that config was applied, go to any of your .js, .mjs or .jsx file in ./src folder, type in any code that causes ESLint error or warning and ensure it's highlighted. For example current configuration softly discourages developers from declaring unused variables: