@sxzz/eslint-config 3.0.0-beta.4 → 3.0.0-beta.6

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 +27 -0
  2. package/package.json +14 -14
package/README.md CHANGED
@@ -4,12 +4,39 @@ Flat ESLint config for JavaScript, TypeScript, Vue 2, Vue 3, Prettier.
4
4
 
5
5
  [Legacy Version](https://github.com/sxzz/eslint-config-legacy)
6
6
 
7
+ ## Features
8
+
9
+ - Support Vue 2 and 3 out-of-box.
10
+ - Select the required file types as needed.
11
+ - Support JSON(5), YAML, Markdown...
12
+
7
13
  ## Install
8
14
 
9
15
  ```bash
10
16
  npm i @sxzz/eslint-config
11
17
  ```
12
18
 
19
+ ## Usage
20
+
21
+ ```js
22
+ // eslint.config.js
23
+ import { all } from '@sxzz/eslint-config'
24
+
25
+ export default defineFlatConfig(all)
26
+ ```
27
+
28
+ ### Custom Config
29
+
30
+ ```js
31
+ import { sxzz } from '@sxzz/eslint-config'
32
+ export default sxzz(
33
+ [
34
+ /* your custom config */
35
+ ],
36
+ { vue: true, prettier: true, markdown: true }
37
+ )
38
+ ```
39
+
13
40
  ## Sponsors
14
41
 
15
42
  <p align="center">
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@sxzz/eslint-config",
3
- "version": "3.0.0-beta.4",
4
- "packageManager": "pnpm@7.27.0",
3
+ "version": "3.0.0-beta.6",
4
+ "packageManager": "pnpm@8.2.0",
5
5
  "description": "ESLint config for @sxzz.",
6
6
  "type": "module",
7
7
  "license": "MIT",
@@ -33,32 +33,32 @@
33
33
  "eslint": "^8.0.0"
34
34
  },
35
35
  "dependencies": {
36
- "@eslint/js": "^8.36.0",
37
- "@typescript-eslint/eslint-plugin": "^5.56.0",
38
- "@typescript-eslint/parser": "^5.56.0",
36
+ "@eslint/js": "^8.38.0",
37
+ "@typescript-eslint/eslint-plugin": "^5.58.0",
38
+ "@typescript-eslint/parser": "^5.58.0",
39
39
  "eslint-config-prettier": "^8.8.0",
40
- "eslint-plugin-antfu": "^0.38.2",
40
+ "eslint-define-config": "^1.18.0",
41
+ "eslint-plugin-antfu": "^0.38.4",
41
42
  "eslint-plugin-eslint-comments": "^3.2.0",
42
43
  "eslint-plugin-import": "^2.27.5",
43
44
  "eslint-plugin-jsonc": "^2.7.0",
44
45
  "eslint-plugin-markdown": "^3.0.0",
45
46
  "eslint-plugin-prettier": "^4.2.1",
46
47
  "eslint-plugin-unicorn": "^46.0.0",
47
- "eslint-plugin-vue": "^9.9.0",
48
+ "eslint-plugin-vue": "^9.11.0",
48
49
  "eslint-plugin-yml": "^1.5.0",
49
50
  "globals": "^13.20.0",
50
51
  "jsonc-eslint-parser": "^2.2.0",
51
52
  "local-pkg": "^0.4.3",
52
- "prettier": "^2.8.6",
53
- "vue-eslint-parser": "^9.1.0",
53
+ "prettier": "^2.8.7",
54
+ "vue-eslint-parser": "^9.1.1",
54
55
  "yaml-eslint-parser": "^1.2.0"
55
56
  },
56
57
  "devDependencies": {
57
- "@types/node": "^18.15.5",
58
- "bumpp": "^9.0.0",
59
- "eslint": "^8.36.0",
60
- "eslint-define-config": "^1.17.0",
61
- "typescript": "^5.0.2"
58
+ "@types/node": "^18.15.11",
59
+ "bumpp": "^9.1.0",
60
+ "eslint": "^8.38.0",
61
+ "typescript": "^5.0.4"
62
62
  },
63
63
  "engines": {
64
64
  "node": ">=14.19.0"