From 82a0db863822ee81465bbfcf5077823551c3fc4e Mon Sep 17 00:00:00 2001 From: Kai Cataldo Date: Fri, 27 Sep 2019 23:16:24 -0400 Subject: [PATCH] Chore: enable eslint-plugin-jsdoc (refs #11146) --- lib/linter/code-path-analysis/debug-helpers.js | 2 +- package.json | 1 + packages/eslint-config-eslint/default.yml | 4 +++- packages/eslint-config-eslint/package.json | 1 + 4 files changed, 6 insertions(+), 2 deletions(-) diff --git a/lib/linter/code-path-analysis/debug-helpers.js b/lib/linter/code-path-analysis/debug-helpers.js index 9af985ce85f..2ca6dbc1e52 100644 --- a/lib/linter/code-path-analysis/debug-helpers.js +++ b/lib/linter/code-path-analysis/debug-helpers.js @@ -21,7 +21,7 @@ const debug = require("debug")("eslint:code-path"); * @returns {string} Id of the segment. */ /* istanbul ignore next */ -function getId(segment) { // eslint-disable-line require-jsdoc +function getId(segment) { // eslint-disable-line jsdoc/require-jsdoc return segment.id + (segment.reachable ? "" : "!"); } diff --git a/package.json b/package.json index 9ce1c59b0d9..fa38b0792f8 100644 --- a/package.json +++ b/package.json @@ -96,6 +96,7 @@ "eslint-config-eslint": "file:packages/eslint-config-eslint", "eslint-plugin-eslint-plugin": "^2.0.1", "eslint-plugin-internal-rules": "file:tools/internal-rules", + "eslint-plugin-jsdoc": "^15.9.5", "eslint-plugin-node": "^9.0.0", "eslint-release": "^1.2.0", "eslump": "^2.0.0", diff --git a/packages/eslint-config-eslint/default.yml b/packages/eslint-config-eslint/default.yml index 526ce5600ef..319d695a7cc 100644 --- a/packages/eslint-config-eslint/default.yml +++ b/packages/eslint-config-eslint/default.yml @@ -1,6 +1,8 @@ extends: - "eslint:recommended" - "plugin:node/recommended" +plugins: + - "jsdoc" rules: array-bracket-spacing: "error" array-callback-return: "error" @@ -31,6 +33,7 @@ rules: generator-star-spacing: "error" guard-for-in: "error" handle-callback-err: ["error", "err"] + jsdoc/require-jsdoc: "error" key-spacing: ["error", { beforeColon: false, afterColon: true }] keyword-spacing: "error" lines-around-comment: ["error", { @@ -154,7 +157,6 @@ rules: quotes: ["error", "double", {avoidEscape: true}] quote-props: ["error", "as-needed"] radix: "error" - require-jsdoc: "error" require-unicode-regexp: "error" rest-spread-spacing: "error" semi: "error" diff --git a/packages/eslint-config-eslint/package.json b/packages/eslint-config-eslint/package.json index 514dbb7ca42..48bfb65f50a 100644 --- a/packages/eslint-config-eslint/package.json +++ b/packages/eslint-config-eslint/package.json @@ -20,6 +20,7 @@ "homepage": "https://eslint.org", "bugs": "https://github.com/eslint/eslint/issues/", "peerDependencies": { + "eslint-plugin-jsdoc": "^15.9.5", "eslint-plugin-node": "^9.0.0" }, "keywords": [