@ncontiero/eslint-config 5.1.0 → 5.2.0

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 CHANGED
@@ -1,8 +1,8 @@
1
- # @dkshs/eslint-config
1
+ # @ncontiero/eslint-config
2
2
 
3
3
  Nicolas's ESLint config preset for JavaScript, TypeScript, and Prettier.
4
4
 
5
- [![Version](https://img.shields.io/npm/v/@dkshs/eslint-config)](https://www.npmjs.com/package/@dkshs/eslint-config)
5
+ [![Version](https://img.shields.io/npm/v/@ncontiero/eslint-config)](https://www.npmjs.com/package/@ncontiero/eslint-config)
6
6
  [![License](https://img.shields.io/badge/licence-MIT-blue)](https://github.com/ncontiero/eslint-config/blob/master/LICENSE)
7
7
 
8
8
  ## Features
@@ -18,19 +18,12 @@ Nicolas's ESLint config preset for JavaScript, TypeScript, and Prettier.
18
18
  - Optional [React](https://react.dev/), [NextJs](https://nextjs.org/), [TailwindCSS](https://tailwindcss.com/), [TanStack Query](https://tanstack.com/query/) support.
19
19
  - Requires ESLint v9.20.0+.
20
20
 
21
- > [!IMPORTANT]
22
- > Since v2.2.0, this config is rewritten to the new [ESLint Flat config](https://eslint.org/docs/latest/use/configure/configuration-files-new), check the [release note](https://github.com/ncontiero/eslint-config/releases/tag/v2.2.0) for more details.
23
- >
24
- > Since v3.0.0, ESLint v9.5.0+ is now required.
25
- >
26
- > Since v4.2.0, ESLint v9.20.0+ is now required.
27
-
28
21
  ## Usage
29
22
 
30
23
  1. Install the dependencies:
31
24
 
32
25
  ```bash
33
- npm i -D eslint @dkshs/eslint-config
26
+ npm i -D eslint @ncontiero/eslint-config
34
27
  ```
35
28
 
36
29
  > Require Node.js >= 18.18, and ESLint >= 9.20.0.
@@ -39,7 +32,7 @@ npm i -D eslint @dkshs/eslint-config
39
32
 
40
33
  ```mjs
41
34
  // eslint.config.mjs
42
- import { ncontiero } from "@dkshs/eslint-config";
35
+ import { ncontiero } from "@ncontiero/eslint-config";
43
36
 
44
37
  export default ncontiero(
45
38
  // Features: it'll detect installed dependency and enable necessary features automatically
@@ -111,13 +104,11 @@ Add the following settings to your `.vscode/settings.json`:
111
104
 
112
105
  ## Customization
113
106
 
114
- Since v2.2, we migrated to [ESLint Flat config](https://eslint.org/docs/latest/use/configure/configuration-files-new). It provides much better organization and composition.
115
-
116
- Normally you only need to import the `dkshs` preset:
107
+ Normally you only need to import the `ncontiero` preset:
117
108
 
118
109
  ```js
119
110
  // eslint.config.js
120
- import { ncontiero } from "@dkshs/eslint-config";
111
+ import { ncontiero } from "@ncontiero/eslint-config";
121
112
 
122
113
  export default ncontiero();
123
114
  ```
@@ -126,7 +117,7 @@ And that's it! Or you can configure each integration individually, for example:
126
117
 
127
118
  ```js
128
119
  // eslint.config.js
129
- import { ncontiero } from "@dkshs/eslint-config";
120
+ import { ncontiero } from "@ncontiero/eslint-config";
130
121
 
131
122
  export default ncontiero({
132
123
  // TypeScript, React, NextJs, TailwindCSS and TanStack Query are auto-detected,
@@ -150,11 +141,11 @@ export default ncontiero({
150
141
  });
151
142
  ```
152
143
 
153
- The `dkshs` factory function also accepts any number of arbitrary custom config overrides:
144
+ The `ncontiero` factory function also accepts any number of arbitrary custom config overrides:
154
145
 
155
146
  ```js
156
147
  // eslint.config.js
157
- import { ncontiero } from "@dkshs/eslint-config";
148
+ import { ncontiero } from "@ncontiero/eslint-config";
158
149
 
159
150
  export default ncontiero(
160
151
  {
@@ -179,7 +170,7 @@ Certain rules would only be enabled in specific files, for example, `ts/*` rules
179
170
 
180
171
  ```js
181
172
  // eslint.config.js
182
- import { ncontiero } from "@dkshs/eslint-config";
173
+ import { ncontiero } from "@ncontiero/eslint-config";
183
174
 
184
175
  export default ncontiero({
185
176
  typescript: {
@@ -206,7 +197,7 @@ To enable TanStack Query support, you need to have the package installed or expl
206
197
 
207
198
  ```js
208
199
  // eslint.config.js
209
- import { ncontiero } from "@dkshs/eslint-config";
200
+ import { ncontiero } from "@ncontiero/eslint-config";
210
201
 
211
202
  export default ncontiero({
212
203
  reactQuery: true,