JavaScript ESLint rules

JavaScript ESLint bundle with best practices and common use rules for writing more consistent code.

"semi": [ "error", "never" ] ... the horror

Other similar bundles: XO, eslint-config-airbnb, eslint-config-google, more

• Install
• Targets
  • Node.js
  • Node.js with Typescript
  • React
• Inside
• Example config
• Changelog

Install

npm install @asd14/eslint-config --save-dev

Targets

Run npm info "@asd14/eslint-config@latest" peerDependencies to get the base packages needed.

It should be something like:

"eslint": "^8.13.0",
"prettier": "^2.6.0"

Add these packages to your devDependencies in package.json.

Node.js

Link ESLint to node target.

// .eslintrc
{
  "extends": [
    "@asd14/eslint-config/targets/node",
  ]
}

Node.js with Typescript

Link ESLint to node-ts target.

// .eslintrc
{
  "extends": [
    "@asd14/eslint-config/targets/node-ts",
  ]
}

React

Link ESLint to react target.

// .eslintrc
{
  "extends": [
    "@asd14/eslint-config/targets/react",
  ]
}

Inside

• eslint-plugin-jsdoc - JSDoc specific linting rules
• eslint-plugin-import - Support for ES2015+ (ES6+) import/export syntax
• eslint-plugin-promise - Enforce best practices for JavaScript promises
• eslint-plugin-unicorn - Various awesome ESLint rules
• eslint-plugin-html - Allows linting and fixing inline scripts contained in HTML files
• eslint-plugin-react - React specific linting rules
• eslint-plugin-react-hooks - Linting rules rules of React Hooks.
• eslint-plugin-no-inferred-method-name - In ES6, compact methods and unnamed function expression assignments within object literals do not create a lexical identification (name) binding that corresponds to the function name identifier for recursion or event binding. The compact method syntax will not be an appropriate option for these types of solutions, and a named function expression should be used instead. This custom ESLint rule will identify instances where a function name is being called and a lexical identifier is unavailable within a compact object literal.
• @typescript-eslint/parser - ESLint parser which leverages TypeScript ESTree to allow for ESLint to lint TypeScript source code.
• @typescript-eslint/eslint-plugin - ESLint plugin which provides lint rules for TypeScript codebases.

Example config

Using babel-eslint and eslint-import-resolver-webpack

.eslintrc

{
    "root"  : true,
    "parser": "babel-eslint",

    "extends": [ "@asd14/eslint-config/targets/react" ],

    "settings": {
        // Use webpack to resolve modules in imports
        "import/resolver": {
            "webpack": {
                "config": "./webpack.config.js",
            },
        },

        // Recommended if you use eslint_d
        "import/cache": {
            "lifetime": 5,
        },

        // List of regex strings that, if matched by a path, will not report
        // the matching module if no exports are found.
        "import/ignore": [ "\\.(sass|scss|less|css)$" ],
    },

    // Custom rules
    "rules": {
    },
}

.prettierrc

{
  "semi": false,
  "printWidth": 80,
  "tabWidth": 2,
  "useTabs": false,
  "singleQuote": false,
  "trailingComma": "es5",
  "bracketSpacing": true,
  "bracketSameLine": true,
  "arrowParens": "avoid"
}

Optional .editorconfig

root = true

[*]
charset = utf-8
indent_style = space
indent_size = 2
end_of_line = lf
trim_trailing_whitespace = true
insert_final_newline = true

[*.md]
trim_trailing_whitespace = false

Changelog

See the releases section for details.