Skip to content

Commit 1f96ea5

Browse files
authored
added eslint-plugin-jsdoc (#2646)
* added eslint-plugin-jsdoc * do not auto create empty jsdoc palceholders * only add the plugin for ts files * move rules to ts only too * applied the plugin * apply plugin after merge * fix adapter export * format * fix formatting of code examples * format
1 parent d43a9a0 commit 1f96ea5

39 files changed

+632
-142
lines changed

.eslintrc.json

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -90,9 +90,13 @@
9090
"**/*.tsx"
9191
],
9292
"extends": [
93-
"plugin:@typescript-eslint/recommended"
93+
"plugin:@typescript-eslint/recommended",
94+
"plugin:jsdoc/recommended-typescript"
9495
],
9596
"rules": {
97+
"jsdoc/require-returns": 0,
98+
"jsdoc/tag-lines": ["error", "never", { "startLines": 1 }],
99+
"jsdoc/no-blank-blocks": ["error", { "enableFixer": true }],
96100
"@typescript-eslint/no-parameter-properties": "off",
97101
"@typescript-eslint/no-explicit-any": "off",
98102
"@typescript-eslint/no-use-before-define": [

package-lock.json

Lines changed: 220 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -58,6 +58,7 @@
5858
"cpy-cli": "^4.2.0",
5959
"eslint": "^8.56.0",
6060
"eslint-config-prettier": "^9.1.0",
61+
"eslint-plugin-jsdoc": "^48.2.1",
6162
"eslint-plugin-prettier": "^5.1.3",
6263
"fs-extra": "^11.1.0",
6364
"get-spdx-license-ids": "^2.1.0",

0 commit comments

Comments
 (0)