@create-node-app/eslint-config 0.2.0 → 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 +65 -0
- package/package.json +1 -1
package/README.md
ADDED
|
@@ -0,0 +1,65 @@
|
|
|
1
|
+
<div align="center">
|
|
2
|
+
|
|
3
|
+
<h1>📐 <code>@create-node-app/eslint-config</code></h1>
|
|
4
|
+
|
|
5
|
+
<p><strong>Base ESLint configuration for Create Awesome Node App projects.</strong><br/>
|
|
6
|
+
Shared linting rules powered by Turborepo + Prettier.</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
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
Requires **ESLint ^9**.
|
|
23
|
+
|
|
24
|
+
---
|
|
25
|
+
|
|
26
|
+
## Usage
|
|
27
|
+
|
|
28
|
+
In your `eslint.config.*` or `.eslintrc.*`:
|
|
29
|
+
|
|
30
|
+
```json
|
|
31
|
+
{
|
|
32
|
+
"extends": ["@create-node-app"]
|
|
33
|
+
}
|
|
34
|
+
```
|
|
35
|
+
|
|
36
|
+
This config extends:
|
|
37
|
+
|
|
38
|
+
- **`turbo`** — Turborepo's recommended rules for monorepo workspaces
|
|
39
|
+
- **`prettier`** — Turns off rules that conflict with Prettier
|
|
40
|
+
|
|
41
|
+
And sets the default environment to `browser`, `commonjs`, `node`, and `es2020`.
|
|
42
|
+
|
|
43
|
+
---
|
|
44
|
+
|
|
45
|
+
## Related Configs
|
|
46
|
+
|
|
47
|
+
| Package | Description |
|
|
48
|
+
|---------|-------------|
|
|
49
|
+
| `@create-node-app/eslint-config-ts` | Adds TypeScript support (extends this config) |
|
|
50
|
+
| `@create-node-app/eslint-config-react` | Adds React + React Hooks rules (extends the TS config) |
|
|
51
|
+
| `@create-node-app/eslint-config-next` | Adds Next.js rules (extends the TS config) |
|
|
52
|
+
|
|
53
|
+
---
|
|
54
|
+
|
|
55
|
+
## License
|
|
56
|
+
|
|
57
|
+
MIT © [Create Node App Contributors](https://github.com/Create-Node-App/create-node-app/graphs/contributors)
|
|
58
|
+
|
|
59
|
+
<!-- Reference links -->
|
|
60
|
+
|
|
61
|
+
[npmversion]: https://img.shields.io/npm/v/@create-node-app/eslint-config.svg?style=flat-square&color=cb3837
|
|
62
|
+
[npmdownloads]: https://img.shields.io/npm/dm/@create-node-app/eslint-config.svg?style=flat-square&color=cb3837
|
|
63
|
+
[licensebadge]: https://img.shields.io/badge/License-MIT-blue.svg?style=flat-square
|
|
64
|
+
[npmurl]: https://www.npmjs.com/package/@create-node-app/eslint-config
|
|
65
|
+
[licenseurl]: https://github.com/Create-Node-App/create-node-app/blob/main/LICENSE
|