From e30d7f3e27336258f1027d1c1ae94c3d15668066 Mon Sep 17 00:00:00 2001 From: Hsieh Chin Fan Date: Sat, 28 Sep 2024 22:58:20 +0800 Subject: chore: add lint for jsdoc --- eslint.config.js | 12 +++++++++++- package.json | 1 + 2 files changed, 12 insertions(+), 1 deletion(-) diff --git a/eslint.config.js b/eslint.config.js index 8887ce7..7ac6782 100644 --- a/eslint.config.js +++ b/eslint.config.js @@ -3,6 +3,7 @@ import js from "@eslint/js"; import importPlugin from "eslint-plugin-import"; import promisePlugin from "eslint-plugin-promise"; import nodePlugin from "eslint-plugin-node"; +import jsdoc from 'eslint-plugin-jsdoc'; export default [ js.configs.recommended, @@ -35,5 +36,14 @@ export default [ 'array-callback-return': 'error', 'no-unexpected-multiline': 'warn', }, - } + }, + { + files: ['src/*js'], + plugins: { + jsdoc, + }, + rules: { + 'jsdoc/require-description': 'warn' + } + }, ]; diff --git a/package.json b/package.json index 2867ed4..1d84a84 100644 --- a/package.json +++ b/package.json @@ -39,6 +39,7 @@ "@rollup/plugin-terser": "^0.4.4", "eslint": "^9.10.0", "eslint-plugin-import": "^2.30.0", + "eslint-plugin-jsdoc": "^50.3.0", "eslint-plugin-node": "^11.1.0", "eslint-plugin-promise": "^7.1.0", "globals": "^15.9.0", -- cgit v1.2.3-70-g09d2