ComfyCase
Comfiest ESLint Settings!
ComfyCase prefers spaces between parentheses, camelCase syntax except for object properties, double quotes, Stroustrup style braces, and indentation with tabs.
Instructions
How to configure your project to use these ESLint settings.
TypeScript
To set up ESLint with this configuration in your TypeScript project, you can follow these steps:
- Install the necessary dev dependencies along with ComfyCase:
npm install --save-dev eslint @typescript-eslint/parser @typescript-eslint/eslint-plugin comfycase
- Create an
.eslintrc.json
file in the root of your project and define your configuration rules, extending from ComfyCase:
{
"env": {
"node": true,
"es6": true
},
"extends": [ "eslint:recommended", "comfycase" ],
"parser": "@typescript-eslint/parser",
"parserOptions": {
"ecmaVersion": 2018,
"sourceType": "module"
},
"plugins": ["@typescript-eslint", "node"],
"rules": {
}
}
- Add a script to your
package.json
file to run ESLint on your project:
{
"scripts": {
"lint": "eslint . --ext .js,.ts"
}
}
- You can then run the lint script with
npm run lint
or automatically fix them with npm run lint -- --fix
.
JavaScript
To setup ESLint with this configuration in your JavaScript project, you can follow these steps:
- Install the necessary dev dependencies:
npm install --save-dev eslint comfycase
- Create an
.eslintrc.json
file in the root of your project and define your configuration rules:
{
"env": {
"node": true,
"es6": true
},
"extends": [ "eslint:recommended", "comfycase" ],
"parserOptions": {
"ecmaVersion": 2018,
"sourceType": "module"
},
"rules": {
}
}
- Add a script to your
package.json
file to run ESLint on your project:
{
"scripts": {
"lint": "eslint . --ext .js"
}
}
- You can then run the lint script with
npm run lint
or automatically fix them with npm run lint -- --fix
.