From 7fe28d3d6e67861d48dbf42651d79c8a4fac62da Mon Sep 17 00:00:00 2001 From: Jacob Bowdoin <7559478+jacob-8@users.noreply.github.com> Date: Fri, 12 Apr 2024 09:19:00 +0800 Subject: [PATCH 1/4] docs: add clarification on stylistic overrides and Svelte overrides --- README.md | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) diff --git a/README.md b/README.md index f4a2934d0c..c9bf0b18db 100644 --- a/README.md +++ b/README.md @@ -175,6 +175,9 @@ export default antfu({ stylistic: { indent: 2, // 4, or 'tab' quotes: 'single', // or 'double' + overrides: { + 'style/brace-style': ['error', '1tbs', { allowSingleLine: true }], + }, }, // TypeScript and Vue are auto-detected, you can also explicitly enable them: @@ -457,6 +460,26 @@ export default antfu({ }) ``` +For more control over which rules apply to your Svelte files, you apply overrides like this: + +```js +// eslint.config.js +import { antfu, svelte, typescript } from '@antfu/eslint-config' + +export default antfu( + {}, + typescript({ + componentExts: ['svelte'], + }), + svelte({ + typescript: true, + overrides: { + 'svelte/no-dom-manipulating': 'error', + }, + }), +) +``` + Running `npx eslint` should prompt you to install the required dependencies, otherwise, you can install them manually: ```bash From 568e27f95b1710e12d00e5137de2d6ec301b8f64 Mon Sep 17 00:00:00 2001 From: Jacob Bowdoin <7559478+jacob-8@users.noreply.github.com> Date: Fri, 12 Apr 2024 20:33:58 +0800 Subject: [PATCH 2/4] docs: use config-composer instead of duplicating typescript --- README.md | 16 +++++++++------- 1 file changed, 9 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index c9bf0b18db..273219cc16 100644 --- a/README.md +++ b/README.md @@ -460,24 +460,26 @@ export default antfu({ }) ``` -For more control over which rules apply to your Svelte files, you apply overrides like this: +To control which rules apply to your Svelte files, you can apply overrides like this: ```js // eslint.config.js -import { antfu, svelte, typescript } from '@antfu/eslint-config' +import { antfu, svelte } from '@antfu/eslint-config' export default antfu( {}, - typescript({ - componentExts: ['svelte'], - }), svelte({ typescript: true, overrides: { - 'svelte/no-dom-manipulating': 'error', + 'svelte/no-dom-manipulating': 'error', // Svelte overrides here }, }), -) +).override('antfu/typescript/rules', { + files: ['**/*.svelte'], + rules: { + 'prefer-destructuring': 'error', // Typescript overrides here + }, +}) ``` Running `npx eslint` should prompt you to install the required dependencies, otherwise, you can install them manually: From 0cc8e8705326a5b87abb5ed074fd76d5901198b8 Mon Sep 17 00:00:00 2001 From: Jacob Bowdoin <7559478+jacob-8@users.noreply.github.com> Date: Fri, 12 Apr 2024 20:57:39 +0800 Subject: [PATCH 3/4] docs: override both svelte and ts properly --- README.md | 25 +++++++++++++------------ 1 file changed, 13 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index 273219cc16..3925e2ecc7 100644 --- a/README.md +++ b/README.md @@ -464,20 +464,21 @@ To control which rules apply to your Svelte files, you can apply overrides like ```js // eslint.config.js -import { antfu, svelte } from '@antfu/eslint-config' +import { antfu } from '@antfu/eslint-config' -export default antfu( - {}, - svelte({ - typescript: true, - overrides: { - 'svelte/no-dom-manipulating': 'error', // Svelte overrides here +export default antfu({ + svelte: true, +).overrides({ + 'antfu/svelte/rules': { + rules: { + 'svelte/no-dom-manipulating': 'error', + }, + }, + 'antfu/typescript/rules': { + files: ['**/*.svelte'], + rules: { + 'prefer-destructuring': 'error', }, - }), -).override('antfu/typescript/rules', { - files: ['**/*.svelte'], - rules: { - 'prefer-destructuring': 'error', // Typescript overrides here }, }) ``` From 6538dc563b4870f073ab4bcd3eb99407c9d536ff Mon Sep 17 00:00:00 2001 From: Jacob Bowdoin <7559478+jacob-8@users.noreply.github.com> Date: Fri, 12 Apr 2024 21:17:48 +0800 Subject: [PATCH 4/4] docs: fix typo --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 3925e2ecc7..61da2772a4 100644 --- a/README.md +++ b/README.md @@ -468,7 +468,7 @@ import { antfu } from '@antfu/eslint-config' export default antfu({ svelte: true, -).overrides({ +}).overrides({ 'antfu/svelte/rules': { rules: { 'svelte/no-dom-manipulating': 'error',