@ffflorian/eslint-config 0.14.0 → 0.14.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.
Files changed (2) hide show
  1. package/README.md +24 -9
  2. package/package.json +5 -3
package/README.md CHANGED
@@ -1,20 +1,35 @@
1
- ## @ffflorian/eslint-config [![npm version](https://img.shields.io/npm/v/@ffflorian/eslint-config.svg)](https://npmjs.com/package/@ffflorian/eslint-config)
1
+ # @ffflorian/eslint-config [![npm version](https://img.shields.io/npm/v/@ffflorian/eslint-config.svg)](https://npmjs.com/package/@ffflorian/eslint-config)
2
2
 
3
- > @ffflorian's personal [eslint](https://eslint.org/) configuration.
3
+ Opinionated ESLint flat config for JavaScript and TypeScript projects.
4
4
 
5
- ### Usage
5
+ ## What Is Included
6
6
 
7
- **Install**:
7
+ - ESLint recommended rules
8
+ - TypeScript ESLint recommended rules
9
+ - Import plugin rules (including TypeScript import resolution)
10
+ - Oxc lint recommended rules
11
+ - Perfectionist alphabetical sorting rules
12
+ - Browser and Node globals
8
13
 
14
+ ## Installation
15
+
16
+ ```bash
17
+ yarn add -D eslint @ffflorian/eslint-config
9
18
  ```
10
- yarn add -D @ffflorian/eslint-config-react
11
- ```
12
19
 
13
- **Edit `eslint.config.ts`**:
20
+ ## Usage
21
+
22
+ Create or update `eslint.config.ts`:
14
23
 
15
24
  ```ts
16
25
  import config from '@ffflorian/eslint-config';
17
- import {Config, defineConfig} from 'eslint/config';
26
+ import {defineConfig} from 'eslint/config';
18
27
 
19
- export default defineConfig([config as Config]);
28
+ export default defineConfig([config]);
20
29
  ```
30
+
31
+ ## Notes
32
+
33
+ - This package is built for ESLint flat config (`eslint.config.*`).
34
+ - The config already includes TypeScript support via `typescript-eslint`.
35
+ - If your project uses custom path aliases, ensure your TypeScript config is set up so import resolution works as expected.
package/package.json CHANGED
@@ -32,7 +32,9 @@
32
32
  "fix": "yarn lint --fix",
33
33
  "lint": "eslint -c index.ts ."
34
34
  },
35
- "repository": "https://github.com/ffflorian/config",
36
- "version": "0.14.0",
37
- "gitHead": "d7266eaf6c23160bee5b28ec92b37de6b6f7a77f"
35
+ "repository": {
36
+ "type": "git",
37
+ "url": "git+https://github.com/ffflorian/config.git"
38
+ },
39
+ "version": "0.14.1"
38
40
  }