eslint-markdown 0.14.0 → 0.14.1

package/build/core/constants.d.ts

@@ -1,6 +1,22 @@
 /**
  * @fileoverview This file declares constants used throughout the `eslint-markdown` package.
  */
-export declare const PKG_NAME: "eslint-markdown";
-export declare const PKG_VERSION: string;
 export declare const URL_RULE_DOCS: (ruleName?: string) => string;
+/**
+ * This pattern is based on the punctuation list used by `markdownlint` and `remark-lint`.
+ * @see https://github.com/DavidAnson/markdownlint/blob/v0.41.1/helpers/helpers.cjs#L41
+ * @see https://github.com/remarkjs/remark-lint/tree/main/packages/remark-lint-no-heading-punctuation#parameters
+ */
+export declare const punctuation: readonly [".", ",", ";", ":", "!", "。", "，", "；", "：", "！"];
+/**
+ * This pattern is based on the punctuation list used by `markdownlint` and `remark-lint`.
+ * @see https://github.com/DavidAnson/markdownlint/blob/v0.41.1/helpers/helpers.cjs#L41
+ * @see https://github.com/remarkjs/remark-lint/tree/main/packages/remark-lint-no-heading-punctuation#parameters
+ */
+export declare const punctuationWithQuestionMark: readonly [".", ",", ";", ":", "!", "。", "，", "；", "：", "！", "?", "？"];
+/**
+ * Regular expression for identifying a GitHub emoji code.
+ * - NOTE: These patterns are based on the `markdownlint`.
+ * @see https://github.com/DavidAnson/markdownlint/blob/v0.41.1/helpers/helpers.cjs#L36-L38
+ */
+export declare const gemojiRegex: RegExp;

package/build/core/constants.js

@@ -8,6 +8,41 @@ import pkg from '../../package.json' with { type: 'json' };
 // --------------------------------------------------------------------------------
 // Export
 // --------------------------------------------------------------------------------
-export const PKG_NAME = pkg.name;
-export const PKG_VERSION = pkg.version;
 export const URL_RULE_DOCS = (ruleName = '') => `${pkg.homepage}/docs/rules/${ruleName}`;
+// --------------------------------------------------------------------------------
+// #region array
+/**
+ * This pattern is based on the punctuation list used by `markdownlint` and `remark-lint`.
+ * @see https://github.com/DavidAnson/markdownlint/blob/v0.41.1/helpers/helpers.cjs#L41
+ * @see https://github.com/remarkjs/remark-lint/tree/main/packages/remark-lint-no-heading-punctuation#parameters
+ */
+export const punctuation = [
+    '.',
+    ',',
+    ';',
+    ':',
+    '!',
+    '。',
+    '，',
+    '；',
+    '：',
+    '！',
+];
+/**
+ * This pattern is based on the punctuation list used by `markdownlint` and `remark-lint`.
+ * @see https://github.com/DavidAnson/markdownlint/blob/v0.41.1/helpers/helpers.cjs#L41
+ * @see https://github.com/remarkjs/remark-lint/tree/main/packages/remark-lint-no-heading-punctuation#parameters
+ */
+export const punctuationWithQuestionMark = [...punctuation, '?', '？'];
+// #endregion array
+// --------------------------------------------------------------------------------
+// --------------------------------------------------------------------------------
+// #region regex
+/**
+ * Regular expression for identifying a GitHub emoji code.
+ * - NOTE: These patterns are based on the `markdownlint`.
+ * @see https://github.com/DavidAnson/markdownlint/blob/v0.41.1/helpers/helpers.cjs#L36-L38
+ */
+export const gemojiRegex = /:(?:[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})+):/;
+// #endregion regex
+// --------------------------------------------------------------------------------

package/build/index.d.ts

@@ -232,6 +232,7 @@ declare const plugin: {
                 readonly messages: {
                     readonly allowHeading: "The level {{ depth }} heading `{{ heading }}` is not in the list of allowed headings. (Allow: {{ allow }}).";
                     readonly disallowHeading: "The level {{ depth }} heading `{{ heading }}` is in the list of disallowed headings. (Disallow: {{ disallow }}).";
+                    readonly emptyAllowHeading: "No level {{ depth }} headings are allowed because the list of allowed headings is empty.";
                 };
                 readonly language: "markdown";
                 readonly dialects: ["commonmark", "gfm"];
@@ -241,7 +242,7 @@ declare const plugin: {
                 Code: import("@eslint/markdown").MarkdownSourceCode;
                 RuleOptions: [Record<"h1" | "h2" | "h3" | "h4" | "h5" | "h6", import("./rules/allow-heading.js").HeadingOptions>];
                 Node: import("mdast").Node;
-                MessageIds: "allowHeading" | "disallowHeading";
+                MessageIds: "allowHeading" | "disallowHeading" | "emptyAllowHeading";
             }>) => {
                 heading(node: import("mdast").Heading): void;
             };
@@ -300,6 +301,7 @@ declare const plugin: {
                 readonly messages: {
                     readonly allowImageUrl: "The URL `{{ url }}` is not in the list of allowed URLs. (Allow: {{ patterns }}).";
                     readonly disallowImageUrl: "The URL `{{ url }}` is in the list of disallowed URLs. (Disallow: {{ patterns }}).";
+                    readonly emptyAllowImageUrl: "The URL `{{ url }}` is not allowed because the list of allowed URLs is empty.";
                 };
                 readonly language: "markdown";
                 readonly dialects: ["commonmark", "gfm"];
@@ -313,7 +315,7 @@ declare const plugin: {
                     allowDefinitions: string[];
                 }];
                 Node: import("mdast").Node;
-                MessageIds: "allowImageUrl" | "disallowImageUrl";
+                MessageIds: "allowImageUrl" | "disallowImageUrl" | "emptyAllowImageUrl";
             }>) => {
                 image(node: import("mdast").Image): void;
                 html(node: import("mdast").Html): void;
@@ -376,6 +378,7 @@ declare const plugin: {
                 readonly messages: {
                     readonly allowLinkUrl: "The URL `{{ url }}` is not in the list of allowed URLs. (Allow: {{ patterns }}).";
                     readonly disallowLinkUrl: "The URL `{{ url }}` is in the list of disallowed URLs. (Disallow: {{ patterns }}).";
+                    readonly emptyAllowLinkUrl: "The URL `{{ url }}` is not allowed because the list of allowed URLs is empty.";
                 };
                 readonly language: "markdown";
                 readonly dialects: ["commonmark", "gfm"];
@@ -389,7 +392,7 @@ declare const plugin: {
                     allowDefinitions: string[];
                 }];
                 Node: import("mdast").Node;
-                MessageIds: "allowLinkUrl" | "disallowLinkUrl";
+                MessageIds: "allowLinkUrl" | "disallowLinkUrl" | "emptyAllowLinkUrl";
             }>) => {
                 link(node: import("mdast").Link): void;
                 html(node: import("mdast").Html): void;
@@ -545,7 +548,7 @@ declare const plugin: {
                 LangOptions: import("@eslint/markdown").MarkdownLanguageOptions;
                 Code: import("@eslint/markdown").MarkdownSourceCode;
                 RuleOptions: [{
-                    style: "consistent" | "~" | "~~";
+                    style: "consistent" | ("~" | "~~");
                 }];
                 Node: import("mdast").Node;
                 MessageIds: "style";
@@ -585,7 +588,7 @@ declare const plugin: {
                 LangOptions: import("@eslint/markdown").MarkdownLanguageOptions;
                 Code: import("@eslint/markdown").MarkdownSourceCode;
                 RuleOptions: [{
-                    style: "consistent" | "*" | "_";
+                    style: "consistent" | ("*" | "_");
                 }];
                 Node: import("mdast").Node;
                 MessageIds: "style";
@@ -651,7 +654,7 @@ declare const plugin: {
                 LangOptions: import("@eslint/markdown").MarkdownLanguageOptions;
                 Code: import("@eslint/markdown").MarkdownSourceCode;
                 RuleOptions: [{
-                    style: "consistent" | "*" | "_";
+                    style: "consistent" | ("*" | "_");
                 }];
                 Node: import("mdast").Node;
                 MessageIds: "style";

package/build/index.js

@@ -1,16 +1,16 @@
 /**
  * @fileoverview Entry file for the `eslint-markdown` package.
  */
-import { PKG_NAME as name, PKG_VERSION as version } from './core/constants.js';
 import { all, base, recommended, stylistic } from './configs/index.js';
 import rules from './rules/index.js';
+import pkg from '../package.json' with { type: 'json' };
 // --------------------------------------------------------------------------------
 // Export
 // --------------------------------------------------------------------------------
 const plugin = {
     meta: {
-        name,
-        version,
+        name: pkg.name,
+        version: pkg.version,
     },
     rules,
     configs: {

package/build/rules/allow-heading.d.ts

@@ -4,11 +4,22 @@
  */
 import type { Heading } from 'mdast';
 export interface HeadingOptions {
+    /**
+     * Allowed heading patterns. Only headings matching at least one pattern are allowed.
+     * @default [new RegExp('.*', 'u')] // But as a regex literal.
+     */
     allow: (RegExp | string)[];
+    /**
+     * Disallowed heading patterns. Headings matching any pattern are reported.
+     * @default []
+     */
     disallow: (RegExp | string)[];
 }
+/**
+ * Options for the `allow-heading` rule, mapped by heading levels from `h1` to `h6`.
+ */
 type RuleOptions = [Record<`h${Heading['depth']}`, HeadingOptions>];
-type MessageIds = 'allowHeading' | 'disallowHeading';
+type MessageIds = 'allowHeading' | 'disallowHeading' | 'emptyAllowHeading';
 declare const _default: {
     readonly meta: {
         readonly type: "problem";
@@ -233,6 +244,7 @@ declare const _default: {
         readonly messages: {
             readonly allowHeading: "The level {{ depth }} heading `{{ heading }}` is not in the list of allowed headings. (Allow: {{ allow }}).";
             readonly disallowHeading: "The level {{ depth }} heading `{{ heading }}` is in the list of disallowed headings. (Disallow: {{ disallow }}).";
+            readonly emptyAllowHeading: "No level {{ depth }} headings are allowed because the list of allowed headings is empty.";
         };
         readonly language: "markdown";
         readonly dialects: ["commonmark", "gfm"];

package/build/rules/allow-heading.js

@@ -66,6 +66,7 @@ export default {
         messages: {
             allowHeading: 'The level {{ depth }} heading `{{ heading }}` is not in the list of allowed headings. (Allow: {{ allow }}).',
             disallowHeading: 'The level {{ depth }} heading `{{ heading }}` is in the list of disallowed headings. (Disallow: {{ disallow }}).',
+            emptyAllowHeading: 'No level {{ depth }} headings are allowed because the list of allowed headings is empty.',
         },
         language: 'markdown',
         dialects: ['commonmark', 'gfm'],
@@ -82,7 +83,16 @@ export default {
                 const { depth } = node;
                 const { allow, disallow } = headingMap[depth - 1];
                 const headingText = sourceCode.getText(node);
-                if (!allow.some(regex => testRegexStateless(regex, headingText))) {
+                if (allow.length === 0) {
+                    context.report({
+                        node,
+                        messageId: 'emptyAllowHeading',
+                        data: {
+                            depth,
+                        },
+                    });
+                }
+                else if (!allow.some(regex => testRegexStateless(regex, headingText))) {
                     context.report({
                         node,
                         messageId: 'allowHeading',

package/build/rules/allow-image-url.d.ts

@@ -3,14 +3,35 @@
  * @author lumir(lumirlumir)
  */
 import type { Definition } from 'mdast';
+/**
+ * Options for the `allow-image-url` rule.
+ */
 type RuleOptions = [
     {
+        /**
+         * Allowed URLs act like a ***whitelist***.
+         *
+         * Only those written on the whitelist **can** pass through.
+         * @default [new RegExp('.*', 'u')] // But as a regex literal.
+         */
         allowUrls: (RegExp | string)[];
+        /**
+         * On the contrary, disallowed URLs act like a ***blacklist***.
+         *
+         * Only those written on the blacklist **cannot** pass through.
+         * @default []
+         */
         disallowUrls: (RegExp | string)[];
+        /**
+         * When specified, specific definitions are allowed if they match one of the identifiers in this array.
+         *
+         * This is useful for ignoring definitions that are intentionally left, such as comments or placeholders.
+         * @default ['//']
+         */
         allowDefinitions: string[];
     }
 ];
-type MessageIds = 'allowImageUrl' | 'disallowImageUrl';
+type MessageIds = 'allowImageUrl' | 'disallowImageUrl' | 'emptyAllowImageUrl';
 declare const _default: {
     readonly meta: {
         readonly type: "problem";
@@ -65,6 +86,7 @@ declare const _default: {
         readonly messages: {
             readonly allowImageUrl: "The URL `{{ url }}` is not in the list of allowed URLs. (Allow: {{ patterns }}).";
             readonly disallowImageUrl: "The URL `{{ url }}` is in the list of disallowed URLs. (Disallow: {{ patterns }}).";
+            readonly emptyAllowImageUrl: "The URL `{{ url }}` is not allowed because the list of allowed URLs is empty.";
         };
         readonly language: "markdown";
         readonly dialects: ["commonmark", "gfm"];

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

@@ -62,6 +62,7 @@ export default {
         messages: {
             allowImageUrl: 'The URL `{{ url }}` is not in the list of allowed URLs. (Allow: {{ patterns }}).',
             disallowImageUrl: 'The URL `{{ url }}` is in the list of disallowed URLs. (Disallow: {{ patterns }}).',
+            emptyAllowImageUrl: 'The URL `{{ url }}` is not allowed because the list of allowed URLs is empty.',
         },
         language: 'markdown',
         dialects: ['commonmark', 'gfm'],
@@ -122,7 +123,16 @@ 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 => testRegexStateless(regex, url))) {
+                    if (allowUrls.length === 0) {
+                        context.report({
+                            loc,
+                            messageId: 'emptyAllowImageUrl',
+                            data: {
+                                url,
+                            },
+                        });
+                    }
+                    else if (!allowUrls.some(regex => testRegexStateless(regex, url))) {
                         context.report({
                             loc,
                             messageId: 'allowImageUrl',

package/build/rules/allow-link-url.d.ts

@@ -3,14 +3,35 @@
  * @author lumir(lumirlumir)
  */
 import type { Definition } from 'mdast';
+/**
+ * Options for the `allow-link-url` rule.
+ */
 type RuleOptions = [
     {
+        /**
+         * Allowed URLs act like a ***whitelist***.
+         *
+         * Only those written on the whitelist **can** pass through.
+         * @default [new RegExp('.*', 'u')] // But as a regex literal.
+         */
         allowUrls: (RegExp | string)[];
+        /**
+         * On the contrary, disallowed URLs act like a ***blacklist***.
+         *
+         * Only those written on the blacklist **cannot** pass through.
+         * @default []
+         */
         disallowUrls: (RegExp | string)[];
+        /**
+         * When specified, specific definitions are allowed if they match one of the identifiers in this array.
+         *
+         * This is useful for ignoring definitions that are intentionally left, such as comments or placeholders.
+         * @default ['//']
+         */
         allowDefinitions: string[];
     }
 ];
-type MessageIds = 'allowLinkUrl' | 'disallowLinkUrl';
+type MessageIds = 'allowLinkUrl' | 'disallowLinkUrl' | 'emptyAllowLinkUrl';
 declare const _default: {
     readonly meta: {
         readonly type: "problem";
@@ -65,6 +86,7 @@ declare const _default: {
         readonly messages: {
             readonly allowLinkUrl: "The URL `{{ url }}` is not in the list of allowed URLs. (Allow: {{ patterns }}).";
             readonly disallowLinkUrl: "The URL `{{ url }}` is in the list of disallowed URLs. (Disallow: {{ patterns }}).";
+            readonly emptyAllowLinkUrl: "The URL `{{ url }}` is not allowed because the list of allowed URLs is empty.";
         };
         readonly language: "markdown";
         readonly dialects: ["commonmark", "gfm"];

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

@@ -62,6 +62,7 @@ export default {
         messages: {
             allowLinkUrl: 'The URL `{{ url }}` is not in the list of allowed URLs. (Allow: {{ patterns }}).',
             disallowLinkUrl: 'The URL `{{ url }}` is in the list of disallowed URLs. (Disallow: {{ patterns }}).',
+            emptyAllowLinkUrl: 'The URL `{{ url }}` is not allowed because the list of allowed URLs is empty.',
         },
         language: 'markdown',
         dialects: ['commonmark', 'gfm'],
@@ -122,7 +123,16 @@ 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 => testRegexStateless(regex, url))) {
+                    if (allowUrls.length === 0) {
+                        context.report({
+                            loc,
+                            messageId: 'emptyAllowLinkUrl',
+                            data: {
+                                url,
+                            },
+                        });
+                    }
+                    else if (!allowUrls.some(regex => testRegexStateless(regex, url))) {
                         context.report({
                             loc,
                             messageId: 'allowLinkUrl',

package/build/rules/code-lang-shorthand.d.ts

@@ -2,10 +2,25 @@
  * @fileoverview Rule to enforce the use of shorthand for code block language identifiers.
  * @author lumir(lumirlumir)
  */
-type RuleOptions = [{
-    allow: string[];
-    override: Record<string, string>;
-}];
+/**
+ * Options for the `code-lang-shorthand` rule.
+ */
+type RuleOptions = [
+    {
+        /**
+         * An array of code block language identifiers to allow.
+         *
+         * Each value must be the full, unabridged language identifier.
+         * @default []
+         */
+        allow: string[];
+        /**
+         * An object where the **key** is the full, unabridged language identifier and the **value** is the abbreviated form.
+         * @default {}
+         */
+        override: Record<string, string>;
+    }
+];
 declare const _default: {
     readonly meta: {
         readonly type: "problem";

package/build/rules/consistent-code-style.d.ts

@@ -2,15 +2,31 @@
  * @fileoverview Rule to enforce consistent code style.
  * @author lumir(lumirlumir)
  */
-type CodeStyle = 'indent' | 'fence-backtick' | 'fence-tilde';
+type CodeStyle = (typeof CODE_STYLE)[number];
+/**
+ * Options for the `consistent-code-style` rule.
+ */
 type RuleOptions = [
     {
+        /**
+         * When `style` is set to `'consistent'`, the rule enforces that all code blocks in the document use the same style as the first one encountered.
+         * @default 'consistent'
+         */
         style: 'consistent' | CodeStyle;
+        /**
+         * Require a specific number of blank lines above each fenced code block.
+         * @default false
+         */
         blankLineAbove: number | false;
+        /**
+         * Require a specific number of blank lines below each fenced code block.
+         * @default false
+         */
         blankLineBelow: number | false;
     }
 ];
 type MessageIds = 'style' | 'blankLineAbove' | 'blankLineBelow';
+declare const CODE_STYLE: readonly ["indent", "fence-backtick", "fence-tilde"];
 declare const _default: {
     readonly meta: {
         readonly type: "layout";

package/build/rules/consistent-code-style.js

@@ -19,6 +19,7 @@ import { URL_RULE_DOCS } from '../core/constants.js';
 // --------------------------------------------------------------------------------
 // Helper
 // --------------------------------------------------------------------------------
+const CODE_STYLE = ['indent', 'fence-backtick', 'fence-tilde'];
 /**
  * Get the current code style based on the given text.
  * @param text The text to determine the code style from.
@@ -54,7 +55,7 @@ export default {
                 type: 'object',
                 properties: {
                     style: {
-                        enum: ['consistent', 'indent', 'fence-backtick', 'fence-tilde'],
+                        enum: ['consistent', ...CODE_STYLE],
                     },
                     blankLineAbove: {
                         oneOf: [

package/build/rules/consistent-delete-style.d.ts

@@ -2,9 +2,20 @@
  * @fileoverview Rule to enforce consistent delete style.
  * @author lumir(lumirlumir)
  */
-type RuleOptions = [{
-    style: 'consistent' | '~' | '~~';
-}];
+type DeleteStyle = (typeof DELETE_STYLE)[number];
+/**
+ * Options for the `consistent-delete-style` rule.
+ */
+type RuleOptions = [
+    {
+        /**
+         * When `style` is set to `'consistent'`, the rule enforces that all deletes in the document use the same style as the first one encountered.
+         * @default 'consistent'
+         */
+        style: 'consistent' | DeleteStyle;
+    }
+];
+declare const DELETE_STYLE: readonly ["~", "~~"];
 declare const _default: {
     readonly meta: {
         readonly type: "layout";

package/build/rules/consistent-delete-style.js

@@ -7,6 +7,10 @@
 // --------------------------------------------------------------------------------
 import { URL_RULE_DOCS } from '../core/constants.js';
 // --------------------------------------------------------------------------------
+// Helper
+// --------------------------------------------------------------------------------
+const DELETE_STYLE = ['~', '~~'];
+// --------------------------------------------------------------------------------
 // Rule Definition
 // --------------------------------------------------------------------------------
 export default {
@@ -24,7 +28,7 @@ export default {
                 type: 'object',
                 properties: {
                     style: {
-                        enum: ['consistent', '~', '~~'],
+                        enum: ['consistent', ...DELETE_STYLE],
                     },
                 },
                 additionalProperties: false,

package/build/rules/consistent-emphasis-style.d.ts

@@ -2,9 +2,20 @@
  * @fileoverview Rule to enforce consistent emphasis style.
  * @author lumir(lumirlumir)
  */
-type RuleOptions = [{
-    style: 'consistent' | '*' | '_';
-}];
+type EmphasisStyle = (typeof EMPHASIS_STYLE)[number];
+/**
+ * Options for the `consistent-emphasis-style` rule.
+ */
+type RuleOptions = [
+    {
+        /**
+         * When `style` is set to `'consistent'`, the rule enforces that all emphasis in the document use the same style as the first one encountered.
+         * @default 'consistent'
+         */
+        style: 'consistent' | EmphasisStyle;
+    }
+];
+declare const EMPHASIS_STYLE: readonly ["*", "_"];
 declare const _default: {
     readonly meta: {
         readonly type: "layout";

package/build/rules/consistent-emphasis-style.js

@@ -7,6 +7,10 @@
 // --------------------------------------------------------------------------------
 import { URL_RULE_DOCS } from '../core/constants.js';
 // --------------------------------------------------------------------------------
+// Helper
+// --------------------------------------------------------------------------------
+const EMPHASIS_STYLE = ['*', '_'];
+// --------------------------------------------------------------------------------
 // Rule Definition
 // --------------------------------------------------------------------------------
 export default {
@@ -24,7 +28,7 @@ export default {
                 type: 'object',
                 properties: {
                     style: {
-                        enum: ['consistent', '*', '_'],
+                        enum: ['consistent', ...EMPHASIS_STYLE],
                     },
                 },
                 additionalProperties: false,

package/build/rules/consistent-strong-style.d.ts

@@ -2,9 +2,20 @@
  * @fileoverview Rule to enforce consistent strong style.
  * @author lumir(lumirlumir)
  */
-type RuleOptions = [{
-    style: 'consistent' | '*' | '_';
-}];
+type StrongStyle = (typeof STRONG_STYLE)[number];
+/**
+ * Options for the `consistent-strong-style` rule.
+ */
+type RuleOptions = [
+    {
+        /**
+         * When `style` is set to `'consistent'`, the rule enforces that all strong in the document use the same style as the first one encountered.
+         * @default 'consistent'
+         */
+        style: 'consistent' | StrongStyle;
+    }
+];
+declare const STRONG_STYLE: readonly ["*", "_"];
 declare const _default: {
     readonly meta: {
         readonly type: "layout";

package/build/rules/consistent-strong-style.js

@@ -7,6 +7,10 @@
 // --------------------------------------------------------------------------------
 import { URL_RULE_DOCS } from '../core/constants.js';
 // --------------------------------------------------------------------------------
+// Helper
+// --------------------------------------------------------------------------------
+const STRONG_STYLE = ['*', '_'];
+// --------------------------------------------------------------------------------
 // Rule Definition
 // --------------------------------------------------------------------------------
 export default {
@@ -24,7 +28,7 @@ export default {
                 type: 'object',
                 properties: {
                     style: {
-                        enum: ['consistent', '*', '_'],
+                        enum: ['consistent', ...STRONG_STYLE],
                     },
                 },
                 additionalProperties: false,

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

@@ -2,9 +2,20 @@
  * @fileoverview Rule to enforce consistent thematic break style.
  * @author lumir(lumirlumir)
  */
-type RuleOptions = [{
-    style: string;
-}];
+/**
+ * Options for the `consistent-thematic-break-style` rule.
+ */
+type RuleOptions = [
+    {
+        /**
+         * When `style` is set to `'consistent'`, the rule enforces that all thematic breaks in the document use the same style as the first one encountered.
+         *
+         * You can also specify a particular style by setting style to `'---'`, `'***'`, `'___'`, or any other valid thematic break, which will enforce that all thematic breaks use the specified style. A valid thematic break is a sequence of three or more matching `-`, `*`, or `_` characters, each optionally followed by any number of spaces or tabs.
+         * @default 'consistent'
+         */
+        style: string;
+    }
+];
 declare const _default: {
     readonly meta: {
         readonly type: "layout";

package/build/rules/consistent-unordered-list-style.d.ts

@@ -3,10 +3,24 @@
  * @author hyoban
  */
 import type { ListItem } from 'mdast';
-type UnorderedListStyle = '*' | '+' | '-';
-type RuleOptions = [{
-    style: 'consistent' | 'sublist' | UnorderedListStyle;
-}];
+type UnorderedListStyle = (typeof UNORDERED_LIST_STYLE)[number];
+/**
+ * Options for the `consistent-unordered-list-style` rule.
+ */
+type RuleOptions = [
+    {
+        /**
+         * When `style` is set to `'consistent'`, the rule enforces that all unordered list markers in the document use the same style as the first one encountered.
+         *
+         * When `style` is set to `'sublist'`, the rule enforces that all unordered list markers in sublists use a consistent symbol that differs from that of their parent list, depending on the nesting depth.
+         *
+         * You can also specify a particular style by setting style to `'-'`, `'*'`, or `'+'`, which will enforce that all unordered list markers use the specified style.
+         * @default 'consistent'
+         */
+        style: 'consistent' | 'sublist' | UnorderedListStyle;
+    }
+];
+declare const UNORDERED_LIST_STYLE: readonly ["*", "+", "-"];
 declare const _default: {
     readonly meta: {
         readonly type: "layout";

package/build/rules/consistent-unordered-list-style.js

@@ -6,6 +6,7 @@ import { URL_RULE_DOCS } from '../core/constants.js';
 // --------------------------------------------------------------------------------
 // Helper
 // --------------------------------------------------------------------------------
+const UNORDERED_LIST_STYLE = ['*', '+', '-'];
 /**
  * Get the next unordered list style in sequence.
  * Inspired by [`markdownlint`](https://github.com/DavidAnson/markdownlint/blob/v0.40.0/lib/md004.mjs#L9).
@@ -41,7 +42,7 @@ export default {
                 type: 'object',
                 properties: {
                     style: {
-                        enum: ['consistent', 'sublist', '*', '+', '-'],
+                        enum: ['consistent', 'sublist', ...UNORDERED_LIST_STYLE],
                     },
                 },
                 additionalProperties: false,

package/build/rules/index.d.ts

@@ -223,6 +223,7 @@ declare const _default: {
             readonly messages: {
                 readonly allowHeading: "The level {{ depth }} heading `{{ heading }}` is not in the list of allowed headings. (Allow: {{ allow }}).";
                 readonly disallowHeading: "The level {{ depth }} heading `{{ heading }}` is in the list of disallowed headings. (Disallow: {{ disallow }}).";
+                readonly emptyAllowHeading: "No level {{ depth }} headings are allowed because the list of allowed headings is empty.";
             };
             readonly language: "markdown";
             readonly dialects: ["commonmark", "gfm"];
@@ -232,7 +233,7 @@ declare const _default: {
             Code: import("@eslint/markdown").MarkdownSourceCode;
             RuleOptions: [Record<"h1" | "h2" | "h3" | "h4" | "h5" | "h6", import("./allow-heading.js").HeadingOptions>];
             Node: import("mdast").Node;
-            MessageIds: "allowHeading" | "disallowHeading";
+            MessageIds: "allowHeading" | "disallowHeading" | "emptyAllowHeading";
         }>) => {
             heading(node: import("mdast").Heading): void;
         };
@@ -291,6 +292,7 @@ declare const _default: {
             readonly messages: {
                 readonly allowImageUrl: "The URL `{{ url }}` is not in the list of allowed URLs. (Allow: {{ patterns }}).";
                 readonly disallowImageUrl: "The URL `{{ url }}` is in the list of disallowed URLs. (Disallow: {{ patterns }}).";
+                readonly emptyAllowImageUrl: "The URL `{{ url }}` is not allowed because the list of allowed URLs is empty.";
             };
             readonly language: "markdown";
             readonly dialects: ["commonmark", "gfm"];
@@ -304,7 +306,7 @@ declare const _default: {
                 allowDefinitions: string[];
             }];
             Node: import("mdast").Node;
-            MessageIds: "allowImageUrl" | "disallowImageUrl";
+            MessageIds: "allowImageUrl" | "disallowImageUrl" | "emptyAllowImageUrl";
         }>) => {
             image(node: import("mdast").Image): void;
             html(node: import("mdast").Html): void;
@@ -367,6 +369,7 @@ declare const _default: {
             readonly messages: {
                 readonly allowLinkUrl: "The URL `{{ url }}` is not in the list of allowed URLs. (Allow: {{ patterns }}).";
                 readonly disallowLinkUrl: "The URL `{{ url }}` is in the list of disallowed URLs. (Disallow: {{ patterns }}).";
+                readonly emptyAllowLinkUrl: "The URL `{{ url }}` is not allowed because the list of allowed URLs is empty.";
             };
             readonly language: "markdown";
             readonly dialects: ["commonmark", "gfm"];
@@ -380,7 +383,7 @@ declare const _default: {
                 allowDefinitions: string[];
             }];
             Node: import("mdast").Node;
-            MessageIds: "allowLinkUrl" | "disallowLinkUrl";
+            MessageIds: "allowLinkUrl" | "disallowLinkUrl" | "emptyAllowLinkUrl";
         }>) => {
             link(node: import("mdast").Link): void;
             html(node: import("mdast").Html): void;
@@ -536,7 +539,7 @@ declare const _default: {
             LangOptions: import("@eslint/markdown").MarkdownLanguageOptions;
             Code: import("@eslint/markdown").MarkdownSourceCode;
             RuleOptions: [{
-                style: "consistent" | "~" | "~~";
+                style: "consistent" | ("~" | "~~");
             }];
             Node: import("mdast").Node;
             MessageIds: "style";
@@ -576,7 +579,7 @@ declare const _default: {
             LangOptions: import("@eslint/markdown").MarkdownLanguageOptions;
             Code: import("@eslint/markdown").MarkdownSourceCode;
             RuleOptions: [{
-                style: "consistent" | "*" | "_";
+                style: "consistent" | ("*" | "_");
             }];
             Node: import("mdast").Node;
             MessageIds: "style";
@@ -642,7 +645,7 @@ declare const _default: {
             LangOptions: import("@eslint/markdown").MarkdownLanguageOptions;
             Code: import("@eslint/markdown").MarkdownSourceCode;
             RuleOptions: [{
-                style: "consistent" | "*" | "_";
+                style: "consistent" | ("*" | "_");
             }];
             Node: import("mdast").Node;
             MessageIds: "style";

package/build/rules/no-consecutive-blank-line.d.ts

@@ -3,10 +3,25 @@
  * @author lumir(lumirlumir)
  * @see https://github.com/DavidAnson/markdownlint/blob/main/lib/md012.mjs
  */
-type RuleOptions = [{
-    max: number;
-    skipCode: boolean | string[];
-}];
+/**
+ * Options for the `no-consecutive-blank-line` rule.
+ */
+type RuleOptions = [
+    {
+        /**
+         * Set the maximum number of consecutive blank lines to allow.
+         *
+         * This value must be an integer greater than or equal to `1`.
+         * @default 1
+         */
+        max: number;
+        /**
+         * `true` allows consecutive blank lines in all code blocks, while `string[]` allows consecutive blank lines only in code blocks for the specified languages.
+         * @default true
+         */
+        skipCode: boolean | string[];
+    }
+];
 declare const _default: {
     readonly meta: {
         readonly type: "layout";

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

@@ -2,10 +2,27 @@
  * @fileoverview Rule to disallow control character.
  * @author lumir(lumirlumir)
  */
+/**
+ * Options for the `no-control-character` rule.
+ */
 type RuleOptions = [
     {
+        /**
+         * When specified, specific control characters are allowed if they match one of the characters in this array.
+         *
+         * This is useful for ignoring certain control characters that are intentionally used in the document.
+         * @default []
+         */
         allow: string[];
+        /**
+         * `true` allows control characters in all code blocks, while `string[]` allows control characters only in code blocks for the specified languages.
+         * @default true
+         */
         skipCode: boolean | string[];
+        /**
+         * `true` allows control characters in all inline code.
+         * @default true
+         */
         skipInlineCode: boolean;
     }
 ];

package/build/rules/no-curly-quote.d.ts

@@ -2,11 +2,30 @@
  * @fileoverview Rule to disallow curly quotes(`“`, `”`, `‘` or `’`) in text.
  * @author lumir(lumirlumir)
  */
+/**
+ * Options for the `no-curly-quote` rule.
+ */
 type RuleOptions = [
     {
+        /**
+         * When `checkLeftDoubleQuotationMark` is set to `false`, this rule will not check for the left double quotation mark (`“`).
+         * @default true
+         */
         checkLeftDoubleQuotationMark: boolean;
+        /**
+         * When `checkRightDoubleQuotationMark` is set to `false`, this rule will not check for the right double quotation mark (`”`).
+         * @default true
+         */
         checkRightDoubleQuotationMark: boolean;
+        /**
+         * When `checkLeftSingleQuotationMark` is set to `false`, this rule will not check for the left single quotation mark (`‘`).
+         * @default true
+         */
         checkLeftSingleQuotationMark: boolean;
+        /**
+         * When `checkRightSingleQuotationMark` is set to `false`, this rule will not check for the right single quotation mark (`’`).
+         * @default true
+         */
         checkRightSingleQuotationMark: boolean;
     }
 ];

package/build/rules/no-double-punctuation.d.ts

@@ -2,9 +2,20 @@
  * @fileoverview Rule to disallow double consecutive punctuation in text.
  * @author lumir(lumirlumir)
  */
-type RuleOptions = [{
-    allow: string[];
-}];
+/**
+ * Options for the `no-double-punctuation` rule.
+ */
+type RuleOptions = [
+    {
+        /**
+         * When `allow` is specified, the listed two-character punctuation patterns are ignored by this rule.
+         *
+         * This is useful when punctuation such as `!!` or `?!` is intentionally used for tone or emphasis instead of being treated as a typo.
+         * @default []
+         */
+        allow: string[];
+    }
+];
 type MessageIds = 'noDoublePunctuation' | 'suggestReplaceWithLeft' | 'suggestReplaceWithRight';
 declare const _default: {
     readonly meta: {

package/build/rules/no-double-space.d.ts

@@ -2,9 +2,18 @@
  * @fileoverview Rule to disallow double or multiple consecutive spaces in text, except for leading and trailing spaces.
  * @author lumir(lumirlumir)
  */
-type RuleOptions = [{
-    checkMultipleSpace: boolean;
-}];
+/**
+ * Options for the `no-double-space` rule.
+ */
+type RuleOptions = [
+    {
+        /**
+         * When `checkMultipleSpace` is set to `true`, this rule will also check for multiple consecutive spaces (more than two) within a sentence.
+         * @default false
+         */
+        checkMultipleSpace: boolean;
+    }
+];
 type MessageIds = 'noDoubleSpace' | 'noMultipleSpace';
 declare const _default: {
     readonly meta: {

package/build/rules/no-emoji.d.ts

@@ -2,9 +2,20 @@
  * @fileoverview Rule to disallow emojis in text.
  * @author lumir(lumirlumir)
  */
-type RuleOptions = [{
-    allow: string[];
-}];
+/**
+ * Options for the `no-emoji` rule.
+ */
+type RuleOptions = [
+    {
+        /**
+         * When specified, specific emoji sequences are allowed if they match one of the strings in this array.
+         *
+         * This is useful when a document intentionally uses a small set of raw Unicode emojis while still disallowing all others.
+         * @default []
+         */
+        allow: string[];
+    }
+];
 declare const _default: {
     readonly meta: {
         readonly type: "problem";

package/build/rules/no-git-conflict-marker.d.ts

@@ -2,9 +2,18 @@
  * @fileoverview Rule to disallow git conflict markers.
  * @author lumir(lumirlumir)
  */
-type RuleOptions = [{
-    skipCode: boolean | string[];
-}];
+/**
+ * Options for the `no-git-conflict-marker` rule.
+ */
+type RuleOptions = [
+    {
+        /**
+         * `true` allows Git conflict markers in all code blocks, while `string[]` allows Git conflict markers only in code blocks for the specified languages.
+         * @default true
+         */
+        skipCode: boolean | string[];
+    }
+];
 declare const _default: {
     readonly meta: {
         readonly type: "problem";

package/build/rules/no-irregular-dash.d.ts

@@ -2,10 +2,27 @@
  * @fileoverview Rule to disallow irregular dash.
  * @author lumir(lumirlumir)
  */
+/**
+ * Options for the `no-irregular-dash` rule.
+ */
 type RuleOptions = [
     {
+        /**
+         * When specified, specific irregular dash characters are allowed if they match one of the characters in this array.
+         *
+         * This is useful for ignoring certain irregular dashes that are intentionally used in the document.
+         * @default []
+         */
         allow: string[];
+        /**
+         * `true` allows irregular dashes in all code blocks, while `string[]` allows irregular dashes only in code blocks for the specified languages.
+         * @default true
+         */
         skipCode: boolean | string[];
+        /**
+         * `true` allows irregular dashes in all inline code.
+         * @default true
+         */
         skipInlineCode: boolean;
     }
 ];

package/build/rules/no-irregular-whitespace.d.ts

@@ -2,10 +2,27 @@
  * @fileoverview Rule to disallow irregular whitespace.
  * @author lumir(lumirlumir)
  */
+/**
+ * Options for the `no-irregular-whitespace` rule.
+ */
 type RuleOptions = [
     {
+        /**
+         * When specified, specific irregular whitespaces are allowed if they match one of the characters in this array.
+         *
+         * This is useful for ignoring certain irregular whitespaces that are intentionally used in the document.
+         * @default []
+         */
         allow: string[];
+        /**
+         * `true` allows irregular whitespaces in all code blocks, while `string[]` allows irregular whitespaces only in code blocks for the specified languages.
+         * @default true
+         */
         skipCode: boolean | string[];
+        /**
+         * `true` allows irregular whitespaces in all inline code.
+         * @default true
+         */
         skipInlineCode: boolean;
     }
 ];

package/build/rules/no-tab.d.ts

@@ -2,10 +2,25 @@
  * @fileoverview Rule to disallow tab characters.
  * @author lumir(lumirlumir)
  */
+/**
+ * Options for the `no-tab` rule.
+ */
 type RuleOptions = [
     {
+        /**
+         * `true` allows tabs in all code blocks, while `string[]` allows tabs only in code blocks for the specified languages.
+         * @default true
+         */
         skipCode: boolean | string[];
+        /**
+         * `true` allows tabs in all inline code.
+         * @default true
+         */
         skipInlineCode: boolean;
+        /**
+         * Number of spaces to replace each tab with when applying an autofix.
+         * @default 4
+         */
         tabWidth: number;
     }
 ];

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

@@ -2,9 +2,18 @@
  * @fileoverview Rule to disallow trailing punctuation in headings.
  * @author Ga eun Lee(tooth-is-silver)
  */
-type RuleOptions = [{
-    punctuation: string[];
-}];
+/**
+ * Options for the `no-trailing-heading-punctuation` rule.
+ */
+type RuleOptions = [
+    {
+        /**
+         * Specifies the characters that are not allowed at the end of headings.
+         * @default ['.', ',', ';', ':', '!', '。', '，', '；', '：', '！']
+         */
+        punctuation: string[];
+    }
+];
 declare const _default: {
     readonly meta: {
         readonly type: "problem";

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

@@ -6,16 +6,14 @@
 // Import
 // --------------------------------------------------------------------------------
 import { escapeStringRegexp } from '../core/utils/index.js';
-import { URL_RULE_DOCS } from '../core/constants.js';
+import { URL_RULE_DOCS, punctuation as defaultPunctuation, gemojiRegex, } 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})+):$/;
+const trailingGemojiRegex = new RegExp(`${gemojiRegex.source}$`, gemojiRegex.flags);
 /**
  * Regular expression for identifying an HTML entity at the end of a line.
  * - NOTE: These patterns are based on the `markdownlint`.
@@ -55,7 +53,7 @@ export default {
         ],
         defaultOptions: [
             {
-                punctuation: ['.', ',', ';', ':', '!', '。', '，', '；', '：', '！'],
+                punctuation: [...defaultPunctuation],
             },
         ],
         messages: {

package/build/rules/require-heading-id.d.ts

@@ -3,11 +3,32 @@
  * @author lumir(lumirlumir)
  */
 import type { Heading } from 'mdast';
+/**
+ * Options for the `require-heading-id` rule.
+ */
 type RuleOptions = [
+    /**
+     * `'always'` enforces the presence of heading IDs. `'never'` disallows heading IDs.
+     * @default 'always'
+     */
     'always' | 'never',
     {
+        /**
+         * The left delimiter to use for heading IDs.
+         * @default '{'
+         */
         leftDelimiter: string;
+        /**
+         * The right delimiter to use for heading IDs.
+         * @default '}'
+         */
         rightDelimiter: string;
+        /**
+         * An array of heading depths to ignore.
+         *
+         * For example, `[1, 2]` would ignore level 1 and level 2 headings.
+         * @default []
+         */
         allowDepths: Heading['depth'][];
     }
 ];

package/build/rules/require-image-title.d.ts

@@ -3,9 +3,20 @@
  * @author lumir(lumirlumir)
  */
 import type { Definition } from 'mdast';
-type RuleOptions = [{
-    allowDefinitions: string[];
-}];
+/**
+ * Options for the `require-image-title` rule.
+ */
+type RuleOptions = [
+    {
+        /**
+         * When specified, specific definitions are allowed if they match one of the identifiers in this array.
+         *
+         * This is useful for ignoring definitions that are intentionally left without titles, such as comments or placeholders.
+         * @default ['//']
+         */
+        allowDefinitions: string[];
+    }
+];
 declare const _default: {
     readonly meta: {
         readonly type: "problem";

package/build/rules/require-link-title.d.ts

@@ -3,9 +3,20 @@
  * @author lumir(lumirlumir)
  */
 import type { Definition } from 'mdast';
-type RuleOptions = [{
-    allowDefinitions: string[];
-}];
+/**
+ * Options for the `require-link-title` rule.
+ */
+type RuleOptions = [
+    {
+        /**
+         * When specified, specific definitions are allowed if they match one of the identifiers in this array.
+         *
+         * This is useful for ignoring definitions that are intentionally left without titles, such as comments or placeholders.
+         * @default ['//']
+         */
+        allowDefinitions: string[];
+    }
+];
 declare const _default: {
     readonly meta: {
         readonly type: "problem";

package/package.json

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