eslint-markdown 0.9.1 → 0.10.0

package/build/configs/all.d.ts

@@ -34,6 +34,7 @@ export default function all(plugin: ESLint.Plugin): {
         readonly 'md/no-irregular-whitespace': "error";
         readonly 'md/no-tab': "error";
         readonly 'md/no-url-trailing-slash': "error";
+        readonly 'md/require-heading-id': "error";
         readonly 'md/require-image-title': "error";
         readonly 'md/require-link-title': "error";
     };

package/build/core/ast/escape-string-regexp.d.ts

@@ -0,0 +1,22 @@
+/**
+ * @fileoverview Utility to escape `RegExp` special characters.
+ * @see https://github.com/sindresorhus/escape-string-regexp/tree/v5.0.0
+ */
+/**
+ * Escape `RegExp` special characters.
+ *
+ * You can also use this to escape a string that is inserted into the middle of a regex, for example, into a character class.
+ *
+ * @param {string} string A string to escape.
+ * @returns {string} An escaped string.
+ * @example
+ * ```js
+ * import escapeStringRegexp from 'path/to/escape-string-regexp.js';
+ *
+ * const escapedString = escapeStringRegexp('How much $ for a 🦄?');
+ * //=> 'How much \\$ for a 🦄\\?'
+ *
+ * new RegExp(escapedString);
+ * ```
+ */
+export default function escapeStringRegexp(string: string): string;

package/build/core/ast/index.d.ts

@@ -1,4 +1,5 @@
+import escapeStringRegexp from './escape-string-regexp.js';
 import getElementsByTagName from './html.js';
 import isBlankLine from './is-blank-line.js';
 import SkipRanges from './skip-ranges.js';
-export { getElementsByTagName, isBlankLine, SkipRanges };
+export { escapeStringRegexp, getElementsByTagName, isBlankLine, SkipRanges };

package/build/rules/index.d.ts

@@ -9,7 +9,7 @@ declare const _default: {
     'consistent-strong-style': import("../core/types.js").RuleModule<import("./consistent-strong-style.js").RuleOptions, "style">;
     'consistent-thematic-break-style': import("../core/types.js").RuleModule<import("./consistent-thematic-break-style.js").RuleOptions, "style">;
     'consistent-unordered-list-style': import("../core/types.js").RuleModule<import("./consistent-unordered-list-style.js").RuleOptions, "style">;
-    'no-control-character': import("../core/types.js").RuleModule<import("./no-control-character.js").RuleOptions, "noControlCharacter">;
+    'no-control-character': import("../core/types.js").RuleModule<import("./no-control-character.js").RuleOptions, import("./no-control-character.js").MessageIds>;
     'no-curly-quote': import("../core/types.js").RuleModule<import("./no-curly-quote.js").RuleOptions, "noCurlyQuote">;
     'no-double-punctuation': import("../core/types.js").RuleModule<import("./no-double-punctuation.js").RuleOptions, import("./no-double-punctuation.js").MessageIds>;
     'no-double-space': import("../core/types.js").RuleModule<import("./no-double-space.js").RuleOptions, import("./no-double-space.js").MessageIds>;
@@ -19,6 +19,7 @@ declare const _default: {
     'no-irregular-whitespace': import("../core/types.js").RuleModule<import("./no-irregular-whitespace.js").RuleOptions, "noIrregularWhitespace">;
     'no-tab': import("../core/types.js").RuleModule<import("./no-tab.js").RuleOptions, "noTab">;
     'no-url-trailing-slash': import("../core/types.js").RuleModule<[], "noUrlTrailingSlash">;
+    'require-heading-id': import("../core/types.js").RuleModule<import("./require-heading-id.js").RuleOptions, import("./require-heading-id.js").MessageIds>;
     'require-image-title': import("../core/types.js").RuleModule<import("./require-image-title.js").RuleOptions, "requireImageTitle">;
     'require-link-title': import("../core/types.js").RuleModule<import("./require-link-title.js").RuleOptions, "requireLinkTitle">;
 };

package/build/rules/no-control-character.d.ts

@@ -7,6 +7,7 @@ declare const _default: {
             recommended: boolean;
             stylistic: false;
         };
+        hasSuggestions: true;
         schema: {
             type: "object";
             properties: {
@@ -43,6 +44,7 @@ declare const _default: {
         }];
         messages: {
             noControlCharacter: string;
+            suggestRemove: string;
         };
         language: string;
         dialects: string[];
@@ -52,7 +54,7 @@ declare const _default: {
         Code: import("@eslint/markdown").MarkdownSourceCode;
         RuleOptions: RuleOptions;
         Node: import("mdast").Node;
-        MessageIds: "noControlCharacter";
+        MessageIds: MessageIds;
     }>): {
         code(node: import("mdast").Code): void;
         inlineCode(node: import("mdast").InlineCode): void;
@@ -65,4 +67,4 @@ export type RuleOptions = [{
     skipCode: boolean | string[];
     skipInlineCode: boolean;
 }];
-export type MessageIds = "noControlCharacter";
+export type MessageIds = "noControlCharacter" | "suggestRemove";

package/build/rules/{heading-id.d.ts → require-heading-id.d.ts}

@@ -22,7 +22,7 @@ declare const _default: {
                 rightDelimiter: {
                     type: "string";
                 };
-                ignoreDepth: {
+                allowDepths: {
                     type: "array";
                     items: {
                         enum: number[];
@@ -36,7 +36,7 @@ declare const _default: {
         defaultOptions: ["always", {
             leftDelimiter: string;
             rightDelimiter: string;
-            ignoreDepth: never[];
+            allowDepths: never[];
         }];
         messages: {
             headingIdAlways: string;
@@ -59,7 +59,7 @@ export default _default;
 export type RuleOptions = ["always" | "never", {
     leftDelimiter: string;
     rightDelimiter: string;
-    ignoreDepth: Heading["depth"][];
+    allowDepths: Heading["depth"][];
 }];
 export type MessageIds = "headingIdAlways" | "headingIdNever";
 import type { Heading } from 'mdast';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eslint-markdown",
-  "version": "0.9.1",
+  "version": "0.10.0",
   "type": "module",
   "sideEffects": false,
   "description": "Lint your Markdown with ESLint. Additional rules for use with `@eslint/markdown`.🛠️",

package/src/configs/all.js

@@ -58,6 +58,7 @@ export default function all(plugin) {
       'md/no-irregular-whitespace': 'error',
       'md/no-tab': 'error',
       'md/no-url-trailing-slash': 'error',
+      'md/require-heading-id': 'error',
       'md/require-image-title': 'error',
       'md/require-link-title': 'error',
     },

package/src/core/ast/escape-string-regexp.js

@@ -0,0 +1,56 @@
+/**
+ * @fileoverview Utility to escape `RegExp` special characters.
+ * @see https://github.com/sindresorhus/escape-string-regexp/tree/v5.0.0
+ */
+
+/*
+ * MIT License
+ *
+ * Copyright (c) Sindre Sorhus <sindresorhus@gmail.com> (https://sindresorhus.com)
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+
+// --------------------------------------------------------------------------------
+// Export
+// --------------------------------------------------------------------------------
+
+/**
+ * Escape `RegExp` special characters.
+ *
+ * You can also use this to escape a string that is inserted into the middle of a regex, for example, into a character class.
+ *
+ * @param {string} string A string to escape.
+ * @returns {string} An escaped string.
+ * @example
+ * ```js
+ * import escapeStringRegexp from 'path/to/escape-string-regexp.js';
+ *
+ * const escapedString = escapeStringRegexp('How much $ for a 🦄?');
+ * //=> 'How much \\$ for a 🦄\\?'
+ *
+ * new RegExp(escapedString);
+ * ```
+ */
+export default function escapeStringRegexp(string) {
+  // Escape characters with special meaning either inside or outside character sets.
+  // Use a simple backslash escape when it's always valid, and a `\xnn` escape
+  // when the simpler form would be disallowed by Unicode patterns' stricter grammar.
+  return string.replace(/[|\\{}()[\]^$+*?.]/g, '\\$&').replace(/-/g, '\\x2d');
+}

package/src/core/ast/index.js

@@ -1,5 +1,6 @@
+import escapeStringRegexp from './escape-string-regexp.js';
 import getElementsByTagName from './html.js';
 import isBlankLine from './is-blank-line.js';
 import SkipRanges from './skip-ranges.js';
 
-export { getElementsByTagName, isBlankLine, SkipRanges };
+export { escapeStringRegexp, getElementsByTagName, isBlankLine, SkipRanges };

package/src/rules/index.js

@@ -14,7 +14,6 @@ import consistentStrongStyle from './consistent-strong-style.js';
 import consistentThematicBreakStyle from './consistent-thematic-break-style.js';
 import consistentUnorderedListStyle from './consistent-unordered-list-style.js';
 // import enCapitalization from './en-capitalization.js';
-// import headingId from './heading-id.js';
 // import noBoldParagraph from './no-bold-paragraph.js';
 import noControlCharacter from './no-control-character.js';
 import noCurlyQuote from './no-curly-quote.js';
@@ -26,6 +25,7 @@ import noIrregularDash from './no-irregular-dash.js';
 import noIrregularWhitespace from './no-irregular-whitespace.js';
 import noTab from './no-tab.js';
 import noUrlTrailingSlash from './no-url-trailing-slash.js';
+import requireHeadingId from './require-heading-id.js';
 import requireImageTitle from './require-image-title.js';
 import requireLinkTitle from './require-link-title.js';
 
@@ -42,7 +42,6 @@ export default {
   'consistent-thematic-break-style': consistentThematicBreakStyle,
   'consistent-unordered-list-style': consistentUnorderedListStyle,
   // 'en-capitalization': enCapitalization,
-  // 'heading-id': headingId,
   // 'no-bold-paragraph': noBoldParagraph,
   'no-control-character': noControlCharacter,
   'no-curly-quote': noCurlyQuote,
@@ -54,6 +53,7 @@ export default {
   'no-irregular-whitespace': noIrregularWhitespace,
   'no-tab': noTab,
   'no-url-trailing-slash': noUrlTrailingSlash,
+  'require-heading-id': requireHeadingId,
   'require-image-title': requireImageTitle,
   'require-link-title': requireLinkTitle,
 };

package/src/rules/no-control-character.js

@@ -17,7 +17,7 @@ import { URL_RULE_DOCS } from '../core/constants.js';
 /**
  * @import { RuleModule } from '../core/types.js';
  * @typedef {[{ allow: string[], skipCode: boolean | string[], skipInlineCode: boolean }]} RuleOptions
- * @typedef {'noControlCharacter'} MessageIds
+ * @typedef {'noControlCharacter' | 'suggestRemove'} MessageIds
  */
 
 // --------------------------------------------------------------------------------
@@ -43,6 +43,8 @@ export default {
       stylistic: false,
     },
 
+    hasSuggestions: true,
+
     schema: [
       {
         type: 'object',
@@ -86,6 +88,7 @@ export default {
 
     messages: {
       noControlCharacter: 'Control character `{{ controlCharacter }}` is not allowed.',
+      suggestRemove: 'Remove control character `{{ controlCharacter }}`.',
     },
 
     language: 'markdown',
@@ -124,6 +127,8 @@ export default {
 
           if (skipRanges.includes(startOffset)) continue;
 
+          const controlCharacterCode = `U+${controlCharacter.codePointAt(0)?.toString(16).toUpperCase().padStart(4, '0')}`;
+
           context.report({
             loc: {
               start: sourceCode.getLocFromIndex(startOffset),
@@ -131,10 +136,24 @@ export default {
             },
 
             data: {
-              controlCharacter: `U+${controlCharacter.codePointAt(0)?.toString(16).toUpperCase().padStart(4, '0')}`,
+              controlCharacter: controlCharacterCode,
             },
 
             messageId: 'noControlCharacter',
+
+            suggest: [
+              {
+                messageId: 'suggestRemove',
+
+                data: {
+                  controlCharacter: controlCharacterCode,
+                },
+
+                fix(fixer) {
+                  return fixer.removeRange([startOffset, endOffset]);
+                },
+              },
+            ],
           });
         }
       },

package/src/rules/require-heading-id.js

@@ -0,0 +1,239 @@
+/**
+ * @fileoverview Rule to enforce the use of heading IDs.
+ * @author lumir(lumirlumir)
+ */
+
+// --------------------------------------------------------------------------------
+// Import
+// --------------------------------------------------------------------------------
+
+import { escapeStringRegexp } from '../core/ast/index.js';
+import { URL_RULE_DOCS } from '../core/constants.js';
+
+// --------------------------------------------------------------------------------
+// Typedef
+// --------------------------------------------------------------------------------
+
+/**
+ * @import { Heading } from 'mdast';
+ * @import { RuleModule } from '../core/types.js';
+ * @typedef {['always' | 'never', { leftDelimiter: string, rightDelimiter: string, allowDepths: Heading['depth'][] }]} RuleOptions
+ * @typedef {'headingIdAlways' | 'headingIdNever'} MessageIds
+ */
+
+// --------------------------------------------------------------------------------
+// Rule Definition
+// --------------------------------------------------------------------------------
+
+/** @type {RuleModule<RuleOptions, MessageIds>} */
+export default {
+  meta: {
+    type: 'problem',
+
+    docs: {
+      description: 'Enforce the use of heading IDs',
+      url: URL_RULE_DOCS('require-heading-id'),
+      recommended: false,
+      stylistic: false,
+    },
+
+    fixable: 'code',
+
+    schema: [
+      {
+        enum: ['always', 'never'],
+      },
+      {
+        type: 'object',
+        properties: {
+          leftDelimiter: {
+            type: 'string',
+          },
+          rightDelimiter: {
+            type: 'string',
+          },
+          allowDepths: {
+            type: 'array',
+            items: {
+              enum: [1, 2, 3, 4, 5, 6],
+            },
+            uniqueItems: true,
+          },
+        },
+        additionalProperties: false,
+      },
+    ],
+
+    defaultOptions: [
+      'always',
+      {
+        leftDelimiter: '{',
+        rightDelimiter: '}',
+        allowDepths: [],
+      },
+    ],
+
+    messages: {
+      headingIdAlways: 'Headings should have an ID attribute.',
+      headingIdNever:
+        'Headings should not have an ID attribute. Remove the `{{ headingId }}`.',
+    },
+
+    language: 'markdown',
+
+    dialects: ['commonmark', 'gfm'],
+  },
+
+  create(context) {
+    const { sourceCode } = context;
+    const [mode, { leftDelimiter, rightDelimiter, allowDepths }] = context.options;
+
+    const escapedLeftDelimiter = escapeStringRegexp(leftDelimiter);
+    const escapedRightDelimiter = escapeStringRegexp(rightDelimiter);
+
+    /**
+     * We don't use the `[ \t]*$` pattern at the end of the regex because trailing
+     * whitespace is already removed from a `heading` node's child `text` node.
+     */
+    const headingIdRegex = new RegExp(
+      `(?<leadingSpaces>[ \t]+)(?<headingId>${escapedLeftDelimiter}#[^${escapedRightDelimiter}]+${escapedRightDelimiter})$`,
+    );
+
+    return {
+      heading(node) {
+        // If the heading's depth is included in `allowDepths`, skip it.
+        if (allowDepths.includes(node.depth)) {
+          return;
+        }
+
+        /*
+         * Instead of using deep recursive traversal to find the final `text` node,
+         * we simply access the node's last child directly with shallow traversal.
+         *
+         * This is because in the "Not OK" case, the `text` node is located
+         * in the last position while DFS(Depth First Search) traversal,
+         * but is located under `emphasis` or `strong` nodes.
+         *
+         * This is the situation we don't want to support.
+         * There must be pure ` #{custom-id}` text at the end of the heading
+         * without being wrapped by other nodes.
+         *
+         * OK:
+         *
+         * ```md
+         * # heading {#custom-id}
+         * ```
+         *
+         * Not OK:
+         *
+         * ```md
+         * # heading *{#custom-id}*
+         *           ^            ^
+         *
+         * # heading **{#custom-id}**
+         *           ^^            ^^
+         * ```
+         */
+        const lastChildNode = node.children.at(-1);
+
+        /*
+         * ATX headings and closed ATX headings that contain no content have no child nodes.
+         *
+         * ATX Headings:
+         *
+         * ```md
+         * #
+         *
+         * ##
+         *
+         * ###
+         * ```
+         *
+         * ATX Closed Headings:
+         *
+         * ```md
+         * # #
+         *
+         * ## ##
+         *
+         * ### ###
+         * ```
+         */
+        if (!lastChildNode) {
+          // If there are no child nodes, intentionally skip it.
+          // This is not the part we want to report.
+          return;
+        }
+
+        /*
+         * Missing heading IDs are reported on the last character of the last child
+         * node rather than as a zero-width location (i.e. `column === endColumn`)
+         * at the end of that node, because some editors such as VSCode render
+         * zero-width diagnostics incorrectly.
+         */
+        const [lastChildNodeStartOffset, lastChildNodeEndOffset] =
+          sourceCode.getRange(lastChildNode);
+
+        // If the last child node is not a `text` node, report an error.
+        if (lastChildNode.type !== 'text') {
+          if (mode === 'always') {
+            context.report({
+              loc: {
+                start: sourceCode.getLocFromIndex(lastChildNodeEndOffset - 1),
+                end: sourceCode.getLocFromIndex(lastChildNodeEndOffset),
+              },
+
+              messageId: 'headingIdAlways',
+            });
+          }
+
+          return;
+        }
+
+        const match = headingIdRegex.exec(sourceCode.getText(lastChildNode));
+
+        if (!match || !match.groups) {
+          if (mode === 'always') {
+            context.report({
+              loc: {
+                start: sourceCode.getLocFromIndex(lastChildNodeEndOffset - 1),
+                end: sourceCode.getLocFromIndex(lastChildNodeEndOffset),
+              },
+
+              messageId: 'headingIdAlways',
+            });
+          }
+
+          return;
+        }
+
+        if (mode === 'never') {
+          const { leadingSpaces, headingId } = match.groups;
+          const leadingSpacesStartOffset = lastChildNodeStartOffset + match.index;
+          const headingIdStartOffset = leadingSpacesStartOffset + leadingSpaces.length;
+          const headingIdEndOffset = headingIdStartOffset + headingId.length;
+
+          context.report({
+            loc: {
+              start: sourceCode.getLocFromIndex(headingIdStartOffset),
+              end: sourceCode.getLocFromIndex(headingIdEndOffset),
+            },
+
+            data: {
+              headingId,
+            },
+
+            messageId: 'headingIdNever',
+
+            fix(fixer) {
+              return fixer.replaceTextRange(
+                [leadingSpacesStartOffset, headingIdEndOffset],
+                '',
+              );
+            },
+          });
+        }
+      },
+    };
+  },
+};

package/src/rules/heading-id.js

@@ -1,153 +0,0 @@
-/**
- * @fileoverview Rule to enforce the use of heading IDs.
- * @author lumir(lumirlumir)
- */
-
-// @ts-nocheck -- TODO
-
-// --------------------------------------------------------------------------------
-// Import
-// --------------------------------------------------------------------------------
-
-import { URL_RULE_DOCS } from '../core/constants.js';
-
-// --------------------------------------------------------------------------------
-// Typedefs
-// --------------------------------------------------------------------------------
-
-/**
- * @import { Heading } from 'mdast';
- * @import { RuleModule } from '../core/types.js';
- * @typedef {['always' | 'never', { leftDelimiter: string, rightDelimiter: string, ignoreDepth: Heading['depth'][] }]} RuleOptions
- * @typedef {'headingIdAlways' | 'headingIdNever'} MessageIds
- */
-
-// --------------------------------------------------------------------------------
-// Rule Definition
-// --------------------------------------------------------------------------------
-
-/** @type {RuleModule<RuleOptions, MessageIds>} */
-export default {
-  meta: {
-    type: 'problem',
-
-    docs: {
-      description: 'Enforce the use of heading IDs',
-      url: URL_RULE_DOCS('heading-id'),
-      recommended: false,
-      stylistic: false,
-    },
-
-    fixable: 'code',
-
-    schema: [
-      {
-        enum: ['always', 'never'],
-      },
-      {
-        type: 'object',
-        properties: {
-          leftDelimiter: {
-            type: 'string',
-          },
-          rightDelimiter: {
-            type: 'string',
-          },
-          ignoreDepth: {
-            type: 'array',
-            items: {
-              enum: [1, 2, 3, 4, 5, 6],
-            },
-            uniqueItems: true,
-          },
-        },
-        additionalProperties: false,
-      },
-    ],
-
-    defaultOptions: [
-      'always',
-      {
-        leftDelimiter: '{',
-        rightDelimiter: '}',
-        ignoreDepth: [],
-      },
-    ],
-
-    messages: {
-      headingIdAlways: 'Headings should have an ID attribute.',
-      headingIdNever:
-        'Headings should not have an ID attribute. Remove the `{{ headingId }}`.',
-    },
-
-    language: 'markdown',
-
-    dialects: ['commonmark', 'gfm'],
-  },
-
-  create(context) {
-    return {
-      heading(node) {
-        const [mode, { leftDelimiter, rightDelimiter, ignoreDepth }] = context.options;
-
-        if (ignoreDepth.includes(node.depth)) return;
-
-        const regex = new RegExp(
-          `${leftDelimiter}#[^${rightDelimiter}]+${rightDelimiter}[ \t]*$`,
-        );
-        const match = context.sourceCode.getText(node).match(regex);
-
-        if (mode === 'always' && match === null) {
-          context.report({
-            loc: {
-              start: {
-                line: node.position.start.line,
-                column: node.position.end.column,
-              },
-              end: {
-                line: node.position.start.line,
-                column: node.position.end.column,
-              },
-            },
-
-            messageId: 'headingIdAlways',
-          });
-        } else if (mode === 'never' && match !== null) {
-          const headingIdLength = match[0].length;
-
-          const matchIndexStart = match.index;
-          const matchIndexEnd = matchIndexStart + headingIdLength;
-
-          context.report({
-            loc: {
-              start: {
-                line: node.position.start.line,
-                column: node.position.start.column + matchIndexStart,
-              },
-              end: {
-                line: node.position.start.line,
-                column: node.position.start.column + matchIndexEnd,
-              },
-            },
-
-            data: {
-              headingId: match[0],
-            },
-
-            messageId: 'headingIdNever',
-
-            fix(fixer) {
-              return fixer.replaceTextRange(
-                [
-                  node.position.start.offset + matchIndexStart,
-                  node.position.start.offset + matchIndexEnd,
-                ],
-                '',
-              );
-            },
-          });
-        }
-      },
-    };
-  },
-};