feat: add jsdoc plugin

antfu · Sep 12, 2023 · 309249f · 309249f
1 parent eab00e2
commit 309249f
Show file tree

Hide file tree

Showing 3 changed files with 60 additions and 21 deletions.
diff --git a/packages/eslint-config-basic/index.js b/packages/eslint-config-basic/index.js
@@ -16,6 +16,7 @@ module.exports = {
     'plugin:jsonc/recommended-with-jsonc',
     'plugin:yml/standard',
     'plugin:markdown/recommended',
+    'plugin:jsdoc/recommended',
   ],
   ignorePatterns: [
     '*.min.*',
@@ -55,6 +56,7 @@ module.exports = {
     'antfu',
     'no-only-tests',
     'unused-imports',
+    'jsdoc',
   ],
   settings: {
     'import/resolver': {
@@ -407,11 +409,17 @@ module.exports = {
     'yml/quotes': ['error', { prefer: 'single', avoidEscape: false }],
     'yml/no-empty-document': 'off',
 
+    // jsdoc
+    'jsdoc/require-jsdoc': 'off',
+    'jsdoc/require-param-type': 'off',
+    'jsdoc/require-param-description': 'off',
+    'jsdoc/require-yields': 'off',
+    'jsdoc/tag-lines': 'off',
+
     // antfu
     'antfu/no-import-node-modules-by-path': 'error',
     'antfu/if-newline': 'error',
     'antfu/import-dedupe': 'error',
     'antfu/top-level-function': 'error',
-    // 'antfu/prefer-inline-type-import': 'error',
   },
 }
diff --git a/packages/eslint-config-basic/package.json b/packages/eslint-config-basic/package.json
@@ -23,6 +23,7 @@
     "eslint-plugin-eslint-comments": "^3.2.0",
     "eslint-plugin-html": "^7.1.0",
     "eslint-plugin-import": "npm:eslint-plugin-i@2.28.0-2",
+    "eslint-plugin-jsdoc": "^46.6.0",
     "eslint-plugin-jsonc": "^2.9.0",
     "eslint-plugin-markdown": "^3.0.1",
     "eslint-plugin-n": "^16.0.2",

diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml