@leeruniek/eslint-config

JavaScript ESLint rules

Stats

StarsIssuesVersionUpdatedCreatedSize
@leeruniek/eslint-config
004.3.03 years ago4 years agoMinified + gzip package size for @leeruniek/eslint-config in KB

Readme

JavaScript ESLint rules

npm package version dev-badge peer-badge

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

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

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


Install

npm i eslint @leeruniek/eslint-config --save-dev

Run npm info "@leeruniek/eslint-config@latest" peerDependencies to get the packages needed in your own package.json.

It should be something like this:

...
"devDependencies": {
    "eslint": "5.13.0",
    "eslint-config-prettier": "4.0.0",
    "eslint-plugin-import": "2.16.0",
    "eslint-plugin-json": "1.3.2",
    "eslint-plugin-no-inferred-method-name": "1.0.2",
    "eslint-plugin-promise": "4.0.1",
    "eslint-plugin-prettier": "3.0.1",
    "eslint-plugin-unicorn": "7.1.0",
    "prettier": "1.16.4"
}
...

Use

Add the react or node target file in your .eslintrc file:

{
    "extends": [
        // use for Node.js projects
        "@leeruniek/eslint-config/targets/node",

        // use for React projects
        "@leeruniek/eslint-config/targets/react",

        // optional Flow support
        "@leeruniek/eslint-config/rules/flow",
    ]
}

When including "@leeruniek/eslint-config/rules/flow"

npm install --save-dev eslint-plugin-flowtype eslint-plugin-flowtype-errors

Inside

  • 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-flowtype - Flow specific linting rules
  • eslint-plugin-flowtype-errors - Runs your code through Flow and passes the type check errors as linting errors. Any editor that has ESLint support now supports Flow
  • eslint-plugin-html - Allows linting and fixing inline scripts contained in HTML files
  • eslint-plugin-react - React specific linting rules
  • 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.

Example config

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

.eslintrc

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

    "extends": [ "@leeruniek/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,
  "jsxBracketSameLine": true,
  "arrowParens": "avoid"
}

Changelog

History of all changes in CHANGELOG.md

4.3 - 4 February 2019

Remove

  • Disable react/display-name, react-prop-types when using flow

Change

  • Fix wrong value for flow/type-id-match
  • react/no-multi-comp to allow multiple stateless components in same file

If you find any bugs or have a feature request, please open an issue on github!

The npm package download data comes from npm's download counts api and package details come from npms.io.