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

Linting rules for supermind projects
https://github.com/supermind/eslint-config-supermind

Last synced: about 2 months ago
JSON representation

Linting rules for supermind projects

• Host: GitHub
• URL: https://github.com/supermind/eslint-config-supermind
• Owner: supermind
• License: mit
• Created: 2016-10-24T15:59:22.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2021-08-11T03:55:38.000Z (almost 3 years ago)
• Last Synced: 2024-03-29T21:24:21.697Z (3 months ago)
• Language: JavaScript
• Size: 250 KB
• Stars: 4
• Watchers: 3
• Forks: 1
• Open Issues: 7
• Metadata Files:
  • Readme: readme.md
  • License: license

Lists

• awesome-eslint - Supermind - Shareable config for Supermind style. (Configs / Other Configs)
• awesome-stars - supermind/eslint-config-supermind - Linting rules for supermind projects (JavaScript)

README

        
# Supermind ESLint Config

Install [yarn](https://yarnpkg.com/) globally:

```bash

npm install yarn --global

```

Add `eslint` and `eslint-config-supermind` as a `devDependency` to your project:

```bash

yarn add eslint eslint-config-supermind --dev

```

Create an `.eslintrc.js` file at the root of your project and add the following configuration:

```js

module.exports = {

  root: true, // Prevent ESLint from inheriting configuration above this file

  extends: [

    'supermind',          // Extend base config

    'supermind/react',    // Extend react config (optional)

    'supermind/inferno',  // Extend inferno config (optional)

    'supermind/jsx-a11y', // Extend jsx-a11y config (optional)

    'supermind/flowtype'  // Extend flowtype config (optional)

  ]

}

```

Add a `lint` script in your project `package.json` file:

```json

{

  "name": "kitten-socks",

  "scripts": {

    "lint": "eslint source"

  }

}

```

To lint the `source` directory of your project run:

```bash

yarn run lint

```

## Development

To ensure that all available rules are specified throughout the config files run:

```bash

yarn run list-omitted-rules

```