From 411dcd1b443342f8828789d4dfc3e6203623cd6e Mon Sep 17 00:00:00 2001 From: DerZyklop Date: Thu, 14 Oct 2021 16:53:02 +0200 Subject: [PATCH 1/2] Add a url to rule docs When developers hover a warning/error in VSCode (and probably other code editors too) they get the description of the warning, plus the name of the rule. If docs.url is set, the Rule-Name is linked to the description page of the rule. --- lib/rules/ticket-ref.js | 1 + 1 file changed, 1 insertion(+) diff --git a/lib/rules/ticket-ref.js b/lib/rules/ticket-ref.js index 0c5a166..a39fb14 100644 --- a/lib/rules/ticket-ref.js +++ b/lib/rules/ticket-ref.js @@ -81,6 +81,7 @@ module.exports = { description: "Require a ticket reference in the TODO comment", category: "Fill me in", recommended: false, + url: 'https://github.com/sawyerh/eslint-plugin-todo-plz/blob/main/README.md', }, fixable: null, // or "code" or "whitespace" messages, From f0932006603d198f64552a97d79a7cc609dbb6ba Mon Sep 17 00:00:00 2001 From: Sawyer Hollenshead Date: Fri, 15 Oct 2021 20:36:49 -0400 Subject: [PATCH 2/2] Point to rule's documentation --- lib/rules/ticket-ref.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/rules/ticket-ref.js b/lib/rules/ticket-ref.js index a39fb14..887e5e5 100644 --- a/lib/rules/ticket-ref.js +++ b/lib/rules/ticket-ref.js @@ -81,7 +81,7 @@ module.exports = { description: "Require a ticket reference in the TODO comment", category: "Fill me in", recommended: false, - url: 'https://github.com/sawyerh/eslint-plugin-todo-plz/blob/main/README.md', + url: "https://github.com/sawyerh/eslint-plugin-todo-plz/blob/main/docs/rules/ticket-ref.md", }, fixable: null, // or "code" or "whitespace" messages,