https://github.com/xfiveco/eslint-config-chisel
https://github.com/xfiveco/eslint-config-chisel
Last synced: about 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/xfiveco/eslint-config-chisel
- Owner: xfiveco
- Created: 2017-10-06T09:05:49.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2020-04-21T20:18:10.000Z (about 6 years ago)
- Last Synced: 2025-02-17T07:16:03.983Z (over 1 year ago)
- Language: JavaScript
- Size: 107 KB
- Stars: 1
- Watchers: 8
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# eslint-config-chisel
[](https://greenkeeper.io/)
Eslint config based on [Aribnb config](https://github.com/airbnb/javascript) you can use with ES6. Integrates with [Prettier](https://github.com/prettier/prettier).
## Prettier
You'll have to install Prettier on your own in order to use it. It won't be included by default when you install this package. Don't hesitate to add your own `.prettierrc` file to [customise code formatting](https://github.com/prettier/prettier#configuration-file).
## Installation
We recommend to use Yarn however you are free to use NPM. Snippet from the example below will install Eslint and Prettier as you'll need both of them to make use of this config.
```
yarn add --dev eslint prettier eslint-config-chisel
```
## Usage
Add this to your `.eslintrc`:
```json
{
"extends": "chisel"
}
```
Note that the example above is in _JSON_. You may need to use YAML depending on your project setup:
```yml
extends: chisel
```