@ethang/eslint-config 19.15.3 → 19.15.4
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 +98 -0
- package/package.json +1 -1
package/README.md
ADDED
|
@@ -0,0 +1,98 @@
|
|
|
1
|
+
# Relentless. Unapologetic.
|
|
2
|
+
|
|
3
|
+
[View Config](https://eslint-config-ethang.pages.dev/rules)
|
|
4
|
+
|
|
5
|
+
> [!CAUTION]
|
|
6
|
+
> Do not use this with Prettier! Styling rules are included.
|
|
7
|
+
|
|
8
|
+
- 890 errored rules.
|
|
9
|
+
- 295 rules from [eslint-plugin-sonarjs](https://github.com/SonarSource/SonarJS/blob/master/packages/jsts/src/rules/README.md)
|
|
10
|
+
- 144 rules from [@eslint/js](https://github.com/eslint/eslint/tree/main/packages/js)
|
|
11
|
+
- 116 rules from [sindresorhus/eslint-plugin-unicorn](https://github.com/sindresorhus/eslint-plugin-unicorn)
|
|
12
|
+
- 105 rules from [@typescript/eslint](https://github.com/typescript-eslint/typescript-eslint)
|
|
13
|
+
- 68 rules from [@stylistic/eslint-plugin](https://eslint.style/)
|
|
14
|
+
- 34 rules from [jsx-a11y](https://github.com/jsx-eslint/eslint-plugin-jsx-a11y)
|
|
15
|
+
- 32 rules from [eslint-plugin-lodash](https://github.com/wix-incubator/eslint-plugin-lodash)
|
|
16
|
+
- 25 rules from [@stylistic/eslint-plugin-ts](https://eslint.style/)
|
|
17
|
+
- 20 rules from [eslint-plugin-n](https://github.com/eslint-community/eslint-plugin-n)
|
|
18
|
+
- 20 rules from [eslint-plugin-perfectionist](https://github.com/azat-io/eslint-plugin-perfectionist)
|
|
19
|
+
- 7 rules from [eslint-plugin-tailwindcss](https://github.com/francoismassart/eslint-plugin-tailwindcss)
|
|
20
|
+
- 7 rules from [@eslint/markdown](https://github.com/eslint/markdown)
|
|
21
|
+
- 5 rules from [@tanstack/eslint-plugin-query](https://tanstack.com/query/latest/docs/eslint/eslint-plugin-query)
|
|
22
|
+
- 4 rules from [eslint-plugin-barrel-files](https://github.com/thepassle/eslint-plugin-barrel-files)
|
|
23
|
+
- 4 rules from [@eslint/json](https://github.com/eslint/json)
|
|
24
|
+
- 1 rule from [eslint-plugin-depend](https://github.com/es-tooling/eslint-plugin-depend/tree/main)
|
|
25
|
+
- 1 rule from [@cspell/eslint-plugin](https://github.com/streetsidesoftware/cspell/tree/main/packages/cspell-eslint-plugin)
|
|
26
|
+
- 1 rule from [eslint-plugin-compat](https://github.com/amilajack/eslint-plugin-compat)
|
|
27
|
+
- 1 rule from [@tanstack/eslint-plugin-router](https://tanstack.com/router/latest/docs/eslint/eslint-plugin-router)
|
|
28
|
+
|
|
29
|
+
# Add Even More!
|
|
30
|
+
|
|
31
|
+
- 52 rules for **Astro**
|
|
32
|
+
- `import astroConfig from "@ethang/eslint-config/config.astro.js";`
|
|
33
|
+
- 52 rules from [eslint-plugin-astro](https://github.com/ota-meshi/eslint-plugin-astro)
|
|
34
|
+
- 78 rules for **React**
|
|
35
|
+
- `import reactConfig from "@ethang/eslint-config/config.react.js";`
|
|
36
|
+
- 75 rules from [@eslint-react/eslint-plugin](https://eslint-react.xyz/)
|
|
37
|
+
- 2 rules from [eslint-plugin-react-hooks](https://github.com/facebook/react/tree/main/packages/eslint-plugin-react-hooks)
|
|
38
|
+
- 1 rules from [eslint-plugin-react-compiler](https://github.com/facebook/react/tree/main/compiler/packages/eslint-plugin-react-compiler)
|
|
39
|
+
- 18 rules for **Solid**
|
|
40
|
+
- `import solidConfig from "@ethang/eslint-config/config.solid.js";`
|
|
41
|
+
- 18 rules from [eslint-plugin-solid](https://github.com/solidjs-community/eslint-plugin-solid)
|
|
42
|
+
|
|
43
|
+
# Install
|
|
44
|
+
|
|
45
|
+
`pnpm i -D eslint typescript-eslint @ethang/eslint-config`
|
|
46
|
+
|
|
47
|
+
**Requires TypesScript and tsconfig.json at root directory.**
|
|
48
|
+
|
|
49
|
+
# Config
|
|
50
|
+
|
|
51
|
+
In **eslint.config.js**
|
|
52
|
+
|
|
53
|
+
```js
|
|
54
|
+
import config from "@ethang/eslint-config/eslint.config.js";
|
|
55
|
+
import tseslint from "typescript-eslint";
|
|
56
|
+
import astroConfig from "@ethang/eslint-config/config.astro.js"; // OPTIONAL
|
|
57
|
+
import reactConfig from "@ethang/eslint-config/config.react.js"; // OPTIONAL
|
|
58
|
+
|
|
59
|
+
export default tseslint.config(
|
|
60
|
+
{
|
|
61
|
+
ignores: [], // Ignored files apply to all following configs
|
|
62
|
+
},
|
|
63
|
+
...config,
|
|
64
|
+
...astroConfig,
|
|
65
|
+
...reactConfig,
|
|
66
|
+
{
|
|
67
|
+
languageOptions: {
|
|
68
|
+
parserOptions: {
|
|
69
|
+
project: true,
|
|
70
|
+
tsconfigRootDir: import.meta.dirname,
|
|
71
|
+
},
|
|
72
|
+
},
|
|
73
|
+
rules: {
|
|
74
|
+
// Override rules from above configs
|
|
75
|
+
},
|
|
76
|
+
},
|
|
77
|
+
);
|
|
78
|
+
```
|
|
79
|
+
|
|
80
|
+
**Scripts**
|
|
81
|
+
|
|
82
|
+
```json
|
|
83
|
+
"scripts": {
|
|
84
|
+
"lint": "eslint",
|
|
85
|
+
"lint:fix": "eslint . --fix",
|
|
86
|
+
}
|
|
87
|
+
```
|
|
88
|
+
|
|
89
|
+
**Browserslist**
|
|
90
|
+
|
|
91
|
+
This config will also lint for browserslist features. Make sure to set this in package.json. [More info.](https://github.com/browserslist/browserslist)
|
|
92
|
+
|
|
93
|
+
```json
|
|
94
|
+
"browserslist": [
|
|
95
|
+
"defaults and fully supports es6-module",
|
|
96
|
+
"maintained node versions"
|
|
97
|
+
]
|
|
98
|
+
```
|