@aiou/eslint-config 0.11.2 → 1.0.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,12 +1,14 @@
1
1
  # @aiou/eslint-config
2
- *my eslint config*
2
+ *my flat eslint config*
3
3
 
4
4
  [![npm](https://img.shields.io/npm/v/@aiou/eslint-config)](https://www.npmjs.com/package/@aiou/eslint-config) [![GitHub](https://img.shields.io/npm/l/@aiou/eslint-config)](https://github.com/JiangWeixian/eslint-config/tree/master/packages/default)
5
5
 
6
6
  ## features
7
7
 
8
- - 🙈 built in ignore patterns from [nodejs's gitignore](https://github.com/github/gitignore/blob/master/Node.gitignore) and with common eslint ignore patterns like `jest`, etc..
9
- - 💅 friendly fix reporter
8
+ - Common ignore patterns from [nodejs's gitignore](https://github.com/github/gitignore/blob/master/Node.gitignore)
9
+ - Support typescript, yaml, jsonc, markdown, etc..
10
+ - Built-in best practices react rules, react-refresh and ssr-friendly rules...
11
+ - Friendly fix reporter
10
12
 
11
13
  <div align='center'>
12
14
 
@@ -15,16 +17,33 @@
15
17
  *▲ @aiou/eslint-plugin-progress*
16
18
 
17
19
  </div>
20
+
21
+ ## install
22
+
23
+ ```console
24
+ npm install @aiou/eslint-config --save-dev
25
+ ```
26
+
27
+ ## usage
28
+
29
+ in `eslint.config.js`
30
+
31
+ ```js
32
+ const { aiou } = require('@aiou/eslint-config')
33
+
34
+ module.exports = aiou()
35
+ ```
18
36
 
19
37
  ## rules
20
38
 
21
39
  extends from
22
40
 
23
- ```tsx
41
+ ```console
24
42
  eslint-config-standard
25
43
  eslint-plugin-eslint-comments
26
44
  eslint-plugin-html
27
- eslint-plugin-import
45
+ eslint-plugin-i
46
+ eslint-plugin-regexp
28
47
  eslint-plugin-markdown
29
48
  eslint-plugin-simple-import-sort
30
49
  eslint-plugin-import-newlines
@@ -42,20 +61,3 @@ eslint-plugin-react-hooks
42
61
  eslint-plugin-tailwindcss
43
62
  @typescript-eslint/eslint-plugin
44
63
  ```
45
-
46
- ## install
47
-
48
- ```console
49
- npm install @aiou/eslint-config --save-dev
50
- ```
51
-
52
- ## usage
53
-
54
- in `.eslintrc.js`
55
-
56
- ```
57
- module.exports = {
58
- "extends": ["@aiou"]
59
- }
60
- ```
61
-