eslint-config-un 1.0.0-alpha.33 → 1.0.0-alpha.35
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +223 -174
- package/dist/{angular-DnFTQdqp.js → angular-F9qCcdE6.js} +3 -4
- package/dist/{astro-BSgwgV-Q.js → astro-DPnrzOVN.js} +4 -5
- package/dist/{ava-67I2zuRu.js → ava-CihB8DYD.js} +2 -2
- package/dist/{better-tailwind-Bkh1vMsh.js → better-tailwind-PsrIXgUc.js} +2 -3
- package/dist/{case-police-CVQjHOLM.js → case-police-DBT8awLe.js} +2 -2
- package/dist/{cli-DEtqi6Qx.js → cli-CU4wgrRj.js} +1 -1
- package/dist/cloudfront-functions-B2o5fL8_.js +154 -0
- package/dist/{compat-CdMLgbTn.js → compat-BPnfGT48.js} +1 -1
- package/dist/{cspell-BZOOFXmH.js → cspell-pFfV93fu.js} +1 -1
- package/dist/{css-CZ5U0i4d.js → css-CKMDDy5s.js} +8 -4
- package/dist/{css-in-js-Be2lbwZ0.js → css-in-js-CyEZ34tK.js} +1 -1
- package/dist/{cypress-BLInl92c.js → cypress-CjP0WKWr.js} +2 -2
- package/dist/{de-morgan-DShHlhC_.js → de-morgan-CKBoTMpb.js} +1 -1
- package/dist/{depend-W4mOQR7m.js → depend-C-v-CYaG.js} +2 -2
- package/dist/{ember-q6d78erg.js → ember-Bl0U777e.js} +2 -2
- package/dist/{erasable-syntax-only-ssIYbcJp.js → erasable-syntax-only-Dt4-vhGT.js} +1 -1
- package/dist/{es-BS-n7Ulm.js → es-45sHkVBF.js} +3 -4
- package/dist/es-CEJeBVF9.js +4 -0
- package/dist/{eslint-DQBkZ85F.js → eslint-DU9unf8c.js} +170 -170
- package/dist/{eslint-comments-CFpcAiMc.js → eslint-comments-DMzcVQWQ.js} +1 -1
- package/dist/{eslint-plugin-CE0h9NsO.js → eslint-plugin-Bt8UbEtK.js} +2 -2
- package/dist/{file-progress-Cs6g8eds.js → file-progress-CEnCo_6b.js} +1 -1
- package/dist/{graphql-ULWtiCi7.js → graphql-DBBwghIJ.js} +1 -1
- package/dist/{header-CWQNOtaS.js → header-NIt1ougJ.js} +1 -1
- package/dist/{headers-BFts5D9t.js → headers-CUL17zcJ.js} +1 -1
- package/dist/html-BbaOxlKS.js +32 -0
- package/dist/{import-BfUrz6LT.js → import-CVP6YeuG.js} +1 -1
- package/dist/{import-zod-CEvf-S96.js → import-zod-CJfSrBUW.js} +1 -1
- package/dist/index.d.ts +3701 -1586
- package/dist/index.js +183 -157
- package/dist/{jest-xzczH8dF.js → jest-jtYAD-xv.js} +2 -2
- package/dist/{js-CDcqmhNC.js → js--SRE4zHf.js} +2 -2
- package/dist/{js-inline-BXn0ZfBD.js → js-inline-nyoBn81D.js} +1 -1
- package/dist/jsdoc-8JoK0OZb.js +38 -0
- package/dist/{json-schema-validator-BYrpc1LL.js → json-schema-validator-CQMfYKV3.js} +2 -2
- package/dist/{jsonc-DzZBje0R.js → jsonc-CnOutz13.js} +2 -2
- package/dist/{jsx-a11y-aHVD5-ue.js → jsx-a11y-DKjGy3y7.js} +2 -2
- package/dist/{lit-g7d2eKs8.js → lit-DuYwn3mg.js} +4 -5
- package/dist/markdown-links-CjFkT3bs.js +29 -0
- package/dist/{markdown-Dq0Hi2Rh.js → markdown-mt53Akfy.js} +21 -8
- package/dist/markdown-preferences-Bq_sYKqc.js +40 -0
- package/dist/{math-CBrIU5ol.js → math-XU9L2xy1.js} +1 -1
- package/dist/{mdx-BXa4OCtS.js → mdx-qOS4tys4.js} +2 -2
- package/dist/{mocha-Djz5YK2i.js → mocha-YyCysTsc.js} +2 -2
- package/dist/{nextjs-CYXq8TPr.js → nextjs-CKN-3aSa.js} +1 -1
- package/dist/{no-only-tests-C2goW3FS.js → no-only-tests-Cs5JBHdn.js} +2 -2
- package/dist/{no-stylistic-rules-DLFQRllY.js → no-stylistic-rules-pxEm51NX.js} +221 -51
- package/dist/{no-unsanitized-B4yWvSQZ.js → no-unsanitized-5-mvr9t1.js} +1 -1
- package/dist/{node-Ozn_sNTR.js → node-CmoUjkf9.js} +1 -1
- package/dist/{node-dependencies-79ozAC-J.js → node-dependencies-D327bBPP.js} +2 -2
- package/dist/{nx-AH8D3I7Q.js → nx-BjZgWizy.js} +1 -1
- package/dist/package-json-BDPup-gO.js +4 -0
- package/dist/{package-json-yEPmMVDB.js → package-json-BwLYvh-p.js} +2 -2
- package/dist/{perfectionist-dFtppyHZ.js → perfectionist-7D1yVEbI.js} +1 -1
- package/dist/{playwright-XmZ6ZmKw.js → playwright-B63MITGP.js} +2 -2
- package/dist/{plugin-un-wQrzLNzA.js → plugin-un-DvQbZcjO.js} +8 -9
- package/dist/{pnpm-CYKgwNaj.js → pnpm-B9MeteGw.js} +3 -4
- package/dist/{prefer-arrow-functions-Iew1I-rc.js → prefer-arrow-functions-XertZAOp.js} +1 -1
- package/dist/{promise-PTXJk6Nw.js → promise-BO3r6jkF.js} +1 -1
- package/dist/{qunit-ChWAIMHJ.js → qunit-DEhBUzcS.js} +2 -2
- package/dist/{qwik-8Umug5Rj.js → qwik-CtWR26TJ.js} +1 -1
- package/dist/{react-BXrh2H7o.js → react-BOA7brNH.js} +18 -22
- package/dist/{regexp-4dNbIXgN.js → regexp-C30Zi6a5.js} +1 -1
- package/dist/{rxjs-Zo313x8x.js → rxjs-CVysg8U6.js} +1 -1
- package/dist/{security-CMlTXy09.js → security-BMIEYBMC.js} +1 -1
- package/dist/{shared-dQgYTR3w.js → shared-BfrbDA8Y.js} +1 -1
- package/dist/{solid-C9Gsfush.js → solid-BwMs5eaV.js} +2 -3
- package/dist/{sonar-BBaYN45x.js → sonar-Bm2DxVM2.js} +2 -2
- package/dist/{storybook-prrfpYns.js → storybook-yK0-ByMh.js} +1 -1
- package/dist/{svelte-9DDgOgeu.js → svelte-CrqiaAkD.js} +3 -3
- package/dist/{tailwind-7fvLSG1h.js → tailwind-BMDrsHhX.js} +1 -1
- package/dist/{tanstack-query-Com60ZBs.js → tanstack-query-B97bNKC9.js} +1 -1
- package/dist/{testing-library-B5WpVxhE.js → testing-library-CRj7Vgqc.js} +3 -4
- package/dist/{toml-C0hPVmvw.js → toml-DCHHfyMy.js} +2 -2
- package/dist/{ts-BLLUo0PC.js → ts-CQr76DmP.js} +14 -9
- package/dist/{turbo-D_qGXuTt.js → turbo-BIjLCxmX.js} +1 -1
- package/dist/{un--1xmTs0I.js → un-ChTZuXYR.js} +1 -1
- package/dist/unicorn-RPPnNCYD.js +25 -0
- package/dist/{unnecessary-abstractions-DCP5Ix8k.js → unnecessary-abstractions-DLcQd0b1.js} +1 -1
- package/dist/{unocss-N7r8dn3u.js → unocss-ktKlZ2K1.js} +1 -1
- package/dist/{unused-imports-CxzDEbf3.js → unused-imports-DEOwHRMo.js} +2 -3
- package/dist/vitest-CM6y5t89.js +42 -0
- package/dist/{vue-eSShA_ZZ.js → vue-DEiN_gjl.js} +11 -11
- package/dist/{web-components-DRiCwPMp.js → web-components-Cw4XPg2i.js} +1 -1
- package/dist/{yaml-DeT71SOj.js → yaml-DsAUnhnh.js} +2 -2
- package/dist/{you-dont-need-lodash-underscore-BkQmP7Wf.js → you-dont-need-lodash-underscore-DYXgGTQ3.js} +1 -1
- package/package.json +126 -120
- package/dist/cloudfront-functions-DDwo3Ggr.js +0 -155
- package/dist/es-5NBzX6ko.js +0 -4
- package/dist/html-CoWgaUh_.js +0 -28
- package/dist/jsdoc-Dz-QdvqT.js +0 -36
- package/dist/package-json-BqReGsbO.js +0 -4
- package/dist/unicorn-C9l5U2kN.js +0 -25
- package/dist/vitest-NOa4e-ED.js +0 -41
package/README.md
CHANGED
|
@@ -5,19 +5,19 @@ Grown out of the personal collection of rules, an ESLint config aspiring to cove
|
|
|
5
5
|
## Features
|
|
6
6
|
|
|
7
7
|
- **Every major plugin** is included (50+ in total):
|
|
8
|
-
[ Vanilla JS rules](https://eslint.org/docs/latest/rules),
|
|
9
|
-
[![TypeScript]
|
|
10
|
-
[🦄unicorn](https://npmjs.com/eslint-plugin-unicorn),
|
|
11
|
-
[⭐regexp](https://github.com/ota-meshi/eslint-plugin-regexp),
|
|
12
|
-
[ node](https://github.com/eslint-community/eslint-plugin-n),
|
|
13
|
-
[![VueJS]
|
|
14
|
-
[![Angular]
|
|
15
|
-
[![ReactJS]
|
|
16
|
-
[ solid](https://github.com/solidjs-community/eslint-plugin-solid),
|
|
17
|
-
[![tailwindcss]
|
|
18
|
-
[![CSS]
|
|
19
|
-
[ yaml](https://github.com/ota-meshi/eslint-plugin-yml)
|
|
20
|
-
and many more;
|
|
8
|
+
[ Vanilla JS rules](https://eslint.org/docs/latest/rules),
|
|
9
|
+
[![TypeScript] typescript-eslint](https://typescript-eslint.io/rules),
|
|
10
|
+
[🦄unicorn](https://npmjs.com/eslint-plugin-unicorn),
|
|
11
|
+
[⭐regexp](https://github.com/ota-meshi/eslint-plugin-regexp),
|
|
12
|
+
[ node](https://github.com/eslint-community/eslint-plugin-n),
|
|
13
|
+
[![VueJS] vue](https://eslint.vuejs.org),
|
|
14
|
+
[![Angular] angular](https://github.com/angular-eslint/angular-eslint)
|
|
15
|
+
[![ReactJS] react](https://github.com/jsx-eslint/eslint-plugin-react) and 4 sister plugins,
|
|
16
|
+
[ solid](https://github.com/solidjs-community/eslint-plugin-solid),
|
|
17
|
+
[![tailwindcss][TailwindCSS] tailwind](https://github.com/francoismassart/eslint-plugin-tailwindcss),
|
|
18
|
+
[![CSS] css](https://github.com/eslint/css),
|
|
19
|
+
[ yaml](https://github.com/ota-meshi/eslint-plugin-yml)
|
|
20
|
+
and many more;
|
|
21
21
|
- **Every single rule** was evaluated and given a reasonable default severity and options;
|
|
22
22
|
- **Extremely configurable:** you can easily override any rule's severity and **granularly** alter the default options;
|
|
23
23
|
- **Zero configuration by default:** exporting `eslintConfig()` from `eslint.config.ts` is enough to get started;
|
|
@@ -31,10 +31,11 @@ and many more;
|
|
|
31
31
|
## Installation
|
|
32
32
|
|
|
33
33
|
Minimum supported versions:
|
|
34
|
-
|
|
34
|
+
|
|
35
|
+
- NodeJS: ^20.19 or ^22.16.0 or >=24
|
|
35
36
|
- ESLint: ^9.15.0 (peer dependency)
|
|
36
37
|
|
|
37
|
-
```
|
|
38
|
+
```sh
|
|
38
39
|
npm i -D eslint-config-un eslint@latest
|
|
39
40
|
pnpm i -D eslint-config-un eslint@latest
|
|
40
41
|
yarn add -D eslint-config-un eslint@latest # Yarn Berry only (v2+)
|
|
@@ -49,9 +50,10 @@ Certain plugins (usually framework/library specific ones) are optional peer depe
|
|
|
49
50
|
|
|
50
51
|
Yarn Classic (v1) does not support installing packages by npm name that have dependencies referenced by `file:` protocol - which we're using in this package. It fails with "Tarball is not in network and can not be located in cache" error. Installing directly from the tarball do work:
|
|
51
52
|
|
|
52
|
-
```
|
|
53
|
+
```sh
|
|
53
54
|
yarn add -D https://registry.npmjs.org/eslint-config-un/-/eslint-config-un-<VERSION>.tgz eslint@latest
|
|
54
55
|
```
|
|
56
|
+
|
|
55
57
|
</details>
|
|
56
58
|
|
|
57
59
|
<details>
|
|
@@ -87,7 +89,6 @@ yarn add -D https://registry.npmjs.org/eslint-config-un/-/eslint-config-un-<VERS
|
|
|
87
89
|
| `prefer-arrow-functions` | `eslint-plugin-prefer-arrow-functions` |
|
|
88
90
|
| `qunit` | `eslint-plugin-qunit` |
|
|
89
91
|
| `qwik` | `eslint-plugin-qwik` |
|
|
90
|
-
| `react-compiler` | `eslint-plugin-react-compiler` |
|
|
91
92
|
| `react-hooks` | `eslint-plugin-react-hooks` |
|
|
92
93
|
| `react-refresh` | `eslint-plugin-react-refresh` |
|
|
93
94
|
| `react` | `eslint-plugin-react` |
|
|
@@ -102,6 +103,7 @@ yarn add -D https://registry.npmjs.org/eslint-config-un/-/eslint-config-un-<VERS
|
|
|
102
103
|
| `vue` | `eslint-plugin-vue` |
|
|
103
104
|
| `vue-scoped-css` | `eslint-plugin-vue-scoped-css` |
|
|
104
105
|
| `vuejs-accessibility` | `eslint-plugin-vuejs-accessibility` |
|
|
106
|
+
|
|
105
107
|
</details>
|
|
106
108
|
|
|
107
109
|
### Usage
|
|
@@ -116,7 +118,6 @@ export default eslintConfig({
|
|
|
116
118
|
});
|
|
117
119
|
```
|
|
118
120
|
|
|
119
|
-
<!-- eslint-disable-next-line markdown/no-missing-label-refs -->
|
|
120
121
|
> [!NOTE]
|
|
121
122
|
> We highly recommend using TypeScript config file, which is supported since ESLint v9.18.0, or [`@ts-check` directive](https://www.typescriptlang.org/docs/handbook/intro-to-js-ts.html#ts-check) at the start of the file otherwise.
|
|
122
123
|
|
|
@@ -163,11 +164,12 @@ type Severity = 0 | 1 | 2 | 'off' | 'warn' | 'error';
|
|
|
163
164
|
- Sub-configs are the same as Configs, but configured within Config options. All Sub-configs use `configXXX` naming convention.
|
|
164
165
|
- After evaluating all the flat configs, eslint-config-un will **load only those plugins that were actually used**, unless `loadPluginsOnDemand` option is set to `false`.
|
|
165
166
|
- `files` is an array of file globs to which this Config will be applied. If you specify an empty array `[]`, the Config **will be disabled**, but not its Sub-configs.
|
|
166
|
-
- `ignores` is exactly the same as ESLint's `ignores`.
|
|
167
|
+
- `ignores` is exactly the same as ESLint's `ignores`. If you specify an empty array `[]`, the default ignore list won't be used.
|
|
167
168
|
- `overrides`/`overridesAny` is similar to ESLint's `rules`, but with a very important advantage: you can provide a function that will be called with the rule severity and options set by eslint-config-un, which allows you to **granularly override the options** or change the severity of each rule.
|
|
168
169
|
- The only difference between `overrides` and `overridesAny` is that `overridesAny` will allow any rule to be overridden (from TypeScript's stand point; technically you can pass any rule to `overrides` too), while `overrides` will only allow those rules which are tied to the config.
|
|
169
170
|
- `overridesAny` will be applied **after** `overrides`.
|
|
170
171
|
- `forceSeverity` allows to bulk override the severity of all the rules not overridden via `overrides` or `overridesAny`.
|
|
172
|
+
|
|
171
173
|
</details>
|
|
172
174
|
|
|
173
175
|
<br>
|
|
@@ -176,154 +178,155 @@ Sub-config is a Config located within Config's options. If the parent config is
|
|
|
176
178
|
|
|
177
179
|
### Most popular and well known
|
|
178
180
|
|
|
179
|
-
| Un config name
|
|
180
|
-
|
|
|
181
|
-
|  `js`
|
|
182
|
-
| ![TypeScript]
|
|
183
|
-
| ![TypeScript]
|
|
184
|
-
| ![TypeScript]
|
|
185
|
-
| ![TypeScript]
|
|
186
|
-
| 🦄 `unicorn`
|
|
187
|
-
| ⭐ `regexp`
|
|
188
|
-
| `promise`
|
|
189
|
-
| `import`
|
|
190
|
-
| `sonarjs`
|
|
191
|
-
| `eslintComments`
|
|
192
|
-
| `jsdoc`
|
|
193
|
-
| `jsdoc/typescript`
|
|
181
|
+
| Un config name | Enabled by default?<br>(optional condition) | Primary plugin(s) (`default-prefix`) | Description/Notes |
|
|
182
|
+
| --------------------------------------------------- | ------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------- |
|
|
183
|
+
|  `js` | ✅ | [Vanilla ESLint rules](https://eslint.org/docs/latest/rules) | - |
|
|
184
|
+
| ![TypeScript] `ts` | ✅ | [typescript-eslint](https://npmjs.com/typescript-eslint) (`ts`) | Only rules **not** requiring type information. |
|
|
185
|
+
| ![TypeScript] `ts/typeAware` | ✅ | ^ | Only rules requiring type information. |
|
|
186
|
+
| ![TypeScript] `ts/noTypeAssertion` | ✅ | [eslint-plugin-no-type-assertion](https://npmjs.com/eslint-plugin-no-type-assertion) (`no-type-assertion`) | - |
|
|
187
|
+
| ![TypeScript] `ts/sortTsconfigKeys` | ❌ | - | Sort type-level and `compilerOptions` keys in tsconfig files. |
|
|
188
|
+
| 🦄 `unicorn` | ✅ | [eslint-plugin-unicorn](https://npmjs.com/eslint-plugin-unicorn) (`unicorn`) | - |
|
|
189
|
+
| ⭐ `regexp` | ✅ | [eslint-plugin-regexp](https://npmjs.com/eslint-plugin-regexp) (`regexp`) | - |
|
|
190
|
+
| `promise` | ✅ | [eslint-plugin-promise](https://npmjs.com/eslint-plugin-promise) (`promise`) | - |
|
|
191
|
+
| `import` | ✅ | [eslint-plugin-import-x](https://npmjs.com/eslint-plugin-import-x) (`import`) | - |
|
|
192
|
+
| `sonarjs` | ✅ | [eslint-plugin-sonarjs](https://npmjs.com/eslint-plugin-sonarjs) (`sonarjs`) | - |
|
|
193
|
+
| `eslintComments` | ✅ | [@eslint-community/eslint-plugin-eslint-comments](https://npmjs.com/package/@eslint-community/eslint-plugin-eslint-comments) (`@eslint-community/eslint-comments`) | Since v0.1.3 |
|
|
194
|
+
| `jsdoc` | ✅ | [eslint-plugin-jsdoc](https://npmjs.com/eslint-plugin-jsdoc) (`jsdoc`) | Since v0.3.1 |
|
|
195
|
+
| `jsdoc/typescript` | ✅ (`ts` config is enabled) | - | Config for disabling or disabling certain rules for TypeScript files |
|
|
194
196
|
|
|
195
197
|
### Web frameworks & related
|
|
196
198
|
|
|
197
|
-
| Un config name
|
|
198
|
-
|
|
|
199
|
-
| ![VueJS]
|
|
200
|
-
| ![VueJS]
|
|
201
|
-
|  `vue/pinia`
|
|
202
|
-
| ![Angular]
|
|
203
|
-
| ![Angular]
|
|
204
|
-
| ![ReactJS]
|
|
205
|
-
| ![ReactJS]
|
|
206
|
-
| ![ReactJS]
|
|
207
|
-
| ![ReactJS]
|
|
208
|
-
| ![ReactJS]
|
|
209
|
-
| ![ReactJS]
|
|
210
|
-
| ![ReactJS]
|
|
211
|
-
|  `astro`
|
|
216
|
-
| ![
|
|
217
|
-
| ![
|
|
218
|
-
| ![Ember]
|
|
219
|
-
| ![Ember]
|
|
220
|
-
|  `lit`
|
|
222
|
-
| ![
|
|
223
|
-
| ![TailwindCSS]
|
|
224
|
-
|  `tailwind` | ❌ | [eslint-plugin-tailwindcss](https://npmjs.com/eslint-plugin-tailwindcss) (`tailwindcss`) | Only supports v3 |
|
|
199
|
+
| Un config name | Enabled by default?<br>(optional condition) | Primary plugin(s) (`default-prefix`) | Description/Notes |
|
|
200
|
+
| ---------------------------------------------------- | -------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- |
|
|
201
|
+
| ![VueJS] `vue` | ✅ (`vue` is installed) | [eslint-plugin-vue](https://npmjs.com/eslint-plugin-vue) (`vue`) | - |
|
|
202
|
+
| ![VueJS] `vue/a11y` | ✅ | [eslint-plugin-vuejs-accessibility](https://npmjs.com/eslint-plugin-vuejs-accessibility) (`vuejs-accessibility`) | - |
|
|
203
|
+
|  `vue/pinia` | ✅ (`pinia` is installed) | [eslint-plugin-pinia](https://npmjs.com/eslint-plugin-pinia) (`pinia`) | - |
|
|
204
|
+
| ![Angular] `angular` | ✅ (`@angular/core` is installed) | [@angular-eslint/eslint-plugin](https://npmjs.com/package/@angular-eslint/eslint-plugin) (`@angular-eslint`) | Since v0.78.0 |
|
|
205
|
+
| ![Angular] `angular/template` | ✅ | [@angular-eslint/eslint-plugin/template](https://npmjs.com/package/@angular-eslint/eslint-plugin-template) (`@angular-eslint/template`) | - |
|
|
206
|
+
| ![ReactJS] `react` | ✅ (`react` is installed) | [eslint-plugin-react](https://npmjs.com/eslint-plugin-react) (`react`) | Since v0.8.0 |
|
|
207
|
+
| ![ReactJS] `react/reactX` | ✅ | [@eslint-react/eslint-plugin] (`@eslint-react`) | - |
|
|
208
|
+
| ![ReactJS] `react/hooks` | ✅ | [eslint-plugin-react-hooks](https://npmjs.com/eslint-plugin-react-hooks) (`react-hooks`)<br>[@eslint-react/eslint-plugin] (`@eslint-react`) | Includes rules with `@eslint-react/hooks-extra` prefix from `@eslint-react/eslint-plugin` |
|
|
209
|
+
| ![ReactJS] `react/dom` | ✅ (`react-dom` is installed) | [@eslint-react/eslint-plugin] (`@eslint-react`)<br>[eslint-plugin-react](https://npmjs.com/eslint-plugin-react) | Includes rules with `@eslint-react/dom` prefix from `@eslint-react/eslint-plugin` and DOM related rules from `eslint-plugin-react` |
|
|
210
|
+
| ![ReactJS] `react/refresh` | ✅ | [eslint-plugin-react-refresh](https://npmjs.com/eslint-plugin-react-refresh) (`react-refresh`) | - |
|
|
211
|
+
| ![ReactJS] `react/youMightNotNeedAnEffect` | ✅ | [eslint-plugin-react-you-might-not-need-an-effect](https://npmjs.com/eslint-plugin-react-you-might-not-need-an-effect) (`react-you-might-not-need-an-effect`) | Since v1.0.0 |
|
|
212
|
+
| ![ReactJS] `react/allowDefaultExportsInJsxFiles` | ✅ | - | Config that allows default exports in all JSX files |
|
|
213
|
+
|  `nextJs` | ✅ (`next` is installed) | [@next/eslint-plugin-next](https://npmjs.com/package/@next/eslint-plugin-next) (`@next/next`) | Since v0.9.0 |
|
|
214
|
+
|  `solid` | ✅ (`solid-js` is installed) | [eslint-plugin-solid](https://npmjs.com/eslint-plugin-solid) (`solid`) | Since v0.10.0 |
|
|
215
|
+
|  `qwik` | ✅ (`@builder.io/qwik` or `@qwik.dev/core` is installed) | [eslint-plugin-qwik](https://npmjs.com/eslint-plugin-qwik) (`qwik`) | Since v0.6.0 |
|
|
216
|
+
|  `astro` | ✅ (`astro` is installed) | [eslint-plugin-astro](https://npmjs.com/eslint-plugin-astro) (`astro`) | Since v0.9.0<br>Without A11Y rules |
|
|
217
|
+
|  `astro/jsxA11y` | ✅ | ^ | Only A11Y rules from `eslint-plugin-astro` |
|
|
218
|
+
|  `svelte` | ✅ (`svelte` is installed) | [eslint-plugin-svelte](https://npmjs.com/eslint-plugin-svelte) (`svelte`) | Since v0.10.0 |
|
|
219
|
+
| ![Ember] `ember` | ✅ (`ember-source` is installed) | [eslint-plugin-ember](https://npmjs.com/eslint-plugin-ember) (`ember`) | Since v1.0.0 |
|
|
220
|
+
| ![Ember] `ember/testFiles` | ✅ | ^ | Since v1.0.0 |
|
|
221
|
+
| ![Ember] `ember/testFiles/noOnlyTests` | ✅ | [eslint-plugin-no-only-tests] (`no-only-tests`) | Since v1.0.0 |
|
|
222
|
+
|  `lit` | ✅ (`lit` is installed) | [eslint-plugin-lit](https://npmjs.com/eslint-plugin-lit) (`lit`) | Since v1.0.0 |
|
|
223
|
+
|  `lit/a11y` | ✅ | [eslint-plugin-lit-a11y](https://npmjs.com/eslint-plugin-lit-a11y) (`lit-a11y`) | Since v1.0.0 |
|
|
224
|
+
| ![TailwindCSS] `betterTailwind` | ✅ (`tailwindcss` is installed) | [eslint-plugin-better-tailwindcss](https://npmjs.com/eslint-plugin-better-tailwindcss) (`better-tailwindcss`) | Since v1.0.0<br>Supports v4 and v3 |
|
|
225
|
+
| ![TailwindCSS] `tailwind` | ❌ | [eslint-plugin-tailwindcss](https://npmjs.com/eslint-plugin-tailwindcss) (`tailwindcss`) | Only supports v3 |
|
|
225
226
|
|
|
226
227
|
### Runtimes & related
|
|
227
228
|
|
|
228
|
-
| Un config name
|
|
229
|
-
|
|
|
230
|
-
|  `node` | ✅
|
|
231
|
-
| ![npm]
|
|
232
|
-
| ![npm]
|
|
233
|
-
| ![npm]
|
|
234
|
-
| ![pnpm]
|
|
235
|
-
| ![pnpm]
|
|
236
|
-
| ![pnpm]
|
|
237
|
-
|  `cloudfrontFunctions` | ❌
|
|
238
|
-
|  `cloudfrontFunctions/V1` | ❌
|
|
229
|
+
| Un config name | Enabled by default?<br>(optional condition) | Primary plugin(s) (`default-prefix`) | Description/Notes |
|
|
230
|
+
| -------------------------------------------------------------------------------- | ------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
231
|
+
|  `node` | ✅ | [eslint-plugin-n](https://npmjs.com/eslint-plugin-n) (`node`) | - |
|
|
232
|
+
| ![npm] `packageJson` | ❌ | [eslint-plugin-package-json](https://npmjs.com/eslint-plugin-package-json) (`package-json`) | Since v0.1.5 |
|
|
233
|
+
| ![npm] `nodeDependencies` | ❌ | [eslint-plugin-node-dependencies](https://npmjs.com/eslint-plugin-node-dependencies) (`node-dependencies`) | Since v0.10.0 |
|
|
234
|
+
| ![npm] `depend` | ❌ | [eslint-plugin-depend](https://npmjs.com/eslint-plugin-depend) (`depend`) | Since v1.0.0 |
|
|
235
|
+
| ![pnpm] `pnpm` | ✅ (pnpm is detected as a package manager) | [eslint-plugin-pnpm](https://npmjs.com/eslint-plugin-pnpm) (`pnpm`) | Since v0.8.0<br>Does nothing, split into sub-configs |
|
|
236
|
+
| ![pnpm] `pnpm/packageJson` | ✅ | ^ | Plugin rules related to `package.json` files |
|
|
237
|
+
| ![pnpm] `pnpm/pnpmWorkspace` | ✅ | ^ | Plugin rules related to `pnpm-workspace.yaml` file |
|
|
238
|
+
|  `cloudfrontFunctions` | ❌ | - | Since v0.10.0<br>For linting [Amazon CloudFront Functions](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/cloudfront-functions.html) written for JavaScript Runtime v2 |
|
|
239
|
+
|  `cloudfrontFunctions/V1` | ❌ | - | Same, but for JavaScript Runtime v1 functions |
|
|
239
240
|
|
|
240
241
|
### Languages
|
|
241
242
|
|
|
242
|
-
| Un config name
|
|
243
|
-
|
|
|
244
|
-
| ![Markdown]
|
|
245
|
-
| ![Markdown]
|
|
246
|
-
| ![
|
|
247
|
-
| ![
|
|
248
|
-
| ![
|
|
249
|
-
| `
|
|
250
|
-
| ![
|
|
251
|
-
|
|
|
252
|
-
|
|
|
253
|
-
| `jsonc
|
|
254
|
-
| `jsonc/
|
|
255
|
-
| `
|
|
256
|
-
|
|
|
257
|
-
|
|
|
258
|
-
| ![
|
|
259
|
-
|
|
260
|
-
|
|
261
|
-
|
|
262
|
-
|
|
263
|
-
|
|
264
|
-
|
|
|
265
|
-
|
|
|
266
|
-
| `
|
|
267
|
-
| `
|
|
268
|
-
| `
|
|
269
|
-
| `
|
|
270
|
-
| `
|
|
271
|
-
| `
|
|
272
|
-
| `
|
|
273
|
-
| `
|
|
274
|
-
| `
|
|
243
|
+
| Un config name | Enabled by default?<br>(optional condition) | Primary plugin(s) (`default-prefix`) | Description/Notes |
|
|
244
|
+
| ----------------------------------------------------- | ------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- |
|
|
245
|
+
| ![Markdown] `markdown` | ✅ | [@eslint/markdown](https://npmjs.com/package/@eslint/markdown) (`markdown`) | Since v0.7.0<br>Configured to also lint fenced code blocks inside .md files |
|
|
246
|
+
| ![Markdown] `markdown/formatFencedCodeBlocks` | ✅ (`prettier` is installed) | [eslint-plugin-prettier](https://npmjs.com/eslint-plugin-prettier) (`prettier`) | Since v1.0.0<br>Format fenced code blocks inside Markdown files using Prettier |
|
|
247
|
+
| ![Markdown] `markdown-preferences` | ✅ | [eslint-plugin-markdown-preferences](https://npmjs.com/package/eslint-plugin-markdown-preferences) (`markdownPreferences`) | Since v1.0.0 |
|
|
248
|
+
| ![Markdown] `markdown-links` | ✅ | [eslint-plugin-markdown-links](https://npmjs.com/package/eslint-plugin-markdown-links) (`markdownLinks`) | Since v1.0.0 |
|
|
249
|
+
|  `mdx` | ✅ | [eslint-plugin-mdx](https://npmjs.com/eslint-plugin-mdx) (`mdx`) | Since v1.0.0<br>Configured to also lint fenced code blocks inside .mdx files |
|
|
250
|
+
| ![CSS] `css` | ✅ (unless `stylelint` is installed) | [@eslint/css](https://npmjs.com/package/@eslint/css) (`css`) | Since v0.7.0 |
|
|
251
|
+
| ![CSS] `cssInJs` | ✅ | [eslint-plugin-css](https://npmjs.com/eslint-plugin-css) (`css-in-js`) | Since v0.2.0<br>Lints inlined CSS |
|
|
252
|
+
| `jsxA11y` | ✅ | [eslint-plugin-jsx-a11y-x](https://npmjs.com/eslint-plugin-jsx-a11y-x) (`jsx-a11y`) | Since v1.0.0<br>Since v0.8.0 and until v1.0.0, [eslint-plugin-jsx-a11y](https://npmjs.com/eslint-plugin-jsx-a11y) was used |
|
|
253
|
+
|  `yaml` | ❌ | [eslint-plugin-yaml](https://npmjs.com/eslint-plugin-yaml) (`yaml`) | Since v0.1.0 |
|
|
254
|
+
|  `jsonc` | ❌ | [eslint-plugin-jsonc](https://npmjs.com/eslint-plugin-jsonc) (`jsonc`) | Since v0.1.4<br>Supports JSON, JSON5, JSONC |
|
|
255
|
+
| `jsonc/json` | ❌ | ^ | Config exclusively for `.json` files, does nothing by default |
|
|
256
|
+
| `jsonc/jsonc` | ❌ | ^ | Config exclusively for `.jsonc` files, does nothing by default |
|
|
257
|
+
| `jsonc/json5` | ❌ | ^ | Config exclusively for `.json5` files, does nothing by default |
|
|
258
|
+
| `jsonSchemaValidator` | ❌ | [eslint-plugin-json-schema-validator](https://npmjs.com/eslint-plugin-json-schema-validator) (`json-schema-validator`) | Since v0.6.0 |
|
|
259
|
+
|  `toml` | ❌ | [eslint-plugin-toml](https://npmjs.com/eslint-plugin-toml) (`toml`) | Since v0.1.3 |
|
|
260
|
+
|  `html` | ✅ | [@html-eslint/eslint-plugin](https://npmjs.com/package/@html-eslint/eslint-plugin) (`@html-eslint`) | Since v0.10.0 |
|
|
261
|
+
|  `graphql` | ✅ (`graphql` is installed) | [@graphql-eslint/eslint-plugin](https://npmjs.com/package/@graphql-eslint/eslint-plugin) (`graphql`) | Since v1.0.0 |
|
|
262
|
+
|
|
263
|
+
### Js/ts - miscellaneous
|
|
264
|
+
|
|
265
|
+
| Un config name | Enabled by default?<br>(optional condition) | Primary plugin(s) (`default-prefix`) | Description/Notes |
|
|
266
|
+
| ---------------------------- | ------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
267
|
+
| `security` | ❌ | [eslint-plugin-security](https://npmjs.com/eslint-plugin-security) (`security`) | - |
|
|
268
|
+
| `unusedImports` | ❌ | [eslint-plugin-unused-imports](https://npmjs.com/eslint-plugin-unused-imports) (`unused-imports`) | Since v0.7.0 |
|
|
269
|
+
| `unusedImports/noUnusedVars` | ❌ | ^ | Disables [`no-unused-vars`](https://eslint.org/docs/latest/rules/no-unused-vars), [`ts/no-unused-vars`](https://typescript-eslint.io/rules/no-unused-vars) and [`sonarjs/no-unused-vars`](https://sonarsource.github.io/rspec/#/rspec/S1481/javascript) rules in favor of `unused-imports/no-unused-vars` |
|
|
270
|
+
| `prefer-arrow-functions` | ❌ | [eslint-plugin-prefer-arrow-functions](https://npmjs.com/eslint-plugin-prefer-arrow-functions) (`prefer-arrow-functions`) | Since v0.1.0 |
|
|
271
|
+
| `perfectionist` | ❌ | [eslint-plugin-perfectionist](https://npmjs.com/eslint-plugin-perfectionist) (`perfectionist`) | Since v0.4.0<br>Supports sub-configs for each rule from the plugin since v1.0.0 |
|
|
272
|
+
| `de-morgan` | ❌ | [eslint-plugin-de-morgan](https://npmjs.com/eslint-plugin-de-morgan) (`de-morgan`) | Since v0.5.0 |
|
|
273
|
+
| `es` | ❌ | [eslint-plugin-es-x](https://npmjs.com/eslint-plugin-es-x) (`es-x`) | Since v0.10.0 |
|
|
274
|
+
| `jsInline` | ✅ | [eslint-plugin-html](https://npmjs.com/eslint-plugin-html) (`html`) | Since v0.10.0<br>For linting inlined JS in HTML files |
|
|
275
|
+
| `math` | ✅ | [eslint-plugin-math](https://npmjs.com/eslint-plugin-math) (`math`) | Since v1.0.0 |
|
|
276
|
+
| `erasableSyntaxOnly` | ❌ | [eslint-plugin-erasable-syntax-only](https://npmjs.com/eslint-plugin-erasable-syntax-only) (`erasable-syntax-only`) | Since v1.0.0 |
|
|
277
|
+
| `noUnnecessaryAbstractions` | ✅ | [eslint-plugin-unnecessary-abstractions](https://npmjs.com/eslint-plugin-unnecessary-abstractions) (`unnecessary-abstractions`) | Since v1.0.0 |
|
|
275
278
|
|
|
276
279
|
### Libraries
|
|
277
280
|
|
|
278
|
-
| Un config name
|
|
279
|
-
|
|
|
280
|
-
| `jest`
|
|
281
|
-
| `jest/extended`
|
|
282
|
-
| `jest/typescript`
|
|
283
|
-
| `jest/noOnlyTests`
|
|
284
|
-
| `vitest`
|
|
285
|
-
| `vitest/noOnlyTests`
|
|
286
|
-
| `ava`
|
|
287
|
-
| `ava/noOnlyTests`
|
|
288
|
-
| `qunit`
|
|
289
|
-
| `qunit/noOnlyTests`
|
|
290
|
-
| ![Testing Library]
|
|
291
|
-
| ![Testing Library]
|
|
292
|
-
| ![Testing Library]
|
|
293
|
-
| ![Testing Library]
|
|
294
|
-
| ![Testing Library]
|
|
295
|
-
| ![Testing Library]
|
|
296
|
-
| ![Testing Library]
|
|
297
|
-
| `noOnlyTests`
|
|
298
|
-
| `tanstackQuery`
|
|
299
|
-
|  `storybook`
|
|
300
|
-
|  `cypress`
|
|
301
|
-
|  `cypress/noOnlyTests`
|
|
302
|
-
|  `mocha`
|
|
303
|
-
|  `mocha/noOnlyTests`
|
|
304
|
-
|  `turbo`
|
|
305
|
-
|  `playwright`
|
|
306
|
-
|  `playwright/noOnlyTests`
|
|
307
|
-
|  `youDontNeedLodashUnderscore`
|
|
308
|
-
|  `rxjs`
|
|
309
|
-
|  `nx`
|
|
310
|
-
| `importZod`
|
|
311
|
-
|  `unocss`
|
|
281
|
+
| Un config name | Enabled by default?<br>(optional condition) | Primary plugin(s) (`default-prefix`) | Description/Notes |
|
|
282
|
+
| ----------------------------------------------------------------------------------- | ----------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------- |
|
|
283
|
+
| `jest` | ✅ (`jest` is installed) | [eslint-plugin-jest](https://npmjs.com/eslint-plugin-jest) (`jest`) | Since v0.3.0 |
|
|
284
|
+
| `jest/extended` | ✅ (`jest-extended` is installed) | [eslint-plugin-jest-extended](https://npmjs.com/eslint-plugin-jest-extended) (`jest-extended`) | - |
|
|
285
|
+
| `jest/typescript` | ✅ (`ts` config is enabled) | [eslint-plugin-jest](https://npmjs.com/eslint-plugin-jest) (`jest`) | Only TypeScript-specific rules from `eslint-plugin-jest` |
|
|
286
|
+
| `jest/noOnlyTests` | ❌ | [eslint-plugin-no-only-tests] (`no-only-tests`) | Since v1.0.0 |
|
|
287
|
+
| `vitest` | ✅ (`vitest` is installed) | [@vitest/eslint-plugin](https://npmjs.com/package/@vitest/eslint-plugin) (`vitest`) | Since v0.3.0 |
|
|
288
|
+
| `vitest/noOnlyTests` | ❌ | [eslint-plugin-no-only-tests] (`no-only-tests`) | Since v1.0.0 |
|
|
289
|
+
| `ava` | ✅ (`ava` is installed) | [eslint-plugin-ava](https://npmjs.com/eslint-plugin-ava) (`ava`) | Since v1.0.0 |
|
|
290
|
+
| `ava/noOnlyTests` | ❌ | [eslint-plugin-no-only-tests] (`no-only-tests`) | Since v1.0.0 |
|
|
291
|
+
| `qunit` | ✅ (`qunit` is installed) | [eslint-plugin-qunit](https://npmjs.com/eslint-plugin-qunit) (`qunit`) | Since v1.0.0 |
|
|
292
|
+
| `qunit/noOnlyTests` | ❌ | [eslint-plugin-no-only-tests] (`no-only-tests`) | Since v1.0.0 |
|
|
293
|
+
| ![Testing Library] `testingLibrary` | ✅ (`@testing-library/dom` is installed) | [eslint-plugin-testing-library](https://npmjs.com/eslint-plugin-testing-library) (`testing-library`) | Since v1.0.0 |
|
|
294
|
+
| ![Testing Library] `testingLibrary/angular` | ✅ (`angular` config is enabled) | ^ | Since v1.0.0 |
|
|
295
|
+
| ![Testing Library] `testingLibrary/marko` | ✅ (`marko` is installed) | ^ | Since v1.0.0 |
|
|
296
|
+
| ![Testing Library] `testingLibrary/react` | ✅ (`react` config is enabled) | ^ | Since v1.0.0 |
|
|
297
|
+
| ![Testing Library] `testingLibrary/svelte` | ✅ (`svelte` config is enabled) | ^ | Since v1.0.0 |
|
|
298
|
+
| ![Testing Library] `testingLibrary/vue` | ✅ (`vue` config is enabled) | ^ | Since v1.0.0 |
|
|
299
|
+
| ![Testing Library] `testingLibrary/*/noOnlyTests` | ✅ | [eslint-plugin-no-only-tests] (`no-only-tests`) | Since v1.0.0 |
|
|
300
|
+
| `noOnlyTests` | ❌ | [eslint-plugin-no-only-tests] (`no-only-tests`) | Since v1.0.0 |
|
|
301
|
+
| `tanstackQuery` | ✅ (`@tanstack/query-core` is installed) | [@tanstack/eslint-plugin-query](https://npmjs.com/package/@tanstack/eslint-plugin-query) (`@tanstack/query`) | Since v1.0.0 |
|
|
302
|
+
|  `storybook` | ✅ (`storybook` is installed) | [eslint-plugin-storybook](https://npmjs.com/eslint-plugin-storybook) (`storybook`) | Since v1.0.0 |
|
|
303
|
+
|  `cypress` | ✅ (`cypress` is installed) | [eslint-plugin-cypress](https://npmjs.com/eslint-plugin-cypress) (`cypress`) | Since v1.0.0 |
|
|
304
|
+
|  `cypress/noOnlyTests` | ✅ | [eslint-plugin-no-only-tests] (`no-only-tests`) | Since v1.0.0 |
|
|
305
|
+
|  `mocha` | ✅ (`mocha` is installed) | [eslint-plugin-mocha](https://npmjs.com/eslint-plugin-mocha) (`mocha`) | Since v1.0.0 |
|
|
306
|
+
|  `mocha/noOnlyTests` | ✅ | [eslint-plugin-no-only-tests] (`no-only-tests`) | Since v1.0.0 |
|
|
307
|
+
|  `turbo` | ✅ (`turbo` is installed) | [eslint-plugin-turbo](https://npmjs.com/eslint-plugin-turbo) (`turbo`) | Since v1.0.0 |
|
|
308
|
+
|  `playwright` | ✅ (`playwright` is installed) | [eslint-plugin-playwright](https://npmjs.com/eslint-plugin-playwright) (`playwright`) | Since v1.0.0 |
|
|
309
|
+
|  `playwright/noOnlyTests` | ❌ | [eslint-plugin-no-only-tests] (`no-only-tests`) | Since v1.0.0 |
|
|
310
|
+
|  `youDontNeedLodashUnderscore` | ✅ (`lodash`, `lodash-es` or `lodash.*` is installed) | [eslint-plugin-you-dont-need-lodash-underscore](https://npmjs.com/eslint-plugin-you-dont-need-lodash-underscore) (`you-dont-need-lodash-underscore`) | Since v1.0.0 |
|
|
311
|
+
|  `rxjs` | ✅ (`rxjs` is installed) | [@smarttools/eslint-plugin-rxjs](https://npmjs.com/@smarttools/eslint-plugin-rxjs) (`rxjs`) | Since v1.0.0 |
|
|
312
|
+
|  `nx` | ✅ (`nx` is installed) | [@nx/eslint-plugin](https://npmjs.com/@nx/eslint-plugin) (`nx`) | Since v1.0.0 |
|
|
313
|
+
| `importZod` | ✅ (`zod` and `next` are installed) | [eslint-plugin-import-zod](https://npmjs.com/eslint-plugin-import-zod) (`import-zod`) | Enforces namespace imports for `zod`<br>Since v1.0.0 |
|
|
314
|
+
|  `unocss` | ✅ (`unocss` is installed) | [@unocss/eslint-plugin](https://npmjs.com/@unocss/eslint-plugin) (`unocss`) | Since v1.0.0 |
|
|
312
315
|
|
|
313
316
|
### Miscellaneous
|
|
314
317
|
|
|
315
|
-
| Un config name
|
|
316
|
-
|
|
|
317
|
-
| `casePolice` | ❌
|
|
318
|
-
| `noStylisticRules` | ❌
|
|
319
|
-
| `noUnsanitized` | ✅
|
|
320
|
-
|  `cspell` | ❌
|
|
321
|
-
|  `eslintPlugin` | ❌
|
|
322
|
-
| `fileProgress` | ❌
|
|
323
|
-
| `compat` | ❌
|
|
324
|
-
| `webComponents` | ❌
|
|
325
|
-
| `header` | ❌
|
|
326
|
-
| `headers` | ❌
|
|
318
|
+
| Un config name | Enabled by default?<br>(optional condition) | Primary plugin(s) (`default-prefix`) | Description/Notes |
|
|
319
|
+
| -------------------------------------------------------------- | ------------------------------------------- | ------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- |
|
|
320
|
+
| `casePolice` | ❌ | [eslint-plugin-case-police](https://npmjs.com/eslint-plugin-case-police) (`case-police`) | Since v0.9.0 |
|
|
321
|
+
| `noStylisticRules` | ❌ | - | Since v1.0.0<br>Config to disable most of the stylistic rules. Can be useful when integrating eslint-config-un into an existing project. |
|
|
322
|
+
| `noUnsanitized` | ✅ | [eslint-plugin-no-unsanitized](https://npmjs.com/eslint-plugin-no-unsanitized) (`no-unsanitized`) | Since v1.0.0 |
|
|
323
|
+
|  `cspell` | ❌ | [@cspell/eslint-plugin](https://npmjs.com/package/@cspell/eslint-plugin) (`@cspell`) | Since v1.0.0 |
|
|
324
|
+
|  `eslintPlugin` | ❌ | [eslint-plugin-eslint-plugin](https://npmjs.com/eslint-plugin-eslint-plugin) (`eslint-plugin`) | Since v1.0.0<br>For linting ESLint plugins |
|
|
325
|
+
| `fileProgress` | ❌ | [eslint-plugin-file-progress](https://npmjs.com/eslint-plugin-file-progress) (`file-progress`) | Since v1.0.0<br>An ESlint plugin to print file progress |
|
|
326
|
+
| `compat` | ❌ | [eslint-plugin-compat](https://npmjs.com/eslint-plugin-compat) (`compat`) | Since v1.0.0 |
|
|
327
|
+
| `webComponents` | ❌ | [eslint-plugin-wc](https://npmjs.com/eslint-plugin-wc) (`wc`) | Since v1.0.0 |
|
|
328
|
+
| `header` | ❌ | [eslint-plugin-header](https://npmjs.com/eslint-plugin-header) (`header`) | Since v1.0.0 |
|
|
329
|
+
| `headers` | ❌ | [eslint-plugin-headers](https://npmjs.com/eslint-plugin-headers) (`headers`) | Since v1.0.0 |
|
|
327
330
|
|
|
328
331
|
## How to use
|
|
329
332
|
|
|
@@ -400,26 +403,60 @@ eslint-config-un provides the ability to change any registered plugin prefix. Ad
|
|
|
400
403
|
|
|
401
404
|
#### Default renames
|
|
402
405
|
|
|
403
|
-
| Plugin
|
|
404
|
-
|
|
|
405
|
-
| [`typescript-eslint`](https://npmjs.com/typescript-eslint)
|
|
406
|
-
| [`eslint-plugin-import-x`](https://npmjs.com/eslint-plugin-import-x)
|
|
407
|
-
| [`eslint-plugin-n`](https://npmjs.com/eslint-plugin-n)
|
|
408
|
-
| [`eslint-plugin-css`](https://npmjs.com/eslint-plugin-css)
|
|
406
|
+
| Plugin | Suggested prefix | Our prefix | Reason |
|
|
407
|
+
| ------------------------------------------------------------------------ | -------------------- | ----------- | ---------------------------------------------------------------------------------------------------------------------------- |
|
|
408
|
+
| [`typescript-eslint`](https://npmjs.com/typescript-eslint) | `@typescript-eslint` | `ts` | More concise and convenient to use |
|
|
409
|
+
| [`eslint-plugin-import-x`](https://npmjs.com/eslint-plugin-import-x) | `import-x` | `import` | This plugin is a fork and is meant to replace the original plugin with `import` prefix |
|
|
410
|
+
| [`eslint-plugin-n`](https://npmjs.com/eslint-plugin-n) | `n` | `node` | Same ^ |
|
|
411
|
+
| [`eslint-plugin-css`](https://npmjs.com/eslint-plugin-css) | `css` | `css-in-js` | Conflicts with [`@eslint/css`](https://npmjs.com/package/@eslint/css) and our name better captures the essence of the plugin |
|
|
412
|
+
| [`eslint-plugin-jsx-a11y-x`](https://npmjs.com/eslint-plugin-jsx-a11y-x) | `jsx-a11y-x` | `jsx-a11y` | This plugin is a fork and is meant to replace the original plugin with `jsx-a11y` prefix |
|
|
409
413
|
|
|
410
|
-
<!-- eslint-disable-next-line markdown/no-missing-label-refs -->
|
|
411
414
|
> [!NOTE]
|
|
412
415
|
> If you rename a plugin, you still have to use the original prefix within `overrides`, `overridesAny` and `extraConfigs`. eslint-config-un will rename the rules accordingly for you.
|
|
413
416
|
|
|
414
|
-
<!-- eslint-disable-next-line markdown/no-missing-label-refs -->
|
|
415
417
|
> [!WARNING] Renaming plugins and `eslint-disable` directives
|
|
416
418
|
> If you rename a plugin, you will have to manually rename the rules within `eslint-disable-*` directives.
|
|
417
419
|
|
|
418
420
|
### Disabling rule autofix
|
|
419
421
|
|
|
420
|
-
ESLint [doesn't (yet?) have the ability to disable autofix](https://github.com/eslint/rfcs/pull/125) for a rule by the user on per-rule basis. Our config attempts to provide this missing functionality by
|
|
422
|
+
ESLint [doesn't (yet?) have the ability to disable autofix](https://github.com/eslint/rfcs/pull/125) for a rule by the user on per-rule basis. Our config attempts to provide this missing functionality by giving the ability to disable autofix for a rule as a whole ("globally") or per-file and per-rule basis, but with a caveat that the rule will have `disable-autofix` prefix in its name.
|
|
423
|
+
|
|
424
|
+
#### Globally disabling rule autofix
|
|
425
|
+
|
|
426
|
+
You can disable autofix for any fixable rule globally using `autofixDisabledGloballyFor` root option:
|
|
427
|
+
|
|
428
|
+
```ts
|
|
429
|
+
import {eslintConfig} from 'eslint-config-un';
|
|
430
|
+
|
|
431
|
+
export default eslintConfig({
|
|
432
|
+
autofixDisabledGloballyFor: {
|
|
433
|
+
rules: {
|
|
434
|
+
'ts/array-type': true,
|
|
435
|
+
},
|
|
436
|
+
},
|
|
437
|
+
});
|
|
438
|
+
```
|
|
439
|
+
|
|
440
|
+
Note that by default we already globally disable autofix for some rules, the actual list of which can be found in JSDoc of this option.
|
|
441
|
+
|
|
442
|
+
It's also possible to disable autofixes for all the rules in the plugin at once, and then only enable them for the specific rules:
|
|
443
|
+
|
|
444
|
+
<!-- eslint-skip -->
|
|
445
|
+
|
|
446
|
+
```ts
|
|
447
|
+
autofixDisabledGloballyFor: {
|
|
448
|
+
plugins: {
|
|
449
|
+
ts: true,
|
|
450
|
+
},
|
|
451
|
+
rules: {
|
|
452
|
+
'ts/array-type': false,
|
|
453
|
+
},
|
|
454
|
+
},
|
|
455
|
+
```
|
|
456
|
+
|
|
457
|
+
#### Disabling rule autofix per-file
|
|
421
458
|
|
|
422
|
-
To disable autofix for a rule, use an object notation for the rule entry:
|
|
459
|
+
To disable autofix for a rule only granularly, use an object notation for the rule entry:
|
|
423
460
|
|
|
424
461
|
```ts
|
|
425
462
|
import {eslintConfig} from 'eslint-config-un';
|
|
@@ -430,7 +467,7 @@ export default eslintConfig({
|
|
|
430
467
|
overrides: {
|
|
431
468
|
'unicorn/better-regex': {
|
|
432
469
|
severity: 2,
|
|
433
|
-
disableAutofix:
|
|
470
|
+
disableAutofix: true,
|
|
434
471
|
},
|
|
435
472
|
},
|
|
436
473
|
},
|
|
@@ -438,10 +475,7 @@ export default eslintConfig({
|
|
|
438
475
|
});
|
|
439
476
|
```
|
|
440
477
|
|
|
441
|
-
|
|
442
|
-
* `prefixed`: will create a plugin with `disable-autofix` prefix and copy this rule into it. The final rule is going to be `disable-autofix/<rule-name>` and `<rule-name>` will be disabled in the resulting flat config.
|
|
443
|
-
* `true`: use the default autofix disabling method, determined in `disableAutofixMethod.default` root option, which defaults to `unprefixed`.
|
|
444
|
-
* `false`: re-enable autofix for the rule (does nothing if autofix for this rule is disabled anywhere else with `unprefixed` method).
|
|
478
|
+
This will technically create a plugin with `disable-autofix` prefix and copy this rule into it. The final rule is going to be given a name `disable-autofix/<rule-name>` which would replace `<rule-name>` entry in the resulting config.
|
|
445
479
|
|
|
446
480
|
## Configs notes
|
|
447
481
|
|
|
@@ -483,7 +517,7 @@ Set to `true` if you don't want `ignores` to be merged with our ignore patterns,
|
|
|
483
517
|
|
|
484
518
|
### `gitignore`
|
|
485
519
|
|
|
486
|
-
By default `.gitignore`d files will be added to `ignores` list. Set to `false` to disable this behavior. You may also provide an object which configures [eslint-config-flat-gitignore](https://npmjs.com/eslint-config-flat-gitignore), which provides this functionality in the first place.
|
|
520
|
+
By default `.gitignore`d files will be added to `ignores` list. Set to `false` to disable this behavior. You may also provide an object which configures [eslint-config-flat-gitignore](https://npmjs.com/eslint-config-flat-gitignore), which provides this functionality in the first place.
|
|
487
521
|
|
|
488
522
|
### `mode`
|
|
489
523
|
|
|
@@ -525,6 +559,7 @@ Alternatively, you can use [`@eslint/config-inspector`](https://npmjs.com/packag
|
|
|
525
559
|
|
|
526
560
|
## Troubleshooting & caveats
|
|
527
561
|
|
|
562
|
+
<!-- eslint-disable-next-line markdown-preferences/heading-casing, markdown-preferences/padding-line-between-blocks -->
|
|
528
563
|
### TypeError: Key `languageOptions`: Key `globals`: Global `AudioWorkletGlobalScope ` has leading or trailing whitespace.
|
|
529
564
|
|
|
530
565
|
Install `globals` package as a dev dependency.
|
|
@@ -533,9 +568,23 @@ Install `globals` package as a dev dependency.
|
|
|
533
568
|
|
|
534
569
|
If you would like not to wait until the dependencies of `eslint-config-un` are updated or by whatever other reason you need to install a different version of a dependency, you can do that using your package manager's settings for all but the following packages:
|
|
535
570
|
|
|
536
|
-
| Package name
|
|
537
|
-
|
|
|
538
|
-
| [`eslint-plugin-prettier`](https://npmjs.com/eslint-plugin-prettier)
|
|
539
|
-
| [`eslint-plugin-no-type-assertion`](https://npmjs.com/eslint-plugin-no-type-assertion)
|
|
540
|
-
| [`@angular-eslint/eslint-plugin-template@17.5.3`](https://npmjs.com/package/@angular-eslint/eslint-plugin-template/v/17.5.3) | Old version with outdated requirements of peer dependencies
|
|
541
|
-
| [`@angular-eslint/eslint-plugin@18.4.3`](https://npmjs.com/package/@angular-eslint/eslint-plugin-template/v/18.4.3)
|
|
571
|
+
| Package name | Reason |
|
|
572
|
+
| ---------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- |
|
|
573
|
+
| [`eslint-plugin-prettier`](https://npmjs.com/eslint-plugin-prettier) | Patched by us to enable formatting of "fenced code blocks" inside Markdown files |
|
|
574
|
+
| [`eslint-plugin-no-type-assertion`](https://npmjs.com/eslint-plugin-no-type-assertion) | Has outdated requirements of peer dependencies |
|
|
575
|
+
| [`@angular-eslint/eslint-plugin-template@17.5.3`](https://npmjs.com/package/@angular-eslint/eslint-plugin-template/v/17.5.3) | Old version with outdated requirements of peer dependencies |
|
|
576
|
+
| [`@angular-eslint/eslint-plugin@18.4.3`](https://npmjs.com/package/@angular-eslint/eslint-plugin-template/v/18.4.3) | ^ |
|
|
577
|
+
|
|
578
|
+
[@eslint-react/eslint-plugin]: https://npmjs.com/package/@eslint-react/eslint-plugin
|
|
579
|
+
[Angular]: ./assets/devicon-angular.svg
|
|
580
|
+
[CSS]: ./assets/devicon-css3.svg
|
|
581
|
+
[Ember]: ./assets/devicon-ember.svg
|
|
582
|
+
[Markdown]: ./assets/mdi-language-markdown.svg
|
|
583
|
+
[ReactJS]: ./assets/devicon-react.svg
|
|
584
|
+
[TailwindCSS]: ./assets/devicon-tailwindcss.svg
|
|
585
|
+
[Testing Library]: ./assets/logos-testing-library.svg
|
|
586
|
+
[TypeScript]: ./assets/devicon-typescript.svg
|
|
587
|
+
[VueJS]: ./assets/devicon-vuejs.svg
|
|
588
|
+
[eslint-plugin-no-only-tests]: https://npmjs.com/eslint-plugin-no-only-tests
|
|
589
|
+
[npm]: ./assets/devicon-npm.svg
|
|
590
|
+
[pnpm]: ./assets/devicon-pnpm.svg
|