https://github.com/weseek/eslint-config-weseek

Shareable configurations of ESLint by WESEEK, Inc. based on eslint-config-airbnb.
https://github.com/weseek/eslint-config-weseek

ecmascript eslint eslint-config eslint-config-airbnb javascript

Last synced: 8 days ago
JSON representation

Shareable configurations of ESLint by WESEEK, Inc. based on eslint-config-airbnb.

• Host: GitHub
• URL: https://github.com/weseek/eslint-config-weseek
• Owner: weseek
• License: mit
• Created: 2019-03-21T20:44:01.000Z (almost 6 years ago)
• Default Branch: master
• Last Pushed: 2023-04-12T18:58:48.000Z (almost 2 years ago)
• Last Synced: 2025-01-18T15:46:45.531Z (15 days ago)
• Topics: ecmascript, eslint, eslint-config, eslint-config-airbnb, javascript
• Language: JavaScript
• Homepage:
• Size: 55.7 KB
• Stars: 0
• Watchers: 8
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# eslint-config-weseek

[![npm version](https://badge.fury.io/js/eslint-config-weseek.svg)](http://badge.fury.io/js/eslint-config-weseek)

Shareable configurations of ESLint by WESEEK, Inc. based on [eslint-config-airbnb](https://github.com/airbnb/javascript/tree/master/packages/eslint-config-airbnb).

## Usage

### Basics

http://eslint.org/docs/user-guide/configuring#using-the-configuration-from-a-plugin

We export following ESLint configurations for your usage.

### Entry Points

* `weseek` - Our default ESLint rules based on [airbnb-base](https://github.com/airbnb/javascript/tree/master/packages/eslint-config-airbnb-base).

    * **Requirements**

        * `@babel/core`

        * `@babel/eslint-parser`

        * `eslint-plugin-import`

    * Usage:

        ```bash

        yarn add -D eslint-config-weseek @babel/core @babel/eslint-parser eslint-plugin-import

        ```

        ```

        extends: [

          'weseek',

        ],

        ```

* `weseek/react` - An additional rule sets which are based on [airbnb/rules/react](https://github.com/airbnb/javascript/blob/master/packages/eslint-config-airbnb/rules/react.js).

    * **Requirements**

        * Requirements list of `weseek` endpoint

        * `eslint-plugin-react`

        * `eslint-plugin-react-hooks`

    * Usage:

        ```bash

        yarn add -D eslint-config-weseek @babel/core @babel/eslint-parser eslint-plugin-import eslint-plugin-react eslint-plugin-react-hooks

        ```

        ```

        extends: [

          'weseek',

          'weseek/react',

        ],

        ```

* `weseek/typescript` - An additional rule sets for TypeScript.

    * **Requirements**:

        * Requirements list of `weseek` endpoint except for `@babel/core` and `@babel/eslint-parser`

        * `eslint-import-resolver-typescript`

        * `@typescript-eslint/eslint-plugin`

        * `@typescript-eslint/parser`

    * Usage:

        ```bash

        yarn add -D eslint-config-weseek eslint-plugin-import eslint-import-resolver-typescript @typescript-eslint/eslint-plugin @typescript-eslint/parser

        ```

        ```

        extends: [

          'weseek',

          'weseek/typescript',

        ],

        ```

* `weseek/typescript-next` - An additional rule sets for Next.js. This includes both of `weseek/react` and `weseek/typescript`

    * **Requirements**:

        * Requirements lists of `weseek`, `weseek/react` and `weseek/typescript` endpoint except for `@babel/core` and `@babel/eslint-parser`

    * Usage:

        ```bash

        yarn add -D eslint-config-weseek eslint-plugin-import eslint-plugin-react eslint-plugin-react-hooks eslint-import-resolver-typescript @typescript-eslint/eslint-plugin @typescript-eslint/parser

        ```

        ```

        extends: [

          'weseek',

          'weseek/typescript-next',

        ],

        ```