@theholocron/eslint-config 7.22.3 → 7.23.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/dist/configs/jsdoc.d.ts +5 -0
- package/dist/configs/jsdoc.js +28 -0
- package/dist/configs/package-json.js +2 -1
- package/package.json +12 -3
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
import jsdoc from "eslint-plugin-jsdoc";
|
|
2
|
+
//#region configs/jsdoc.ts
|
|
3
|
+
function jsdocConfig() {
|
|
4
|
+
return [{
|
|
5
|
+
...jsdoc.configs["flat/recommended-typescript"],
|
|
6
|
+
name: "@theholocron/jsdoc/recommended"
|
|
7
|
+
}, {
|
|
8
|
+
name: "@theholocron/jsdoc",
|
|
9
|
+
rules: {
|
|
10
|
+
"jsdoc/require-jsdoc": ["error", {
|
|
11
|
+
publicOnly: true,
|
|
12
|
+
require: {
|
|
13
|
+
FunctionDeclaration: true,
|
|
14
|
+
MethodDefinition: false,
|
|
15
|
+
ClassDeclaration: true,
|
|
16
|
+
ArrowFunctionExpression: false,
|
|
17
|
+
FunctionExpression: false
|
|
18
|
+
}
|
|
19
|
+
}],
|
|
20
|
+
"jsdoc/require-description": "error",
|
|
21
|
+
"jsdoc/require-param-description": "error",
|
|
22
|
+
"jsdoc/require-returns-description": "error",
|
|
23
|
+
"jsdoc/tag-lines": ["error", "never"]
|
|
24
|
+
}
|
|
25
|
+
}];
|
|
26
|
+
}
|
|
27
|
+
//#endregion
|
|
28
|
+
export { jsdocConfig as jsdoc, jsdocConfig };
|
|
@@ -7,7 +7,8 @@ function packageJson() {
|
|
|
7
7
|
rules: {
|
|
8
8
|
...eslintPackageJson.configs.recommended.rules,
|
|
9
9
|
"package-json/dependency-version-range": "off",
|
|
10
|
-
"package-json/no-wildcard-dependencies": "off"
|
|
10
|
+
"package-json/no-wildcard-dependencies": "off",
|
|
11
|
+
"no-irregular-whitespace": "off"
|
|
11
12
|
}
|
|
12
13
|
}];
|
|
13
14
|
}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@theholocron/eslint-config",
|
|
3
|
-
"version": "7.
|
|
3
|
+
"version": "7.23.0",
|
|
4
4
|
"description": "A ESLint configuration for writing well-formed Javascript within the Galaxy.",
|
|
5
5
|
"homepage": "https://github.com/theholocron/configs/tree/main/packages/eslint-config#readme",
|
|
6
6
|
"bugs": "https://github.com/theholocron/configs/issues",
|
|
@@ -34,8 +34,8 @@
|
|
|
34
34
|
"typescript": "^5.9.3",
|
|
35
35
|
"typescript-eslint": "^8.67.0",
|
|
36
36
|
"vitest": "^4.1.10",
|
|
37
|
-
"@theholocron/tsconfig": "7.
|
|
38
|
-
"@theholocron/vitest-config": "7.
|
|
37
|
+
"@theholocron/tsconfig": "7.23.0",
|
|
38
|
+
"@theholocron/vitest-config": "7.23.0"
|
|
39
39
|
},
|
|
40
40
|
"exports": {
|
|
41
41
|
".": {
|
|
@@ -48,6 +48,11 @@
|
|
|
48
48
|
"import": "./dist/configs/base.js",
|
|
49
49
|
"default": "./dist/configs/base.js"
|
|
50
50
|
},
|
|
51
|
+
"./jsdoc": {
|
|
52
|
+
"types": "./dist/configs/jsdoc.d.ts",
|
|
53
|
+
"import": "./dist/configs/jsdoc.js",
|
|
54
|
+
"default": "./dist/configs/jsdoc.js"
|
|
55
|
+
},
|
|
51
56
|
"./typescript": {
|
|
52
57
|
"types": "./dist/configs/typescript.d.ts",
|
|
53
58
|
"import": "./dist/configs/typescript.js",
|
|
@@ -119,6 +124,7 @@
|
|
|
119
124
|
"@vitest/eslint-plugin": "^1",
|
|
120
125
|
"eslint": "^10",
|
|
121
126
|
"eslint-plugin-cypress": "^6",
|
|
127
|
+
"eslint-plugin-jsdoc": "^50.0.0",
|
|
122
128
|
"eslint-plugin-n": "^18",
|
|
123
129
|
"eslint-plugin-react": "^7",
|
|
124
130
|
"eslint-plugin-simple-import-sort": "^14",
|
|
@@ -130,6 +136,9 @@
|
|
|
130
136
|
"@next/eslint-plugin-next": {
|
|
131
137
|
"optional": true
|
|
132
138
|
},
|
|
139
|
+
"eslint-plugin-jsdoc": {
|
|
140
|
+
"optional": true
|
|
141
|
+
},
|
|
133
142
|
"@vitest/eslint-plugin": {
|
|
134
143
|
"optional": true
|
|
135
144
|
},
|