https://github.com/cdrani/eslint-config-cdrainxv
eslint linter coupled with prettier formatter
https://github.com/cdrani/eslint-config-cdrainxv
config es6 eslint prettier
Last synced: about 2 months ago
JSON representation
eslint linter coupled with prettier formatter
- Host: GitHub
- URL: https://github.com/cdrani/eslint-config-cdrainxv
- Owner: cdrani
- Created: 2017-11-30T21:59:54.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2017-12-04T05:57:23.000Z (over 8 years ago)
- Last Synced: 2025-03-11T13:09:48.591Z (over 1 year ago)
- Topics: config, es6, eslint, prettier
- Language: JavaScript
- Size: 4.88 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# ESLINT-CONFIG-CDRAINXV
---
`eslint-config-cdrainxv` is a **very** opinionated eslint config (or will be as
it is incrementally updated it stricter rules). This config is coupled with
**prettier** for easy formatting.
# Usage
---
1. `npm i eslint-config-cdrainxv`
2. Add peer dependencies: `npm i eslint eslint-config-prettier
eslint-plugin-prettier prettier prettier-eslint prettier-eslint-cli -D`
3. Create `.eslintrc*` configuration file
4. Include `cdrainxv` as an extension:
**.eslintrc.js**
```js
module.exports = {
extends: ['cdrainxv']
}
```
---
**.eslintrc.json**
```json
{
"extends": ["cdrainxv"]
}
```
5. Add lint scripts to package.json:
```json
"scripts": {
"lint": "prettier-eslint .",
"eslint-check": "eslint --print-config .eslintrc.js | eslint-config-prettier-check"
}
```
6. Configure further with your own rules and/or plugins.
7. Check that your rules don't conflict with **Prettier**'s own rules:
`npm run eslint-check`
8. Run linter: `npm run lint`
---
## References:
[prettier/prettier](https://github.com/prettier/prettier#readme) |
[prettier/eslint-plugin-prettier](https://github.com/prettier/eslint-plugin-prettier#readme) |
[prettier/prettier-eslint](https://github.com/prettier/prettier-eslint#readme) |
[prettier/prettier-eslint-cli](https://github.com/prettier/prettier-eslint-cli#readme)
|
[prettier/eslint-config-prettier](https://github.com/prettier/eslint-config-prettier#readme) |
[eslint](https://eslint.org/docs/rules/)