@abinnovision/eslint-config-base 3.2.0-beta.6 → 3.2.0-beta.7
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 +11 -34
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -2,25 +2,6 @@
|
|
|
2
2
|
|
|
3
3
|
ESLint configuration for JavaScript and TypeScript projects.
|
|
4
4
|
|
|
5
|
-
## ESLint Compatibility
|
|
6
|
-
|
|
7
|
-
This package requires **ESLint v9** (`^9.0.0`). ESLint v10 is **not** supported
|
|
8
|
-
because key plugins in the ecosystem have not yet released compatible versions.
|
|
9
|
-
|
|
10
|
-
Until all dependencies fully support ESLint v10, we pin to v9 to ensure a stable
|
|
11
|
-
and working configuration out of the box.
|
|
12
|
-
|
|
13
|
-
## External ESLint Plugin Dependencies
|
|
14
|
-
|
|
15
|
-
| Plugin | Purpose |
|
|
16
|
-
| ------------------------------ | ----------------------------------------------------- |
|
|
17
|
-
| `@eslint/js` | ESLint core recommended rule set |
|
|
18
|
-
| `typescript-eslint` | TypeScript parser and strict type-checked rule set |
|
|
19
|
-
| `eslint-plugin-import` | Import ordering, grouping, and validation |
|
|
20
|
-
| `eslint-plugin-unused-imports` | Detect and auto-fix unused imports and variables |
|
|
21
|
-
| `@vitest/eslint-plugin` | Vitest-specific rules for test files (vitest flavour) |
|
|
22
|
-
| `globals` | Environment globals (e.g. Node.js for config files) |
|
|
23
|
-
|
|
24
5
|
## Installation
|
|
25
6
|
|
|
26
7
|
```shell
|
|
@@ -36,8 +17,6 @@ import { base } from "@abinnovision/eslint-config-base";
|
|
|
36
17
|
export default [{ extends: [base] }];
|
|
37
18
|
```
|
|
38
19
|
|
|
39
|
-
### TypeScript Configuration
|
|
40
|
-
|
|
41
20
|
If your `tsconfig.json` is not in the project root:
|
|
42
21
|
|
|
43
22
|
```javascript
|
|
@@ -58,12 +37,8 @@ export default [
|
|
|
58
37
|
|
|
59
38
|
## Flavours
|
|
60
39
|
|
|
61
|
-
Specialized configurations for specific project types.
|
|
62
|
-
|
|
63
40
|
### NestJS
|
|
64
41
|
|
|
65
|
-
For NestJS applications with dependency injection patterns.
|
|
66
|
-
|
|
67
42
|
```javascript
|
|
68
43
|
import { nestjs } from "@abinnovision/eslint-config-base";
|
|
69
44
|
|
|
@@ -72,12 +47,20 @@ export default [{ extends: [nestjs] }];
|
|
|
72
47
|
|
|
73
48
|
### Vitest
|
|
74
49
|
|
|
75
|
-
For test files using Vitest.
|
|
76
|
-
|
|
77
50
|
```javascript
|
|
78
51
|
import { base, vitest } from "@abinnovision/eslint-config-base";
|
|
79
52
|
|
|
80
|
-
export default [{ extends: [base
|
|
53
|
+
export default [{ extends: [base, vitest] }];
|
|
54
|
+
```
|
|
55
|
+
|
|
56
|
+
### Stylistic
|
|
57
|
+
|
|
58
|
+
Enforces consistent code style (formatting, spacing, naming conventions).
|
|
59
|
+
|
|
60
|
+
```javascript
|
|
61
|
+
import { base, stylistic } from "@abinnovision/eslint-config-base";
|
|
62
|
+
|
|
63
|
+
export default [{ extends: [base, stylistic] }];
|
|
81
64
|
```
|
|
82
65
|
|
|
83
66
|
### Config Files
|
|
@@ -96,12 +79,6 @@ export default [
|
|
|
96
79
|
];
|
|
97
80
|
```
|
|
98
81
|
|
|
99
|
-
## Related Packages
|
|
100
|
-
|
|
101
|
-
- [@abinnovision/eslint-config-react](../eslint-config-react) - React
|
|
102
|
-
configuration
|
|
103
|
-
- [@abinnovision/prettier-config](../prettier-config) - Code formatting
|
|
104
|
-
|
|
105
82
|
## License
|
|
106
83
|
|
|
107
84
|
Apache-2.0
|