@zayne-labs/eslint-config 0.2.5 → 0.2.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 CHANGED
@@ -321,7 +321,7 @@ When you want to override rules, or disable them inline, you need to update to t
321
321
 
322
322
  ```diff
323
323
  -// eslint-disable-next-line @typescript-eslint/consistent-type-definitions
324
- +// eslint-disable-next-line ts/consistent-type-definitions
324
+ +// eslint-disable-next-line ts-eslint/consistent-type-definitions
325
325
  type foo = { bar: 2 }
326
326
  ```
327
327
 
@@ -345,7 +345,7 @@ export default zayne()
345
345
 
346
346
  ### Rules Overrides
347
347
 
348
- Certain rules would only be enabled in specific files, for example, `ts/*` rules would only be enabled in `.ts` files and `vue/*` rules would only be enabled in `.vue` files. If you want to override the rules, you need to specify the file extension:
348
+ Certain rules would only be enabled in specific files, for example, `ts-eslint/*` rules would only be enabled in `.ts` files and `vue/*` rules would only be enabled in `.vue` files. If you want to override the rules, you need to specify the file extension:
349
349
 
350
350
  ```js
351
351
  // eslint.config.js
@@ -428,7 +428,7 @@ export default zayne()
428
428
 
429
429
  #### React
430
430
 
431
- To enable React support, you need to explicitly turn it on:
431
+ React support is auto-detected from installed dependencies. You can also explicitly turn it on:
432
432
 
433
433
  ```js
434
434
  // eslint.config.js
@@ -439,10 +439,10 @@ export default zayne({
439
439
  })
440
440
  ```
441
441
 
442
- Running `npx eslint` should prompt you to install the required dependencies, otherwise, you can install them manually:
442
+ Running `pnpm eslint` should prompt you to install the required dependencies, otherwise, you can install them manually:
443
443
 
444
444
  ```bash
445
- npm i -D @eslint-react/eslint-plugin eslint-plugin-react-hooks eslint-plugin-react-refresh
445
+ pnpm i -D @eslint-react/eslint-plugin eslint-plugin-react-hooks eslint-plugin-react-refresh
446
446
  ```
447
447
 
448
448
  #### Svelte
@@ -458,10 +458,10 @@ export default zayne({
458
458
  })
459
459
  ```
460
460
 
461
- Running `npx eslint` should prompt you to install the required dependencies, otherwise, you can install them manually:
461
+ Running `pnpm eslint` should prompt you to install the required dependencies, otherwise, you can install them manually:
462
462
 
463
463
  ```bash
464
- npm i -D eslint-plugin-svelte
464
+ pnpm i -D eslint-plugin-svelte
465
465
  ```
466
466
 
467
467
  #### Astro
@@ -477,10 +477,10 @@ export default zayne({
477
477
  })
478
478
  ```
479
479
 
480
- Running `npx eslint` should prompt you to install the required dependencies, otherwise, you can install them manually:
480
+ Running `pnpm eslint` should prompt you to install the required dependencies, otherwise, you can install them manually:
481
481
 
482
482
  ```bash
483
- npm i -D eslint-plugin-astro
483
+ pnpm i -D eslint-plugin-astro
484
484
  ```
485
485
 
486
486
  #### Solid
@@ -496,10 +496,10 @@ export default zayne({
496
496
  })
497
497
  ```
498
498
 
499
- Running `npx eslint` should prompt you to install the required dependencies, otherwise, you can install them manually:
499
+ Running `pnpm eslint` should prompt you to install the required dependencies, otherwise, you can install them manually:
500
500
 
501
501
  ```bash
502
- npm i -D eslint-plugin-solid
502
+ pnpm i -D eslint-plugin-solid
503
503
  ```
504
504
 
505
505
  #### tailwindcss
@@ -515,10 +515,10 @@ export default zayne({
515
515
  })
516
516
  ```
517
517
 
518
- Running `npx eslint` should prompt you to install the required dependencies, otherwise, you can install them manually:
518
+ Running `pnpm eslint` should prompt you to install the required dependencies, otherwise, you can install them manually:
519
519
 
520
520
  ```bash
521
- npm i -D eslint-plugin-tailwindcss
521
+ pnpm i -D eslint-plugin-tailwindcss
522
522
  ```
523
523
 
524
524
 
@@ -541,12 +541,12 @@ export default zayne({
541
541
  ## View what rules are enabled
542
542
 
543
543
  Eslint config inspecctor is visual tool to help you view what rules are enabled in your project and apply them to what files, [@eslint/config-inspector](https://github.com/eslint/config-inspector).
544
- It was built by the legendary Anthony Fu.
544
+ It was built by the legendary [Anthony Fu](https://github.com/antfu).
545
545
 
546
546
  Go to your project root that contains `eslint.config.js` and run:
547
547
 
548
548
  ```bash
549
- npx @eslint/config-inspector
549
+ pnpx @eslint/config-inspector@latest
550
550
  ```
551
551
 
552
552
  ## Versioning Policy