JavaScript EL Style - ESLint Shareable Config

This config extends and overites some of the ESlint:recommended & Standard via eslint-config-standard.

ESM style.

Install

npm install --save-dev eslint-config-el

Usage

Shareable configs are designed to work with the extends feature of .eslintrc files. You can learn more about Shareable Configs on the official ESLint website.

Then, add this to your .eslintrc file:

{
  "extends": "el"
}

or

{
  "root": true,
  "extends": "el"
}

"root": true

To limit ESLint to a specific project, place "root": true inside the .eslintrc.* file or eslintConfig field of the package.json file or in the .eslintrc.* file at your project's root level. ESLint stops looking in parent folders once it finds a configuration with "root": true .

Cascading and hierarchy in Configuration Files.

Important!

ESLint config's field "env": seted only "es2022" in true. And "es2021": true, "node": true in eslint-config-standard. In your project set your environments. All environment options. You can also refer to specifying parser options

Example:

{
  "root": true,
  "extends": "el",
  "env": {
    "browser": true,
    "node": false,
    "jest": true
  }
}

You can override settings from the shareable config by adding them directly into your .eslintrc file. All rules see.

Example:

{
  "root": true,
  "extends": "el",
  "rules": {
    "indent": [
      "error",
      4,
      {
        "SwitchCase": 0
      }
    ]
  }
}

NOTE: We omitted the eslint-config- prefix since it is automatically assumed by ESLint.

Now you can use the command line by writing npx eslint . - to show admonitions and npx eslint . --fix - to fix it. You can also add scripts to your package, e.g. (in your package.json, in the "script" section):

  "scripts": {
    "lint": "eslint . --ext js,mjs,cjs",
    "lint:fix": "eslint . --fix --ext js,mjs,cjs",
  }

And then at your command line, type npm run lint - to run the lint script command (just for guidance). And npm run lint:fix to fix your code.

NOTE: ("." - points to the project root, check everything in starting from the project root)

NOTE: the --ext js,mjs,cjs option tells eslint which extensions to check, in this example the three types js, mjs (ESM), cjs (CommunmJS)

NOTE: You may want your IDE to highlight the code according to the rules of the config, and if you are the owner of the VS Code, you will need an ESLint plugin for it. You may need just wait a bit or to restart the IDE.

Looking for something easier than this?

The easiest way to use JavaScript Standard Style to check your code is to use the standard package. This comes with a global Node command line program (standard) that you can run or add to your npm test script to quickly check your style.

Or another style something like this ESLint.

Author

EliotPu [email protected]

• GitHub