From f207cdcb1542e89b3b61eaa21853a8c09842816e Mon Sep 17 00:00:00 2001 From: ikopeykin Date: Tue, 16 Jul 2019 19:25:45 +0300 Subject: [PATCH] remove valid jsdoc rule in favour of eslint-plugin-jsdoc --- .eslintrc.js | 41 ++++++++++++++++++------------------ lib/debug/ProfilingPlugin.js | 2 +- 2 files changed, 21 insertions(+), 22 deletions(-) diff --git a/.eslintrc.js b/.eslintrc.js index d2aaef6b9..8f7b5b042 100644 --- a/.eslintrc.js +++ b/.eslintrc.js @@ -33,24 +33,6 @@ module.exports = { "no-loop-func": "warn", indent: "off", "no-console": "off", - "valid-jsdoc": [ - "error", - { - prefer: { - return: "returns", - prop: "property", - memberof: "DONTUSE", - class: "DONTUSE", - inheritdoc: "DONTUSE", - description: "DONTUSE", - readonly: "DONTUSE" - }, - preferType: { - "*": "any" - }, - requireReturnType: true - } - ], "node/no-unsupported-features": "error", "node/no-deprecated-api": "error", "node/no-missing-import": "error", @@ -59,7 +41,15 @@ module.exports = { "node/no-unpublished-require": "error", "node/process-exit-as-throw": "error", "jsdoc/require-hyphen-before-param-description": ["error", "never"], - "jsdoc/check-tag-names": "error" + "jsdoc/check-tag-names": "error", + "jsdoc/check-param-names": "error", + "jsdoc/require-param-description": "error", + "jsdoc/require-param-name": "error", + "jsdoc/require-param-type": "error", + "jsdoc/require-param": "error", + "jsdoc/require-returns-description": "error", + "jsdoc/require-returns-type": "error", + "jsdoc/require-returns": "error" }, settings: { jsdoc: { @@ -72,8 +62,17 @@ module.exports = { return acc; }, {})), extends: "extends", - constructor: "constructor" - } + return: "returns", + constructor: "constructor", + prop: "property", + arg: "param", + augments: "extends", + description: false, + desc: false, + inheritdoc: false, + class: false + }, + overrideReplacesDocs: false } }, overrides: [ diff --git a/lib/debug/ProfilingPlugin.js b/lib/debug/ProfilingPlugin.js index 561b56f2d..270d6eeb2 100644 --- a/lib/debug/ProfilingPlugin.js +++ b/lib/debug/ProfilingPlugin.js @@ -78,8 +78,8 @@ class Profiler { } /** + * an object that wraps Tracer and Profiler with a counter * @typedef {Object} Trace - * @description an object that wraps Tracer and Profiler with a counter * @property {Tracer} trace instance of Tracer * @property {number} counter Counter * @property {Profiler} profiler instance of Profiler