https://github.com/gamtiq/eslint-config-guard

ESLint configuration files (shareable configs) to guard from problems in different areas of JavaScript development
https://github.com/gamtiq/eslint-config-guard

config configuration development es2015 es6 eslint eslint-config eslintconfig esnext guard javascript-development node nodejs optimum prevent protect react shareable-configs style validate

Last synced: about 2 months ago
JSON representation

ESLint configuration files (shareable configs) to guard from problems in different areas of JavaScript development

• Host: GitHub
• URL: https://github.com/gamtiq/eslint-config-guard
• Owner: gamtiq
• License: mit
• Created: 2016-11-13T13:35:26.000Z (about 8 years ago)
• Default Branch: master
• Last Pushed: 2022-11-02T14:52:58.000Z (about 2 years ago)
• Last Synced: 2024-10-07T10:56:42.126Z (3 months ago)
• Topics: config, configuration, development, es2015, es6, eslint, eslint-config, eslintconfig, esnext, guard, javascript-development, node, nodejs, optimum, prevent, protect, react, shareable-configs, style, validate
• Language: JavaScript
• Homepage:
• Size: 60.5 KB
• Stars: 2
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: History.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# eslint-config-guard

Set of configuration files ([shareable configs](https://eslint.org/docs/developer-guide/shareable-configs))

for [ESLint](https://eslint.org) to guard/protect from problems in different areas of JavaScript development.

Includes:

* `guard` - contains rules for possible errors, best practices, strict mode and variables; extends `eslint:recommended`;

* `guard/editor` - rules corresponding to editor preferences (like [`editorconfig`](https://editorconfig.org/))

    such as `eol-last`, `linebreak-style`, `no-trailing-spaces`;

* `guard/esnext` - configuration for ECMAScript 6/2015+ features;

* `guard/indent` - configuration of `indent` rule;

* `guard/jsdoc` - contains rules related to [JSDoc](https://jsdoc.app/);

* `guard/no-prettier` - adds `"prettier/prettier": "off"` to rules; can be helpful to use with [TSDX](https://github.com/jaredpalmer/tsdx);

* `guard/node` - configuration related to Node.js and CommonJS;

* `guard/proper-arrows` - configuration for stylistic rules related to arrow functions (see [`@getify/eslint-plugin-proper-arrows`](https://github.com/getify/eslint-plugin-proper-arrows));

* `guard/react` - configuration for React and JSX; extends [`plugin:react/recommended`](https://github.com/yannickcr/eslint-plugin-react);

* `guard/style` - rules for stylistic issues;

* `guard/test` - appropriate for use in tests (relaxes some rules from other configs);

* `guard/test-jest` - appropriate for use in [Jest](https://jestjs.io/) tests; extends `guard/test`;

* `guard/test-mocha` - appropriate for use in [Mocha](https://mochajs.org/) tests; extends `guard/test`;

The following files are combined configs which extend other configs:

* `guard/ext-style` - extends `guard/indent` and `guard/style`;

* `guard/optimum` - extends `guard` and `guard/ext-style`;

* `guard/optimum-next` - extends `guard/optimum` and `guard/esnext`.

See [eslint-config-ts-guard](https://github.com/gamtiq/eslint-config-ts-guard) for configuration files related to TypeScript.

## Installation

    npm install eslint-config-guard --save-dev

If you are going to use `guard/node` you should install [`eslint-plugin-node`](https://github.com/mysticatea/eslint-plugin-node):

    npm install eslint-plugin-node --save-dev

If you are going to use `guard/proper-arrows` you should install [`@getify/eslint-plugin-proper-arrows`](https://github.com/getify/eslint-plugin-proper-arrows):

    npm install @getify/eslint-plugin-proper-arrows --save-dev

If you are going to use `guard/react` you should install [`eslint-plugin-react`](https://github.com/yannickcr/eslint-plugin-react):

    npm install eslint-plugin-react --save-dev

## Usage

In a `.eslintrc.json` file:

```json

{

    "extends": [

        "guard",

        "guard/node"

    ]

}

```

In a `package.json`:

```json

{

    "eslintConfig": {

        "extends": [

            "guard/optimum-next",

            "guard/proper-arrows",

            "guard/react"

        ]

    }

}

```

## License

Copyright (c) 2016-2022 Denis Sikuler  

Licensed under the MIT license.