@kmhgmbh/eslint-config
v2.2.0
Published
A composite [ESLint](https://eslint.org/) configuration for usage across different project types.
Downloads
1,262
Readme
@kmhgmbh/eslint-config
A composite ESLint configuration for usage across different project types.
Rules composition
The main rule set is a modified airbnb-base
.
Based on that, this package includes extended rule sets:
@kmhgmbh/eslint-config/jest
adds jest-specific rules@kmhgmbh/eslint-config/typescript
adds TypeScript-specific rules@kmhgmbh/eslint-config/cdk
combines TypeScript and Jest rules with AWS CDK-specific rules@kmhgmbh/eslint-config/vue2
adds Vue 2 rule recommendations@kmhgmbh/eslint-config/vue3
combines TypeScrpt rules with Vue 3 rule recommendations
Using this package in your project
Installation
Install this package as a devDependency. ESLint will be provided.
nvm use # skip this step if you configure your Node version manually
npm install -D @kmhgmbh/eslint-config
Usage
You need a minimal eslint configuration in your project that extends one of the rule sets in this package.
The easiest way is to put it in your package.json
:
"eslintConfig": {
"extends": "@kmhgmbh/eslint-config"
}
You can, of course, use a separate .eslintrc
…
{
"extends": "@kmhgmbh/eslint-config"
}
… or .eslintrc.js
:
module.exports = {
extends: '@kmhgmbh/eslint-config',
};
You probably also need an npm script in your package.json tu run eslint, e.g.:
"scripts": {
"lint": "eslint --ext .ts,.js,.vue src test"
}
Which would run eslint on all files ending in .js
, .ts
or .vue
found in src/
and test/
.
Peer Dependencies
This package defines a set of optional peer dependencies that are required depending on which rule sets are used in the target project.
@kmhgmbh/eslint-config/jest
requireseslint-plugin-jest
@kmhgmbh/eslint-config/typescript
needs@typescript-eslint/eslint-plugin
and@typescript-eslint/parser
@kmhgmbh/eslint-config/cdk
needs@typescript-eslint/eslint-plugin
and@typescript-eslint/parser
@kmhgmbh/eslint-config/vue2
needseslint-plugin-vue
@kmhgmbh/eslint-config/vue3
needs@typescript-eslint/eslint-plugin
,@typescript-eslint/parser
and@vue/eslint-config-typescript
You only need to install peer dependencies for the rule sets you're using.