feat: add allowLabels option to no-missing-label-refs (#513)

* feat: add ignoreLabels option to no-missing-label-refs

* rename ignoreLabels -> allowLabels

* add GFM task list test case

Author: jaymarvelz

docs/rules/no-missing-label-refs.md

@@ -30,6 +30,24 @@ Examples of **incorrect** code for this rule:
 [eslint]
 ```
 
+## Options
+
+The following options are available on this rule:
+
+* `allowLabels: Array<string>` - labels to allow when checking for missing label references. (default: `[]`)
+
+Examples of **correct** code when configured as `"no-missing-label-refs": ["error", { allowLabels: ["eslint"] }]`:
+
+```markdown
+<!-- eslint markdown/no-missing-label-refs: ["error", { allowLabels: ["eslint"] }] -->
+
+[ESLint][eslint]
+
+[eslint][]
+
+[eslint]
+```
+
 ## When Not to Use It
 
 If you aren't concerned with missing label references, you can safely disable this rule.

src/rules/no-missing-label-refs.js

@@ -18,7 +18,7 @@ import { findOffsets, illegalShorthandTailPattern } from "../util.js";
  * @import { Text } from "mdast";
  * @import { MarkdownRuleDefinition } from "../types.js";
  * @typedef {"notFound"} NoMissingLabelRefsMessageIds
- * @typedef {[]} NoMissingLabelRefsOptions
+ * @typedef {[{ allowLabels?: string[] }]} NoMissingLabelRefsOptions
  * @typedef {MarkdownRuleDefinition<{ RuleOptions: NoMissingLabelRefsOptions, MessageIds: NoMissingLabelRefsMessageIds }>} NoMissingLabelRefsRuleDefinition
  */
 
@@ -119,13 +119,36 @@ export default {
 			url: "https://github.com/eslint/markdown/blob/main/docs/rules/no-missing-label-refs.md",
 		},
 
+		schema: [
+			{
+				type: "object",
+				properties: {
+					allowLabels: {
+						type: "array",
+						items: {
+							type: "string",
+						},
+						uniqueItems: true,
+					},
+				},
+				additionalProperties: false,
+			},
+		],
+
+		defaultOptions: [
+			{
+				allowLabels: [],
+			},
+		],
+
 		messages: {
 			notFound: "Label reference '{{label}}' not found.",
 		},
 	},
 
 	create(context) {
 		const { sourceCode } = context;
+		const allowLabels = new Set(context.options[0].allowLabels);
 
 		/** @type {Array<{label:string,position:Position}>} */
 		let allMissingReferences = [];
@@ -144,9 +167,16 @@ export default {
 			},
 
 			text(node) {
-				allMissingReferences.push(
-					...findMissingReferences(node, sourceCode.getText(node)),
+				const missingReferences = findMissingReferences(
+					node,
+					sourceCode.getText(node),
 				);
+
+				for (const missingReference of missingReferences) {
+					if (!allowLabels.has(missingReference.label)) {
+						allMissingReferences.push(missingReference);
+					}
+				}
 			},
 
 			definition(node) {

tests/rules/no-missing-label-refs.test.js

@@ -10,6 +10,7 @@
 import rule from "../../src/rules/no-missing-label-refs.js";
 import markdown from "../../src/index.js";
 import { Linter, RuleTester } from "eslint";
+import dedent from "dedent";
 
 //------------------------------------------------------------------------------
 // Tests
@@ -89,6 +90,46 @@ ruleTester.run("no-missing-label-refs", rule, {
 		`[escaped${"\\".repeat(3)}][escaped${"\\".repeat(3)}]`,
 		`[escaped${"\\".repeat(5)}][escaped${"\\".repeat(5)}]`,
 		`[escaped${"\\".repeat(7)}][escaped${"\\".repeat(7)}]`,
+		{
+			code: "[foo][bar]",
+			options: [{ allowLabels: ["bar"] }],
+		},
+		{
+			code: "![foo][bar]",
+			options: [{ allowLabels: ["bar"] }],
+		},
+		{
+			code: "[foo][]",
+			options: [{ allowLabels: ["foo"] }],
+		},
+		{
+			code: "![foo][]",
+			options: [{ allowLabels: ["foo"] }],
+		},
+		{
+			code: "[foo]",
+			options: [{ allowLabels: ["foo"] }],
+		},
+		{
+			code: "![foo]",
+			options: [{ allowLabels: ["foo"] }],
+		},
+		{
+			code: "[foo]\n[bar]",
+			options: [{ allowLabels: ["foo", "bar"] }],
+		},
+		{
+			code: "[Foo][]\n[Bar][]",
+			options: [{ allowLabels: ["Foo", "Bar"] }],
+		},
+		{
+			code: dedent`
+			- [x] Checked
+			- [-] In progress
+			`,
+			language: "markdown/gfm",
+			options: [{ allowLabels: ["-"] }],
+		},
 	],
 	invalid: [
 		{
@@ -546,6 +587,90 @@ ruleTester.run("no-missing-label-refs", rule, {
 				},
 			],
 		},
+		{
+			code: "[foo][bar]",
+			options: [{ allowLabels: ["baz"] }],
+			errors: [
+				{
+					messageId: "notFound",
+					data: { label: "bar" },
+					line: 1,
+					column: 7,
+					endLine: 1,
+					endColumn: 10,
+				},
+			],
+		},
+		{
+			code: "![foo][bar]",
+			options: [{ allowLabels: ["foo"] }],
+			errors: [
+				{
+					messageId: "notFound",
+					data: { label: "bar" },
+					line: 1,
+					column: 8,
+					endLine: 1,
+					endColumn: 11,
+				},
+			],
+		},
+		{
+			code: "[foo][]",
+			options: [{ allowLabels: ["bar"] }],
+			errors: [
+				{
+					messageId: "notFound",
+					data: { label: "foo" },
+					line: 1,
+					column: 2,
+					endLine: 1,
+					endColumn: 5,
+				},
+			],
+		},
+		{
+			code: "[foo]\n[bar]",
+			options: [{ allowLabels: ["foo"] }],
+			errors: [
+				{
+					messageId: "notFound",
+					data: { label: "bar" },
+					line: 2,
+					column: 2,
+					endLine: 2,
+					endColumn: 5,
+				},
+			],
+		},
+		{
+			code: "[Foo][]",
+			options: [{ allowLabels: ["foo"] }],
+			errors: [
+				{
+					messageId: "notFound",
+					data: { label: "Foo" },
+					line: 1,
+					column: 2,
+					endLine: 1,
+					endColumn: 5,
+				},
+			],
+		},
+		{
+			code: "[Foo][foo]\n[Bar][]",
+			options: [{ allowLabels: ["Bar"] }],
+			errors: [
+				{
+					messageId: "notFound",
+					data: { label: "foo" },
+					line: 1,
+					column: 7,
+					endLine: 1,
+					endColumn: 10,
+				},
+			],
+		},
 	],
 });