eslint-config-get-off-my-lawn

eslint-config-get-off-my-lawn

A highly opinionated, sharable config of ESLint rules to produce beautiful, readable JavaScript.

As developers, we spend more time reading code than writing it. These rules aim to make reading JavaScript a priority.

That means some rules will feel oppressive or "over the top" for many developers, which is fine. If you don't like it, you can get off my lawn! ... Or extend the rules and override them with the ones that bother you. Either way.

This config also comes with the following plugins, and corresponding rules, baked in.

• babel-eslint
• eslint
• eslint-plugin-eslint-comments
• eslint-plugin-get-off-my-lawn
• eslint-plugin-import
• eslint-plugin-jest
• eslint-plugin-json
• eslint-plugin-jsx-a11y
• eslint-plugin-node
• eslint-plugin-objects
• eslint-plugin-prefer-object-spread
• eslint-plugin-react
• eslint-plugin-security
• eslint-plugin-unicorn

Each and every single rule has been meticulously poured over and purposefully hand picked or excluded.

Install

$ yarn add eslint eslint-config-get-off-my-lawn --dev

Usage

Create an ESLint config in your package.json or .eslintrc.js file.

package.json

{
    "name": "my-awesome-project",
    "eslintConfig": {
        "extends": "get-off-my-lawn"
    }
}

.eslintrc.js

module.exports = {
    extends: 'get-off-my-lawn'
};

Related

• stylelint-config-get-off-my-lawn - A highly opinionated, sharable config of stylelint rules to produce beautiful, readable CSS and Sass.

License

MIT © Michael Novotny