eslint-markdown 0.11.0 → 0.12.0

package/build/configs/all.d.ts

@@ -1,7 +1,9 @@
 /**
- * @import { ESLint, Linter } from "eslint";
+ * @fileoverview `all` configuration.
+ * WARNING: This file is autogenerated using the `scripts/build-config.js`
  */
-/** @param {ESLint.Plugin} plugin */
+import markdown from '@eslint/markdown';
+import type { ESLint } from 'eslint';
 export default function all(plugin: ESLint.Plugin): {
     readonly name: "md/all";
     readonly files: ["**/*.md"];
@@ -14,6 +16,7 @@ export default function all(plugin: ESLint.Plugin): {
     };
     readonly language: "markdown/gfm";
     readonly rules: {
+        readonly 'md/allow-heading': "error";
         readonly 'md/allow-image-url': "error";
         readonly 'md/allow-link-url': "error";
         readonly 'md/code-lang-shorthand': "error";
@@ -40,5 +43,3 @@ export default function all(plugin: ESLint.Plugin): {
         readonly 'md/require-link-title': "error";
     };
 };
-import type { ESLint } from "eslint";
-import markdown from '@eslint/markdown';

package/build/configs/all.js

@@ -0,0 +1,54 @@
+/**
+ * @fileoverview `all` configuration.
+ * WARNING: This file is autogenerated using the `scripts/build-config.js`
+ */
+// --------------------------------------------------------------------------------
+// Import
+// --------------------------------------------------------------------------------
+import markdown from '@eslint/markdown';
+// --------------------------------------------------------------------------------
+// Export
+// --------------------------------------------------------------------------------
+export default function all(plugin) {
+    return {
+        name: 'md/all',
+        files: ['**/*.md'],
+        plugins: {
+            markdown,
+            get md() {
+                return plugin;
+            },
+        },
+        languageOptions: {
+            frontmatter: 'yaml',
+        },
+        language: 'markdown/gfm',
+        rules: {
+            'md/allow-heading': 'error',
+            'md/allow-image-url': 'error',
+            'md/allow-link-url': 'error',
+            'md/code-lang-shorthand': 'error',
+            'md/consistent-code-style': 'error',
+            'md/consistent-delete-style': 'error',
+            'md/consistent-emphasis-style': 'error',
+            'md/consistent-inline-code-style': 'error',
+            'md/consistent-strong-style': 'error',
+            'md/consistent-thematic-break-style': 'error',
+            'md/consistent-unordered-list-style': 'error',
+            'md/no-consecutive-blank-line': 'error',
+            'md/no-control-character': 'error',
+            'md/no-curly-quote': 'error',
+            'md/no-double-punctuation': 'error',
+            'md/no-double-space': 'error',
+            'md/no-emoji': 'error',
+            'md/no-git-conflict-marker': 'error',
+            'md/no-irregular-dash': 'error',
+            '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/build/configs/base.d.ts

@@ -1,7 +1,9 @@
 /**
- * @import { ESLint, Linter } from "eslint";
+ * @fileoverview `base` configuration.
+ * WARNING: This file is autogenerated using the `scripts/build-config.js`
  */
-/** @param {ESLint.Plugin} plugin */
+import markdown from '@eslint/markdown';
+import type { ESLint } from 'eslint';
 export default function base(plugin: ESLint.Plugin): {
     readonly name: "md/base";
     readonly files: ["**/*.md"];
@@ -14,5 +16,3 @@ export default function base(plugin: ESLint.Plugin): {
     };
     readonly language: "markdown/gfm";
 };
-import type { ESLint } from "eslint";
-import markdown from '@eslint/markdown';

package/build/configs/base.js

@@ -0,0 +1,27 @@
+/**
+ * @fileoverview `base` configuration.
+ * WARNING: This file is autogenerated using the `scripts/build-config.js`
+ */
+// --------------------------------------------------------------------------------
+// Import
+// --------------------------------------------------------------------------------
+import markdown from '@eslint/markdown';
+// --------------------------------------------------------------------------------
+// Export
+// --------------------------------------------------------------------------------
+export default function base(plugin) {
+    return {
+        name: 'md/base',
+        files: ['**/*.md'],
+        plugins: {
+            markdown,
+            get md() {
+                return plugin;
+            },
+        },
+        languageOptions: {
+            frontmatter: 'yaml',
+        },
+        language: 'markdown/gfm',
+    };
+}

package/{src → build}/configs/index.js

@@ -1,8 +1,6 @@
 /* eslint sort-imports: 'error', sort-keys: 'error' */
-
 import all from './all.js';
 import base from './base.js';
 import recommended from './recommended.js';
 import stylistic from './stylistic.js';
-
 export { all, base, recommended, stylistic };

package/build/configs/recommended.d.ts

@@ -1,7 +1,9 @@
 /**
- * @import { ESLint, Linter } from "eslint";
+ * @fileoverview `recommended` configuration.
+ * WARNING: This file is autogenerated using the `scripts/build-config.js`
  */
-/** @param {ESLint.Plugin} plugin */
+import markdown from '@eslint/markdown';
+import type { ESLint } from 'eslint';
 export default function recommended(plugin: ESLint.Plugin): {
     readonly name: "md/recommended";
     readonly files: ["**/*.md"];
@@ -23,5 +25,3 @@ export default function recommended(plugin: ESLint.Plugin): {
         readonly 'md/no-irregular-whitespace': "error";
     };
 };
-import type { ESLint } from "eslint";
-import markdown from '@eslint/markdown';

package/build/configs/recommended.js

@@ -0,0 +1,36 @@
+/**
+ * @fileoverview `recommended` configuration.
+ * WARNING: This file is autogenerated using the `scripts/build-config.js`
+ */
+// --------------------------------------------------------------------------------
+// Import
+// --------------------------------------------------------------------------------
+import markdown from '@eslint/markdown';
+// --------------------------------------------------------------------------------
+// Export
+// --------------------------------------------------------------------------------
+export default function recommended(plugin) {
+    return {
+        name: 'md/recommended',
+        files: ['**/*.md'],
+        plugins: {
+            markdown,
+            get md() {
+                return plugin;
+            },
+        },
+        languageOptions: {
+            frontmatter: 'yaml',
+        },
+        language: 'markdown/gfm',
+        rules: {
+            'md/code-lang-shorthand': 'error',
+            'md/no-control-character': 'error',
+            'md/no-curly-quote': 'error',
+            'md/no-double-space': 'error',
+            'md/no-git-conflict-marker': 'error',
+            'md/no-irregular-dash': 'error',
+            'md/no-irregular-whitespace': 'error',
+        },
+    };
+}

package/build/configs/stylistic.d.ts

@@ -1,7 +1,9 @@
 /**
- * @import { ESLint, Linter } from "eslint";
+ * @fileoverview `stylistic` configuration.
+ * WARNING: This file is autogenerated using the `scripts/build-config.js`
  */
-/** @param {ESLint.Plugin} plugin */
+import markdown from '@eslint/markdown';
+import type { ESLint } from 'eslint';
 export default function stylistic(plugin: ESLint.Plugin): {
     readonly name: "md/stylistic";
     readonly files: ["**/*.md"];
@@ -25,5 +27,3 @@ export default function stylistic(plugin: ESLint.Plugin): {
         readonly 'md/no-tab': "error";
     };
 };
-import type { ESLint } from "eslint";
-import markdown from '@eslint/markdown';

package/build/configs/stylistic.js

@@ -0,0 +1,38 @@
+/**
+ * @fileoverview `stylistic` configuration.
+ * WARNING: This file is autogenerated using the `scripts/build-config.js`
+ */
+// --------------------------------------------------------------------------------
+// Import
+// --------------------------------------------------------------------------------
+import markdown from '@eslint/markdown';
+// --------------------------------------------------------------------------------
+// Export
+// --------------------------------------------------------------------------------
+export default function stylistic(plugin) {
+    return {
+        name: 'md/stylistic',
+        files: ['**/*.md'],
+        plugins: {
+            markdown,
+            get md() {
+                return plugin;
+            },
+        },
+        languageOptions: {
+            frontmatter: 'yaml',
+        },
+        language: 'markdown/gfm',
+        rules: {
+            'md/consistent-code-style': 'error',
+            'md/consistent-delete-style': 'error',
+            'md/consistent-emphasis-style': 'error',
+            'md/consistent-inline-code-style': 'error',
+            'md/consistent-strong-style': 'error',
+            'md/consistent-thematic-break-style': 'error',
+            'md/consistent-unordered-list-style': 'error',
+            'md/no-consecutive-blank-line': 'error',
+            'md/no-tab': 'error',
+        },
+    };
+}

package/build/core/constants.d.ts

@@ -1,5 +1,6 @@
-/** @type {'eslint-markdown'} */
-export const PKG_NAME: "eslint-markdown";
-/** @satisfies {string} */
-export const PKG_VERSION: string;
-export function URL_RULE_DOCS(ruleName?: string): string;
+/**
+ * @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;

package/{src → build}/core/constants.js

@@ -1,20 +1,13 @@
 /**
  * @fileoverview This file declares constants used throughout the `eslint-markdown` package.
  */
-
 // --------------------------------------------------------------------------------
 // Import
 // --------------------------------------------------------------------------------
-
 import pkg from '../../package.json' with { type: 'json' };
-
 // --------------------------------------------------------------------------------
 // Export
 // --------------------------------------------------------------------------------
-
-/** @type {'eslint-markdown'} */
-export const PKG_NAME = /** @type {'eslint-markdown'} */ (pkg.name);
-/** @satisfies {string} */
+export const PKG_NAME = pkg.name;
 export const PKG_VERSION = pkg.version;
-/** Get the URL for the rule documentation based on the rule name. @param {string} [ruleName] */
 export const URL_RULE_DOCS = (ruleName = '') => `${pkg.homepage}/docs/rules/${ruleName}`;

package/build/core/types.js

@@ -0,0 +1,4 @@
+/**
+ * @fileoverview Define common types.
+ */
+export {};

package/build/core/{ast → utils}/escape-string-regexp.d.ts

@@ -7,8 +7,8 @@
  *
  * 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.
+ * @param string A string to escape.
+ * @returns An escaped string.
  * @example
  * ```js
  * import escapeStringRegexp from 'path/to/escape-string-regexp.js';

package/{src/core/ast → build/core/utils}/escape-string-regexp.js

@@ -2,7 +2,6 @@
  * @fileoverview Utility to escape `RegExp` special characters.
  * @see https://github.com/sindresorhus/escape-string-regexp/tree/v5.0.0
  */
-
 /*
  * MIT License
  *
@@ -26,18 +25,16 @@
  * 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.
+ * @param string A string to escape.
+ * @returns An escaped string.
  * @example
  * ```js
  * import escapeStringRegexp from 'path/to/escape-string-regexp.js';
@@ -49,8 +46,8 @@
  * ```
  */
 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');
+    // 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/build/core/utils/html.d.ts

@@ -0,0 +1,11 @@
+/**
+ * @fileoverview HTML AST utilities.
+ */
+import type { DefaultTreeAdapterTypes } from 'parse5';
+/**
+ * Mimics the behavior of `getElementsByTagName` in the DOM API.
+ * @param html The HTML string to parse.
+ * @param tagName The tag name to search for (case-insensitive).
+ * @returns Matched elements.
+ */
+export default function getElementsByTagName(html: string, tagName: string): (DefaultTreeAdapterTypes.Element | DefaultTreeAdapterTypes.Template)[];

package/build/core/utils/html.js

@@ -0,0 +1,31 @@
+/**
+ * @fileoverview HTML AST utilities.
+ */
+// --------------------------------------------------------------------------------
+// Import
+// --------------------------------------------------------------------------------
+import { parseFragment } from 'parse5';
+// --------------------------------------------------------------------------------
+// Export
+// --------------------------------------------------------------------------------
+/**
+ * Mimics the behavior of `getElementsByTagName` in the DOM API.
+ * @param html The HTML string to parse.
+ * @param tagName The tag name to search for (case-insensitive).
+ * @returns Matched elements.
+ */
+export default function getElementsByTagName(html, tagName) {
+    const ast = parseFragment(html, { sourceCodeLocationInfo: true });
+    const normalizedTagName = tagName.toLowerCase();
+    const nodes = [];
+    function visit(node) {
+        if ('tagName' in node && node.tagName === normalizedTagName) {
+            nodes.push(node);
+        }
+        if ('childNodes' in node) {
+            node.childNodes.forEach(visit);
+        }
+    }
+    visit(ast);
+    return nodes;
+}

package/{src/core/ast → build/core/utils}/index.js

@@ -2,5 +2,4 @@ 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 };

package/build/core/utils/is-blank-line.d.ts

@@ -0,0 +1,12 @@
+/**
+ * @fileoverview Check if a line is blank.
+ * @see https://spec.commonmark.org/0.31.2/#blank-line
+ */
+/**
+ * Check if a line is blank.
+ * - NOTE: The `blockquoteDepth` parameter is zero-based: `0` means one blockquote marker, `1` means two, and so on.
+ * @param str Line string.
+ * @param blockquoteDepth The depth of blockquotes. Default is `-1`.
+ * @returns `true` if the line is blank. `false` otherwise.
+ */
+export default function isBlankLine(str: string, blockquoteDepth?: number): boolean;

package/{src/core/ast → build/core/utils}/is-blank-line.js

@@ -2,42 +2,34 @@
  * @fileoverview Check if a line is blank.
  * @see https://spec.commonmark.org/0.31.2/#blank-line
  */
-
 // --------------------------------------------------------------------------------
 // Helper
 // --------------------------------------------------------------------------------
-
 const whitespaceChars = new Set([' ', '\t']);
 const blockquoteChar = '>';
-
 // --------------------------------------------------------------------------------
 // Export
 // --------------------------------------------------------------------------------
-
 /**
  * Check if a line is blank.
  * - NOTE: The `blockquoteDepth` parameter is zero-based: `0` means one blockquote marker, `1` means two, and so on.
- * @param {string} str Line string.
- * @param {number} [blockquoteDepth] The depth of blockquotes. Default is `-1`.
- * @returns {boolean} `true` if the line is blank. `false` otherwise.
+ * @param str Line string.
+ * @param blockquoteDepth The depth of blockquotes. Default is `-1`.
+ * @returns `true` if the line is blank. `false` otherwise.
  */
 export default function isBlankLine(str, blockquoteDepth = -1) {
-  // `.length` is cached for performance.
-  const strLength = str.length;
-  let remainingBlockquotes = blockquoteDepth + 1;
-
-  for (let i = 0; i < strLength; i++) {
-    const char = str[i];
-
-    if (!whitespaceChars.has(char)) {
-      if (remainingBlockquotes > 0 && char === blockquoteChar) {
-        remainingBlockquotes--;
-        continue;
-      }
-
-      return false;
+    // `.length` is cached for performance.
+    const strLength = str.length;
+    let remainingBlockquotes = blockquoteDepth + 1;
+    for (let i = 0; i < strLength; i++) {
+        const char = str[i];
+        if (!whitespaceChars.has(char)) {
+            if (remainingBlockquotes > 0 && char === blockquoteChar) {
+                remainingBlockquotes--;
+                continue;
+            }
+            return false;
+        }
     }
-  }
-
-  return true;
+    return true;
 }

package/build/core/{ast → utils}/skip-ranges.d.ts

@@ -1,23 +1,22 @@
 /**
  * @fileoverview Class to manage skip ranges.
  */
-/**
- * @import { SourceRange } from '@eslint/core';
- */
+import type { AST } from 'eslint';
+type SourceRange = AST.Range;
 /**
  * Class to manage skip ranges.
  */
 export default class SkipRanges {
+    #private;
     /**
      * Push a `range` to the set of skip ranges. (Method chaining supported.)
-     * @param {SourceRange} range
+     * @param range Source range to skip.
      */
     push(range: SourceRange): this;
     /**
      * Check whether the `offset` is included in any skip ranges.
-     * @param {number} offset
+     * @param offset Offset to check.
      */
     includes(offset: number): boolean;
-    #private;
 }
-import type { SourceRange } from '@eslint/core';
+export {};

package/build/core/utils/skip-ranges.js

@@ -0,0 +1,33 @@
+/**
+ * @fileoverview Class to manage skip ranges.
+ */
+// --------------------------------------------------------------------------------
+// Export
+// --------------------------------------------------------------------------------
+/**
+ * Class to manage skip ranges.
+ */
+export default class SkipRanges {
+    // ------------------------------------------------------------------------------
+    // Private Property
+    // ------------------------------------------------------------------------------
+    #skipRanges = new Set();
+    // ------------------------------------------------------------------------------
+    // Public Method
+    // ------------------------------------------------------------------------------
+    /**
+     * Push a `range` to the set of skip ranges. (Method chaining supported.)
+     * @param range Source range to skip.
+     */
+    push(range) {
+        this.#skipRanges.add(range);
+        return this;
+    }
+    /**
+     * Check whether the `offset` is included in any skip ranges.
+     * @param offset Offset to check.
+     */
+    includes(offset) {
+        return [...this.#skipRanges].some(skipRange => skipRange[0] <= offset && offset < skipRange[1]);
+    }
+}