@create-node-app/eslint-config-next 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 +69 -0
- package/package.json +1 -1
package/README.md
ADDED
|
@@ -0,0 +1,69 @@
|
|
|
1
|
+
<div align="center">
|
|
2
|
+
|
|
3
|
+
<h1>📐 <code>@create-node-app/eslint-config-next</code></h1>
|
|
4
|
+
|
|
5
|
+
<p><strong>Next.js ESLint configuration for Create Awesome Node App projects.</strong><br/>
|
|
6
|
+
Extends the TypeScript config with the official Next.js ESLint plugin.</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-next
|
|
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-next"]
|
|
33
|
+
}
|
|
34
|
+
```
|
|
35
|
+
|
|
36
|
+
---
|
|
37
|
+
|
|
38
|
+
## What's Included
|
|
39
|
+
|
|
40
|
+
This config extends `@create-node-app/eslint-config-ts` and the official `eslint-config-next`, then applies two rule overrides:
|
|
41
|
+
|
|
42
|
+
| Rule | Value | Reason |
|
|
43
|
+
|------|-------|--------|
|
|
44
|
+
| `@next/next/no-html-link-for-pages` | `off` | Pages directory not always used (App Router) |
|
|
45
|
+
| `react/jsx-key` | `off` | Already covered by TypeScript's strict checks |
|
|
46
|
+
|
|
47
|
+
---
|
|
48
|
+
|
|
49
|
+
## Inheritance Chain
|
|
50
|
+
|
|
51
|
+
```
|
|
52
|
+
@create-node-app/eslint-config (base)
|
|
53
|
+
└── @create-node-app/eslint-config-ts
|
|
54
|
+
└── @create-node-app/eslint-config-next
|
|
55
|
+
```
|
|
56
|
+
|
|
57
|
+
---
|
|
58
|
+
|
|
59
|
+
## License
|
|
60
|
+
|
|
61
|
+
MIT © [Create Node App Contributors](https://github.com/Create-Node-App/create-node-app/graphs/contributors)
|
|
62
|
+
|
|
63
|
+
<!-- Reference links -->
|
|
64
|
+
|
|
65
|
+
[npmversion]: https://img.shields.io/npm/v/@create-node-app/eslint-config-next.svg?style=flat-square&color=cb3837
|
|
66
|
+
[npmdownloads]: https://img.shields.io/npm/dm/@create-node-app/eslint-config-next.svg?style=flat-square&color=cb3837
|
|
67
|
+
[licensebadge]: https://img.shields.io/badge/License-MIT-blue.svg?style=flat-square
|
|
68
|
+
[npmurl]: https://www.npmjs.com/package/@create-node-app/eslint-config-next
|
|
69
|
+
[licenseurl]: https://github.com/Create-Node-App/create-node-app/blob/main/LICENSE
|