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

✅ A set of eslint customizations that we use at Sparkbox.
https://github.com/sparkbox/eslint-config-sparkbox

Last synced: about 2 months ago
JSON representation

✅ A set of eslint customizations that we use at Sparkbox.

• Host: GitHub
• URL: https://github.com/sparkbox/eslint-config-sparkbox
• Owner: sparkbox
• License: mit
• Created: 2016-09-07T18:35:01.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2024-03-22T19:15:54.000Z (10 months ago)
• Last Synced: 2024-04-23T15:22:02.168Z (8 months ago)
• Language: JavaScript
• Homepage:
• Size: 768 KB
• Stars: 1
• Watchers: 19
• Forks: 0
• Open Issues: 14
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# `@sparkbox/eslint-config-sparkbox`

![current release](https://github.com/sparkbox/eslint-config-sparkbox/workflows/release/badge.svg)

A [sharable ESLint config] that we use at Sparkbox. This config extends the [Airbnb config] and includes rule support for:

* [React](https://github.com/yannickcr/eslint-plugin-react)

* [Flowtype](https://github.com/gajus/eslint-plugin-flowtype)

* [JSX a11y](https://github.com/evcohen/eslint-plugin-jsx-a11y)

* [ES6+ imports](https://github.com/benmosher/eslint-plugin-import)

## Usage

`npm install --save-dev @sparkbox/eslint-config-sparkbox`

or

`yarn add @sparkbox/eslint-config-sparkbox --dev`

Use [extends syntax] in your `.eslintrc` file:

```json

{

  "extends": ["@sparkbox/eslint-config-sparkbox"]

}

```

### Install necessary plugins

`npm i -D eslint eslint-config-airbnb eslint-plugin-jsx-a11y eslint-plugin-react eslint-plugin-import eslint-plugin-flowtype babel-eslint`

_Note:_ Depending on your editor setup you may need [eslint-cli](https://github.com/eslint/eslint-cli) installed globally via `npm i eslint-cli -g`.

[sharable ESLint config]: http://eslint.org/docs/developer-guide/shareable-configs

[extends syntax]: http://eslint.org/docs/developer-guide/shareable-configs#using-a-shareable-config

[Airbnb config]: https://github.com/airbnb/javascript