https://github.com/quic-pro/eslint-config

Shareable ESLint config.
https://github.com/quic-pro/eslint-config

config eslint eslintconfig styleguide

Last synced: 12 days ago
JSON representation

Shareable ESLint config.

• Host: GitHub
• URL: https://github.com/quic-pro/eslint-config
• Owner: quic-pro
• License: mit
• Created: 2023-01-12T09:17:57.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2023-01-17T09:27:16.000Z (almost 2 years ago)
• Last Synced: 2024-10-18T05:57:32.182Z (about 1 month ago)
• Topics: config, eslint, eslintconfig, styleguide
• Language: JavaScript
• Homepage: https://www.npmjs.com/package/@quic-pro/eslint-config
• Size: 98.6 KB
• Stars: 0
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# @quic-pro/eslint-config

Shareable ESLint config.

## Installation

```bash

# Using npm

npm install --save-dev @quic-pro/eslint-config

# Using yarn

yarn add --dev @quic-pro/eslint-config

```

> Required ESLint version >= 8

>

> [ESLint documentation](https://eslint.org/docs/latest/user-guide)

## Configs

Available configs:

- [default](https://github.com/quic-pro/eslint-config/blob/main/index.js) same as recommended

- [recommended](https://github.com/quic-pro/eslint-config/blob/main/recommended.js)

- [typescript](https://github.com/quic-pro/eslint-config/blob/main/typescript.js)

- [react](https://github.com/quic-pro/eslint-config/blob/main/react.js)

> Use the recommended config with other configs.

## Usage

### default

1) Add to your ESLint config:

   ```json

   {

     "extends": [

       "@quic-pro/eslint-config"

     ]

   }

   ```

   Or you can also omit the eslint-config and it will be automatically assumed by ESLint:

   ```json

   {

     "extends": [

       "@quic-pro"

     ]

   }

   ```

### recommended

1) Add to your ESLint config:

   ```json

   {

     "extends": [

       "@quic-pro/eslint-config/recommended"

     ]

   }

   ```

### typescript

1) Install required dependencies:

   ```bash

   #Using npm

   npm install --save-dev typescript @typescript-eslint/eslint-plugin @typescript-eslint/parser

   # Using yarn

   yarn add --dev typescript @typescript-eslint/eslint-plugin @typescript-eslint/parser

   ```

   > **Required versions:** 


   typescript >= 4 


   @typescript-eslint/eslint-plugin >= 5 


   @typescript-eslint/parser >= 5 


2) Add to your ESLint config:

   ```json

   {

     "parser": "@typescript-eslint/parser",

     "parserOptions": {

       "ecmaVersion": "latest",

       "sourceType": "module",

       "project": "./tsconfig.json"

     },

     "extends": [

       "@quic-pro/eslint-config/recommended",

       "@quic-pro/eslint-config/typescript"

     ]

   }

   ```

### react

1) Install required dependencies:

   ```bash

   # Using npm

   npm install --save-dev eslint-config-react-app eslint-plugin-jsx-a11y eslint-plugin-react eslint-plugin-react-hooks eslint-plugin-simple-import-sort

   # Using yarn

   yarn add --dev eslint-config-react-app eslint-plugin-jsx-a11y eslint-plugin-react eslint-plugin-react-hooks eslint-plugin-simple-import-sort

   ```

   > **Required versions:** 


   eslint-config-react-app >= 7 


   eslint-plugin-jsx-a11y >= 6 


   eslint-plugin-react >= 7 


   eslint-plugin-react-hooks >= 4 


   eslint-plugin-simple-import-sort >= 8 


2) Add to your ESLint config:

   ```json

   {

     "extends": [

       "@quic-pro/eslint-config/recommended",

       "@quic-pro/eslint-config/react"

     ]

   }

   ```

   > If you are using TypeScript with React then you can also add "@quic-pro/eslint-config/typescript". See instructions above.

## License

[MIT](LICENSE)