@create-node-app/eslint-config-ts 0.1.1 → 0.2.1
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 +75 -0
- package/package.json +2 -2
package/README.md
ADDED
|
@@ -0,0 +1,75 @@
|
|
|
1
|
+
<div align="center">
|
|
2
|
+
|
|
3
|
+
<h1>📐 <code>@create-node-app/eslint-config-ts</code></h1>
|
|
4
|
+
|
|
5
|
+
<p><strong>TypeScript ESLint configuration for Create Awesome Node App projects.</strong><br/>
|
|
6
|
+
Extends the base config with <code>@typescript-eslint</code> for strict TypeScript linting.</p>
|
|
7
|
+
|
|
8
|
+
[![npm][npmversion]][npmurl]
|
|
9
|
+
[![Downloads][npmdownloads]][npmurl]
|
|
10
|
+
[![License: MIT][licensebadge]][licenseurl]
|
|
11
|
+
|
|
12
|
+
</div>
|
|
13
|
+
|
|
14
|
+
---
|
|
15
|
+
|
|
16
|
+
## Installation
|
|
17
|
+
|
|
18
|
+
```bash
|
|
19
|
+
npm install --save-dev @create-node-app/eslint-config-ts
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
Requires **ESLint ^9** and **TypeScript ^5**.
|
|
23
|
+
|
|
24
|
+
---
|
|
25
|
+
|
|
26
|
+
## Usage
|
|
27
|
+
|
|
28
|
+
In your `eslint.config.*` or `.eslintrc.*`:
|
|
29
|
+
|
|
30
|
+
```json
|
|
31
|
+
{
|
|
32
|
+
"extends": ["@create-node-app/eslint-config-ts"]
|
|
33
|
+
}
|
|
34
|
+
```
|
|
35
|
+
|
|
36
|
+
---
|
|
37
|
+
|
|
38
|
+
## What's Included
|
|
39
|
+
|
|
40
|
+
This config extends `@create-node-app/eslint-config` and adds:
|
|
41
|
+
|
|
42
|
+
- **Parser**: `@typescript-eslint/parser`
|
|
43
|
+
- **Plugin rules**: `plugin:@typescript-eslint/recommended`
|
|
44
|
+
- **Custom rule**: `@typescript-eslint/ban-ts-comment` — requires a description of at least 10 characters when using `@ts-ignore`
|
|
45
|
+
|
|
46
|
+
---
|
|
47
|
+
|
|
48
|
+
## Inheritance Chain
|
|
49
|
+
|
|
50
|
+
```
|
|
51
|
+
@create-node-app/eslint-config (base)
|
|
52
|
+
└── @create-node-app/eslint-config-ts
|
|
53
|
+
```
|
|
54
|
+
|
|
55
|
+
Consumers can also extend from this config:
|
|
56
|
+
|
|
57
|
+
```
|
|
58
|
+
@create-node-app/eslint-config-ts
|
|
59
|
+
├── @create-node-app/eslint-config-react
|
|
60
|
+
└── @create-node-app/eslint-config-next
|
|
61
|
+
```
|
|
62
|
+
|
|
63
|
+
---
|
|
64
|
+
|
|
65
|
+
## License
|
|
66
|
+
|
|
67
|
+
MIT © [Create Node App Contributors](https://github.com/Create-Node-App/create-node-app/graphs/contributors)
|
|
68
|
+
|
|
69
|
+
<!-- Reference links -->
|
|
70
|
+
|
|
71
|
+
[npmversion]: https://img.shields.io/npm/v/@create-node-app/eslint-config-ts.svg?style=flat-square&color=cb3837
|
|
72
|
+
[npmdownloads]: https://img.shields.io/npm/dm/@create-node-app/eslint-config-ts.svg?style=flat-square&color=cb3837
|
|
73
|
+
[licensebadge]: https://img.shields.io/badge/License-MIT-blue.svg?style=flat-square
|
|
74
|
+
[npmurl]: https://www.npmjs.com/package/@create-node-app/eslint-config-ts
|
|
75
|
+
[licenseurl]: https://github.com/Create-Node-App/create-node-app/blob/main/LICENSE
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@create-node-app/eslint-config-ts",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.2.1",
|
|
4
4
|
"main": "index.js",
|
|
5
5
|
"license": "MIT",
|
|
6
6
|
"files": [
|
|
@@ -16,7 +16,7 @@
|
|
|
16
16
|
"@create-node-app/eslint-config": "*"
|
|
17
17
|
},
|
|
18
18
|
"devDependencies": {
|
|
19
|
-
"typescript": "^
|
|
19
|
+
"typescript": "^6.0.3"
|
|
20
20
|
},
|
|
21
21
|
"publishConfig": {
|
|
22
22
|
"access": "public",
|