diff --git a/README.md b/README.md index c4ab58c..09eca85 100644 --- a/README.md +++ b/README.md @@ -22,54 +22,106 @@ npm add --dev @vue/eslint-config-typescript @rushstack/eslint-patch ## Usage -This package comes with 2 rulesets. - -### `@vue/eslint-config-typescript` - -This ruleset is the base configuration for Vue-TypeScript projects. -Besides setting the parser and plugin options, it also turns off several conflicting rules in the `eslint:recommended` ruleset. -So when used alongside other sharable configs, this config should be placed at the end of the `extends` array. +This plugin provides some predefined configs. You can use the following configs by adding them to extends. + +- `@vue/eslint-config-typescript`: Aliased to the `recommended` config below. +- `@vue/eslint-config-typescript/base`: Settings and rules to enable correct ESLint parsing for Vue-TypeScript projects. +- `@vue/eslint-config-typescript/eslint-recommended`: `base` + `eslint:recommended` + turns off several conflicting rules in the `eslint:recommended` ruleset. +- `@vue/eslint-config-typescript/recommended`: The recommended rules for Vue-TypeScript projects, extended from `plugin:@typescript-eslint/recommended`. +- Additional configs that can be used *alongside* the abovementioned configs: + - Additional recommended rules that require type information (does not support `no-unsafe-*` rules, though): + - `@vue/eslint-config-typescript/recommended-requiring-type-checking` + - Additional strict rules that can also catch bugs but are more opinionated than recommended rules (with experimental support for `no-unsafe-*` rules; note this config does not conform to semver, meaning breaking changes may be introduced during minor releases): + - `@vue/eslint-config-typescript/strict` + - Additional configs to allow `