eslint-markdown 0.12.0 → 0.13.0

package/build/configs/all.d.ts

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

package/build/configs/all.js

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

package/build/configs/stylistic.d.ts

@@ -25,5 +25,6 @@ export default function stylistic(plugin: ESLint.Plugin): {
         readonly 'md/consistent-unordered-list-style': "error";
         readonly 'md/no-consecutive-blank-line': "error";
         readonly 'md/no-tab': "error";
+        readonly 'md/no-trailing-heading-punctuation': "error";
     };
 };

package/build/configs/stylistic.js

@@ -33,6 +33,7 @@ export default function stylistic(plugin) {
             'md/consistent-unordered-list-style': 'error',
             'md/no-consecutive-blank-line': 'error',
             'md/no-tab': 'error',
+            'md/no-trailing-heading-punctuation': 'error',
         },
     };
 }

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

@@ -2,4 +2,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 { escapeStringRegexp, getElementsByTagName, isBlankLine, SkipRanges };
+import testRegexStateless from './test-regex-stateless.js';
+export { escapeStringRegexp, getElementsByTagName, isBlankLine, SkipRanges, testRegexStateless, };

package/build/core/utils/index.js

@@ -2,4 +2,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 { escapeStringRegexp, getElementsByTagName, isBlankLine, SkipRanges };
+import testRegexStateless from './test-regex-stateless.js';
+export { escapeStringRegexp, getElementsByTagName, isBlankLine, SkipRanges, testRegexStateless, };

package/build/core/utils/test-regex-stateless.d.ts

@@ -0,0 +1,10 @@
+/**
+ * @fileoverview Utility to test a regular expression without mutating its state.
+ */
+/**
+ * Tests a regex without mutating the state stored in its `lastIndex`.
+ * @param regex Regex to test.
+ * @param text Text to test.
+ * @returns Whether the regex matches the text.
+ */
+export default function testRegexStateless(regex: RegExp, text: string): boolean;

package/build/core/utils/test-regex-stateless.js

@@ -0,0 +1,21 @@
+/**
+ * @fileoverview Utility to test a regular expression without mutating its state.
+ */
+// --------------------------------------------------------------------------------
+// Helper
+// --------------------------------------------------------------------------------
+const statefulRegexFlagRegex = /[gy]/u;
+// --------------------------------------------------------------------------------
+// Export
+// --------------------------------------------------------------------------------
+/**
+ * Tests a regex without mutating the state stored in its `lastIndex`.
+ * @param regex Regex to test.
+ * @param text Text to test.
+ * @returns Whether the regex matches the text.
+ */
+export default function testRegexStateless(regex, text) {
+    return statefulRegexFlagRegex.test(regex.flags)
+        ? new RegExp(regex).test(text)
+        : regex.test(text);
+}

package/build/index.d.ts

@@ -594,6 +594,7 @@ declare const plugin: {
                     readonly properties: {
                         readonly style: {
                             readonly type: "string";
+                            readonly pattern: "^(?:consistent|(?:-[ \\t]*){3,}|(?:\\*[ \\t]*){3,}|(?:_[ \\t]*){3,})$";
                         };
                     };
                     readonly additionalProperties: false;
@@ -1206,6 +1207,53 @@ declare const plugin: {
                 'root:exit'(): void;
             };
         };
+        'no-trailing-heading-punctuation': {
+            readonly meta: {
+                readonly type: "problem";
+                readonly docs: {
+                    readonly description: "Disallow trailing punctuation in headings";
+                    readonly url: string;
+                    readonly recommended: false;
+                    readonly stylistic: true;
+                };
+                readonly fixable: "code";
+                readonly schema: [{
+                    readonly type: "object";
+                    readonly properties: {
+                        readonly punctuation: {
+                            readonly type: "array";
+                            readonly items: {
+                                readonly type: "string";
+                                readonly minLength: 1;
+                                readonly maxLength: 1;
+                            };
+                            readonly minItems: 1;
+                            readonly uniqueItems: true;
+                        };
+                    };
+                    readonly additionalProperties: false;
+                }];
+                readonly defaultOptions: [{
+                    readonly punctuation: [".", ",", ";", ":", "!", "。", "，", "；", "：", "！"];
+                }];
+                readonly messages: {
+                    readonly noTrailingHeadingPunctuation: "Trailing punctuation `{{ punctuation }}` is not allowed in headings.";
+                };
+                readonly language: "markdown";
+                readonly dialects: ["commonmark", "gfm"];
+            };
+            readonly create: (context: import("@eslint/core").RuleContext<{
+                LangOptions: import("@eslint/markdown").MarkdownLanguageOptions;
+                Code: import("@eslint/markdown").MarkdownSourceCode;
+                RuleOptions: [{
+                    punctuation: string[];
+                }];
+                Node: import("mdast").Node;
+                MessageIds: "noTrailingHeadingPunctuation";
+            }>) => {
+                heading(node: import("mdast").Heading): void;
+            };
+        };
         'no-url-trailing-slash': {
             readonly meta: {
                 readonly type: "problem";

package/build/rules/allow-heading.js

@@ -2,11 +2,11 @@
  * @fileoverview Rule to enforce the use of allowed or disallowed headings.
  * @author lumir(lumirlumir)
  */
+import { testRegexStateless } from '../core/utils/index.js';
 import { URL_RULE_DOCS } from '../core/constants.js';
 // --------------------------------------------------------------------------------
 // Helper
 // --------------------------------------------------------------------------------
-const statefulRegexFlagRegex = /[gy]/u;
 const headingOptionsSchema = {
     type: 'object',
     properties: {
@@ -27,17 +27,6 @@ const headingOptionsSchema = {
     },
     additionalProperties: false,
 };
-/**
- * Tests a regex without mutating the state stored in its `lastIndex`.
- * @param regex Regex to test.
- * @param text Text to test.
- * @returns Whether the regex matches the text.
- */
-function testRegexStateless(regex, text) {
-    return statefulRegexFlagRegex.test(regex.flags)
-        ? new RegExp(regex).test(text)
-        : regex.test(text);
-}
 // --------------------------------------------------------------------------------
 // Rule Definition
 // --------------------------------------------------------------------------------

package/build/rules/allow-image-url.js

@@ -3,7 +3,7 @@
  * @author lumir(lumirlumir)
  */
 import { normalizeIdentifier } from 'micromark-util-normalize-identifier';
-import { getElementsByTagName } from '../core/utils/index.js';
+import { getElementsByTagName, testRegexStateless } from '../core/utils/index.js';
 import { URL_RULE_DOCS } from '../core/constants.js';
 // --------------------------------------------------------------------------------
 // Rule Definition
@@ -114,7 +114,7 @@ export default {
                  * Therefore, calling the `some` method on an empty array will always return `false`.
                  */
                 for (const { loc, url } of images) {
-                    if (!allowUrls.some(regex => regex.test(url))) {
+                    if (!allowUrls.some(regex => testRegexStateless(regex, url))) {
                         context.report({
                             loc,
                             messageId: 'allowImageUrl',
@@ -124,7 +124,7 @@ export default {
                             },
                         });
                     }
-                    if (disallowUrls.some(regex => regex.test(url))) {
+                    if (disallowUrls.some(regex => testRegexStateless(regex, url))) {
                         context.report({
                             loc,
                             messageId: 'disallowImageUrl',

package/build/rules/allow-link-url.js

@@ -3,7 +3,7 @@
  * @author lumir(lumirlumir)
  */
 import { normalizeIdentifier } from 'micromark-util-normalize-identifier';
-import { getElementsByTagName } from '../core/utils/index.js';
+import { getElementsByTagName, testRegexStateless } from '../core/utils/index.js';
 import { URL_RULE_DOCS } from '../core/constants.js';
 // --------------------------------------------------------------------------------
 // Rule Definition
@@ -114,7 +114,7 @@ export default {
                  * Therefore, calling the `some` method on an empty array will always return `false`.
                  */
                 for (const { loc, url } of links) {
-                    if (!allowUrls.some(regex => regex.test(url))) {
+                    if (!allowUrls.some(regex => testRegexStateless(regex, url))) {
                         context.report({
                             loc,
                             messageId: 'allowLinkUrl',
@@ -124,7 +124,7 @@ export default {
                             },
                         });
                     }
-                    if (disallowUrls.some(regex => regex.test(url))) {
+                    if (disallowUrls.some(regex => testRegexStateless(regex, url))) {
                         context.report({
                             loc,
                             messageId: 'disallowLinkUrl',

package/build/rules/consistent-thematic-break-style.d.ts

@@ -20,6 +20,7 @@ declare const _default: {
             readonly properties: {
                 readonly style: {
                     readonly type: "string";
+                    readonly pattern: "^(?:consistent|(?:-[ \\t]*){3,}|(?:\\*[ \\t]*){3,}|(?:_[ \\t]*){3,})$";
                 };
             };
             readonly additionalProperties: false;

package/build/rules/consistent-thematic-break-style.js

@@ -7,6 +7,15 @@
 // --------------------------------------------------------------------------------
 import { URL_RULE_DOCS } from '../core/constants.js';
 // --------------------------------------------------------------------------------
+// Helper
+// --------------------------------------------------------------------------------
+/**
+ * Matches `consistent` or a valid CommonMark thematic break style
+ * (3+ identical `-`, `*`, or `_` characters, each optionally followed by spaces/tabs).
+ * @see https://spec.commonmark.org/0.31.2/#thematic-breaks
+ */
+const thematicBreakStylePattern = '^(?:consistent|(?:-[ \\t]*){3,}|(?:\\*[ \\t]*){3,}|(?:_[ \\t]*){3,})$';
+// --------------------------------------------------------------------------------
 // Rule Definition
 // --------------------------------------------------------------------------------
 export default {
@@ -25,6 +34,7 @@ export default {
                 properties: {
                     style: {
                         type: 'string',
+                        pattern: thematicBreakStylePattern,
                     },
                 },
                 additionalProperties: false,

package/build/rules/index.d.ts

@@ -585,6 +585,7 @@ declare const _default: {
                 readonly properties: {
                     readonly style: {
                         readonly type: "string";
+                        readonly pattern: "^(?:consistent|(?:-[ \\t]*){3,}|(?:\\*[ \\t]*){3,}|(?:_[ \\t]*){3,})$";
                     };
                 };
                 readonly additionalProperties: false;
@@ -1197,6 +1198,53 @@ declare const _default: {
             'root:exit'(): void;
         };
     };
+    'no-trailing-heading-punctuation': {
+        readonly meta: {
+            readonly type: "problem";
+            readonly docs: {
+                readonly description: "Disallow trailing punctuation in headings";
+                readonly url: string;
+                readonly recommended: false;
+                readonly stylistic: true;
+            };
+            readonly fixable: "code";
+            readonly schema: [{
+                readonly type: "object";
+                readonly properties: {
+                    readonly punctuation: {
+                        readonly type: "array";
+                        readonly items: {
+                            readonly type: "string";
+                            readonly minLength: 1;
+                            readonly maxLength: 1;
+                        };
+                        readonly minItems: 1;
+                        readonly uniqueItems: true;
+                    };
+                };
+                readonly additionalProperties: false;
+            }];
+            readonly defaultOptions: [{
+                readonly punctuation: [".", ",", ";", ":", "!", "。", "，", "；", "：", "！"];
+            }];
+            readonly messages: {
+                readonly noTrailingHeadingPunctuation: "Trailing punctuation `{{ punctuation }}` is not allowed in headings.";
+            };
+            readonly language: "markdown";
+            readonly dialects: ["commonmark", "gfm"];
+        };
+        readonly create: (context: import("@eslint/core").RuleContext<{
+            LangOptions: import("@eslint/markdown").MarkdownLanguageOptions;
+            Code: import("@eslint/markdown").MarkdownSourceCode;
+            RuleOptions: [{
+                punctuation: string[];
+            }];
+            Node: import("mdast").Node;
+            MessageIds: "noTrailingHeadingPunctuation";
+        }>) => {
+            heading(node: import("mdast").Heading): void;
+        };
+    };
     'no-url-trailing-slash': {
         readonly meta: {
             readonly type: "problem";

package/build/rules/index.js

@@ -23,6 +23,7 @@ import noGitConflictMarker from './no-git-conflict-marker.js';
 import noIrregularDash from './no-irregular-dash.js';
 import noIrregularWhitespace from './no-irregular-whitespace.js';
 import noTab from './no-tab.js';
+import noTrailingHeadingPunctuation from './no-trailing-heading-punctuation.js';
 import noUrlTrailingSlash from './no-url-trailing-slash.js';
 import requireHeadingId from './require-heading-id.js';
 import requireImageTitle from './require-image-title.js';
@@ -51,6 +52,7 @@ export default {
     'no-irregular-dash': noIrregularDash,
     'no-irregular-whitespace': noIrregularWhitespace,
     'no-tab': noTab,
+    'no-trailing-heading-punctuation': noTrailingHeadingPunctuation,
     'no-url-trailing-slash': noUrlTrailingSlash,
     'require-heading-id': requireHeadingId,
     'require-image-title': requireImageTitle,

package/build/rules/no-trailing-heading-punctuation.d.ts

@@ -0,0 +1,53 @@
+/**
+ * @fileoverview Rule to disallow trailing punctuation in headings.
+ * @author Ga eun Lee(tooth-is-silver)
+ */
+type RuleOptions = [{
+    punctuation: string[];
+}];
+declare const _default: {
+    readonly meta: {
+        readonly type: "problem";
+        readonly docs: {
+            readonly description: "Disallow trailing punctuation in headings";
+            readonly url: string;
+            readonly recommended: false;
+            readonly stylistic: true;
+        };
+        readonly fixable: "code";
+        readonly schema: [{
+            readonly type: "object";
+            readonly properties: {
+                readonly punctuation: {
+                    readonly type: "array";
+                    readonly items: {
+                        readonly type: "string";
+                        readonly minLength: 1;
+                        readonly maxLength: 1;
+                    };
+                    readonly minItems: 1;
+                    readonly uniqueItems: true;
+                };
+            };
+            readonly additionalProperties: false;
+        }];
+        readonly defaultOptions: [{
+            readonly punctuation: [".", ",", ";", ":", "!", "。", "，", "；", "：", "！"];
+        }];
+        readonly messages: {
+            readonly noTrailingHeadingPunctuation: "Trailing punctuation `{{ punctuation }}` is not allowed in headings.";
+        };
+        readonly language: "markdown";
+        readonly dialects: ["commonmark", "gfm"];
+    };
+    readonly create: (context: import("@eslint/core").RuleContext<{
+        LangOptions: import("@eslint/markdown").MarkdownLanguageOptions;
+        Code: import("@eslint/markdown").MarkdownSourceCode;
+        RuleOptions: RuleOptions;
+        Node: import("mdast").Node;
+        MessageIds: "noTrailingHeadingPunctuation";
+    }>) => {
+        heading(node: import("mdast").Heading): void;
+    };
+};
+export default _default;

package/build/rules/no-trailing-heading-punctuation.js

@@ -0,0 +1,187 @@
+/**
+ * @fileoverview Rule to disallow trailing punctuation in headings.
+ * @author Ga eun Lee(tooth-is-silver)
+ */
+// --------------------------------------------------------------------------------
+// Import
+// --------------------------------------------------------------------------------
+import { escapeStringRegexp } from '../core/utils/index.js';
+import { URL_RULE_DOCS } from '../core/constants.js';
+// --------------------------------------------------------------------------------
+// Helper
+// --------------------------------------------------------------------------------
+/**
+ * Regular expression for identifying a GitHub emoji code at the end of a line.
+ * - NOTE: These patterns are based on the `markdownlint`.
+ * @see https://github.com/DavidAnson/markdownlint/blob/v0.41.1/helpers/helpers.cjs#L36-L38
+ */
+const trailingGemojiRegex = /:(?:[abmovx]|[-+]1|100|1234|(?:1st|2nd|3rd)_place_medal|8ball|clock\d{1,4}|e-mail|non-potable_water|o2|t-rex|u5272|u5408|u55b6|u6307|u6708|u6709|u6e80|u7121|u7533|u7981|u7a7a|[a-z]{2,15}2?|[a-z]{1,14}(?:_[a-z\d]{1,16})+):$/;
+/**
+ * Regular expression for identifying an HTML entity at the end of a line.
+ * - NOTE: These patterns are based on the `markdownlint`.
+ * @see https://github.com/DavidAnson/markdownlint/blob/v0.41.1/helpers/helpers.cjs#L32-L34
+ */
+const trailingHtmlEntityRegex = /&(?:#\d+|#[xX][\da-fA-F]+|[a-zA-Z]{2,31}|blk\d{2}|emsp1[34]|frac\d{2}|sup\d|there4);$/;
+// --------------------------------------------------------------------------------
+// Rule Definition
+// --------------------------------------------------------------------------------
+export default {
+    meta: {
+        type: 'problem',
+        docs: {
+            description: 'Disallow trailing punctuation in headings',
+            url: URL_RULE_DOCS('no-trailing-heading-punctuation'),
+            recommended: false,
+            stylistic: true,
+        },
+        fixable: 'code',
+        schema: [
+            {
+                type: 'object',
+                properties: {
+                    punctuation: {
+                        type: 'array',
+                        items: {
+                            type: 'string',
+                            minLength: 1,
+                            maxLength: 1,
+                        },
+                        minItems: 1,
+                        uniqueItems: true,
+                    },
+                },
+                additionalProperties: false,
+            },
+        ],
+        defaultOptions: [
+            {
+                punctuation: ['.', ',', ';', ':', '!', '。', '，', '；', '：', '！'],
+            },
+        ],
+        messages: {
+            noTrailingHeadingPunctuation: 'Trailing punctuation `{{ punctuation }}` is not allowed in headings.',
+        },
+        language: 'markdown',
+        dialects: ['commonmark', 'gfm'],
+    },
+    create(context) {
+        const { sourceCode } = context;
+        const [{ punctuation }] = context.options;
+        const trailingPunctuationRegex = new RegExp(`[ \\t\\r\\n]*[${escapeStringRegexp(punctuation.join(''))}]+$`);
+        return {
+            heading(node) {
+                /*
+                 * NOTE: This behavior is consistent with the `markdownlint` rule `MD026`.
+                 *
+                 * 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.
+                 * The trailing punctuation must be in a plain `text` node at the end
+                 * of the heading without being wrapped by other nodes.
+                 *
+                 * OK:
+                 *
+                 * ```md
+                 * # heading .
+                 * ```
+                 *
+                 * Not OK:
+                 *
+                 * ```md
+                 * # heading *.*
+                 *           ^ ^
+                 *
+                 * # heading **.**
+                 *           ^^ ^^
+                 * ```
+                 */
+                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 || lastChildNode.type !== 'text') {
+                    // If there is no child node or trailing `text` node, intentionally skip the heading.
+                    return;
+                }
+                const lastChildText = sourceCode.getText(lastChildNode);
+                const match = trailingPunctuationRegex.exec(lastChildText);
+                if (!match) {
+                    return;
+                }
+                let trailingPunctuation = match[0];
+                /*
+                 * Slice from the beginning of the trailing `text` node through the first
+                 * character matched by `trailingPunctuationRegex`, including that character.
+                 *
+                 * The first matched character can be the closing `:` of a gemoji or the
+                 * closing `;` of an HTML entity. Including it allows the end-anchored regular
+                 * expressions to recognize the construct while excluding any punctuation
+                 * that follows it.
+                 *
+                 * Gemoji:
+                 *
+                 * ```text
+                 * lastChildText:                       Heading :smile:.
+                 * textThroughFirstTrailingPunctuation: Heading :smile:
+                 * ```
+                 *
+                 * HTML entity:
+                 *
+                 * ```text
+                 * lastChildText:                       Copyright ©.
+                 * textThroughFirstTrailingPunctuation: Copyright ©
+                 * ```
+                 */
+                const textThroughFirstTrailingPunctuation = lastChildText.slice(0, match.index + 1);
+                if (trailingGemojiRegex.test(textThroughFirstTrailingPunctuation) ||
+                    trailingHtmlEntityRegex.test(textThroughFirstTrailingPunctuation)) {
+                    trailingPunctuation = trailingPunctuation.slice(1);
+                }
+                if (!trailingPunctuation) {
+                    // If the match contains only a gemoji or HTML entity terminator, skip it.
+                    return;
+                }
+                const [, endOffset] = sourceCode.getRange(lastChildNode);
+                const startOffset = endOffset - trailingPunctuation.length;
+                context.report({
+                    loc: {
+                        start: sourceCode.getLocFromIndex(startOffset),
+                        end: sourceCode.getLocFromIndex(endOffset),
+                    },
+                    data: {
+                        punctuation: trailingPunctuation,
+                    },
+                    messageId: 'noTrailingHeadingPunctuation',
+                    fix(fixer) {
+                        return fixer.removeRange([startOffset, endOffset]);
+                    },
+                });
+            },
+        };
+    },
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eslint-markdown",
-  "version": "0.12.0",
+  "version": "0.13.0",
   "type": "module",
   "sideEffects": false,
   "description": "Lint your Markdown with ESLint. Additional rules for use with `@eslint/markdown`.🛠️",
@@ -78,7 +78,7 @@
   "devDependencies": {
     "@types/mdast": "^4.0.4",
     "@types/unist": "^3.0.3",
-    "eslint": "^9.39.4",
+    "eslint": "^9.39.5",
     "vitest": "^4.1.9"
   }
 }