@empathyco/eslint-config
v1.3.3
Published
ESLint and Prettier config preset
Downloads
849
Readme
@empathyco/eslint-config
- ESLint as code linter sharing configuration preset.
- Prettier as code formatter sharing configuration preset.
- @antfu/eslint-config as default ESLint config preset.
- @eslint/config-inspector the visual tool for inspecting and understanding your ESLint flat configs.
[!NOTE] The ESLint and Prettier dependencies are referenced in the package itself, so there is no needed to install them in your project.
Usage
Install
npm i -D @empathyco/eslint-config
ESLint config
Create eslint.config.mjs
in your project root:
// eslint.config.mjs
import { empathyco } from '@empathyco/eslint-config'
export default empathyco()
Prettier config
Reference shared config file into package.json
:
{
"prettier": "@empathyco/eslint-config/prettier"
}
Add scripts for package.json
This is a script set that you can add to your repository:
{
"scripts": {
"lint": "eslint --fix .",
"lint:check": "eslint .",
"lint:inspect": "eslint --inspect-config .",
"format": "prettier --write .",
"format:check": "prettier --check ."
}
}
Customization
Configure the initial preset with the same parameters as expose @antfu/eslint-config
Example:
import { empathyco } from '@empathyco/eslint-config'
export default empathyco(
// Configures for empathyco's (antfu) config.
{},
// From the second arguments they are ESLint Flat Configs.
// You can have multiple configs.
{
rules: {
'vue/custom-event-name-casing': 'off',
},
},
{
files: ['**/*.spec.{ts,tsx,js,jsx}'],
rules: {
'jsdoc/check-param-names': 'off',
},
},
)