eslint-markdown 0.0.0-canary.0 → 0.1.0

package/README.md

@@ -0,0 +1,46 @@
+# eslint-markdown
+
+[![lint](https://img.shields.io/github/actions/workflow/status/lumirlumir/npm-eslint-markdown/lint.yml?label=lint&color=6358d4&labelColor=333333&logo=github)](https://github.com/lumirlumir/npm-eslint-markdown/actions/workflows/lint.yml)
+[![test](https://img.shields.io/github/actions/workflow/status/lumirlumir/npm-eslint-markdown/test.yml?label=test&color=6358d4&labelColor=333333&logo=github)](https://github.com/lumirlumir/npm-eslint-markdown/actions/workflows/test.yml)
+[![test-cross-platform](https://img.shields.io/github/actions/workflow/status/lumirlumir/npm-eslint-markdown/test-cross-platform.yml?label=test-cross-platform&color=6358d4&labelColor=333333&logo=github)](https://github.com/lumirlumir/npm-eslint-markdown/actions/workflows/test-cross-platform.yml)
+[![codecov](https://img.shields.io/codecov/c/gh/lumirlumir/npm-eslint-markdown?token=LJMUst9eR3&label=Codecov&color=6358d4&labelColor=333333&logo=codecov)](https://codecov.io/gh/lumirlumir/npm-eslint-markdown)
+![Node Current](https://img.shields.io/node/v/eslint-markdown?color=6358d4&labelColor=333333&logo=node.js)
+
+[![npm package eslint-markdown latest version](https://img.shields.io/npm/v/eslint-markdown?label=eslint-markdown@latest&color=6358d4&labelColor=333333&logo=npm)](https://www.npmjs.com/package/eslint-markdown)
+[![npm package eslint-markdown next version](https://img.shields.io/npm/v/eslint-markdown/next?label=eslint-markdown@next&color=6358d4&labelColor=333333&logo=npm)](https://www.npmjs.com/package/eslint-markdown)
+
+> [!IMPORTANT]
+>
+> If you like this package, please give it a star on [GitHub](https://github.com/lumirlumir/npm-eslint-markdown)!⭐<br/>
+> Your support helps us improve and maintain the project.
+
+Lint your Markdown with ESLint.🛠️
+
+## Documentation
+
+For full documentation, see the [official documentation of the `eslint-markdown`](https://eslint-markdown.lumir.page).
+
+- [Installation](https://eslint-markdown.lumir.page/docs/get-started/installation)
+- [Configurations](https://eslint-markdown.lumir.page/docs/get-started/configurations)
+- [Migration Guide](https://eslint-markdown.lumir.page/docs/get-started/migration)
+- [Rules](https://eslint-markdown.lumir.page/docs/rules)
+
+## Code of Conduct
+
+See [Code of Conduct](https://github.com/lumirlumir/.github/blob/main/CODE_OF_CONDUCT.md#contributor-covenant-code-of-conduct).
+
+## Change Log
+
+See [Change Log](https://github.com/lumirlumir/npm-eslint-markdown/blob/main/CHANGELOG.md).
+
+## Versioning
+
+See [Versioning](https://eslint-markdown.lumir.page/docs/get-started/versioning).
+
+## Security
+
+See [Security](https://github.com/lumirlumir/.github/blob/main/SECURITY.md#security).
+
+## License
+
+[MIT](https://github.com/lumirlumir/npm-eslint-markdown/blob/main/LICENSE.md)

package/build/configs/all.d.ts

@@ -0,0 +1,37 @@
+/**
+ * @import { ESLint, Linter } from "eslint";
+ */
+/** @param {ESLint.Plugin} plugin */
+export default function all(plugin: ESLint.Plugin): {
+    readonly name: "md/all";
+    readonly files: ["**/*.md"];
+    readonly plugins: {
+        readonly markdown: typeof markdown;
+        readonly md: import("@eslint/core", { with: { "resolution-mode": "require" } }).Plugin;
+    };
+    readonly languageOptions: {
+        readonly frontmatter: "yaml";
+    };
+    readonly language: "markdown/gfm";
+    readonly rules: {
+        readonly 'md/allow-image-url': "error";
+        readonly 'md/allow-link-url': "error";
+        readonly 'md/code-lang-shorthand': "error";
+        readonly 'md/consistent-delete-style': "error";
+        readonly 'md/consistent-emphasis-style': "error";
+        readonly 'md/consistent-strong-style': "error";
+        readonly 'md/consistent-thematic-break-style': "error";
+        readonly 'md/no-control-character': "error";
+        readonly 'md/no-curly-quote': "error";
+        readonly 'md/no-double-space': "error";
+        readonly 'md/no-emoji': "error";
+        readonly 'md/no-git-conflict-marker': "error";
+        readonly 'md/no-irregular-dash': "error";
+        readonly 'md/no-irregular-whitespace': "error";
+        readonly 'md/no-url-trailing-slash': "error";
+        readonly 'md/require-image-title': "error";
+        readonly 'md/require-link-title': "error";
+    };
+};
+import type { ESLint } from "eslint";
+import markdown from '@eslint/markdown';

package/build/configs/base.d.ts

@@ -0,0 +1,18 @@
+/**
+ * @import { ESLint, Linter } from "eslint";
+ */
+/** @param {ESLint.Plugin} plugin */
+export default function base(plugin: ESLint.Plugin): {
+    readonly name: "md/base";
+    readonly files: ["**/*.md"];
+    readonly plugins: {
+        readonly markdown: typeof markdown;
+        readonly md: import("@eslint/core", { with: { "resolution-mode": "require" } }).Plugin;
+    };
+    readonly languageOptions: {
+        readonly frontmatter: "yaml";
+    };
+    readonly language: "markdown/gfm";
+};
+import type { ESLint } from "eslint";
+import markdown from '@eslint/markdown';

package/build/configs/index.d.ts

@@ -0,0 +1,5 @@
+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

@@ -0,0 +1,27 @@
+/**
+ * @import { ESLint, Linter } from "eslint";
+ */
+/** @param {ESLint.Plugin} plugin */
+export default function recommended(plugin: ESLint.Plugin): {
+    readonly name: "md/recommended";
+    readonly files: ["**/*.md"];
+    readonly plugins: {
+        readonly markdown: typeof markdown;
+        readonly md: import("@eslint/core", { with: { "resolution-mode": "require" } }).Plugin;
+    };
+    readonly languageOptions: {
+        readonly frontmatter: "yaml";
+    };
+    readonly language: "markdown/gfm";
+    readonly rules: {
+        readonly 'md/code-lang-shorthand': "error";
+        readonly 'md/no-control-character': "error";
+        readonly 'md/no-curly-quote': "error";
+        readonly 'md/no-double-space': "error";
+        readonly 'md/no-git-conflict-marker': "error";
+        readonly 'md/no-irregular-dash': "error";
+        readonly 'md/no-irregular-whitespace': "error";
+    };
+};
+import type { ESLint } from "eslint";
+import markdown from '@eslint/markdown';

package/build/configs/stylistic.d.ts

@@ -0,0 +1,24 @@
+/**
+ * @import { ESLint, Linter } from "eslint";
+ */
+/** @param {ESLint.Plugin} plugin */
+export default function stylistic(plugin: ESLint.Plugin): {
+    readonly name: "md/stylistic";
+    readonly files: ["**/*.md"];
+    readonly plugins: {
+        readonly markdown: typeof markdown;
+        readonly md: import("@eslint/core", { with: { "resolution-mode": "require" } }).Plugin;
+    };
+    readonly languageOptions: {
+        readonly frontmatter: "yaml";
+    };
+    readonly language: "markdown/gfm";
+    readonly rules: {
+        readonly 'md/consistent-delete-style': "error";
+        readonly 'md/consistent-emphasis-style': "error";
+        readonly 'md/consistent-strong-style': "error";
+        readonly 'md/consistent-thematic-break-style': "error";
+    };
+};
+import type { ESLint } from "eslint";
+import markdown from '@eslint/markdown';

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

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

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

@@ -0,0 +1,3 @@
+import getElementsByTagName from './html.js';
+import SkipRanges from './skip-ranges.js';
+export { getElementsByTagName, SkipRanges };

package/build/core/ast/skip-ranges.d.ts

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

package/build/core/constants.d.ts

@@ -0,0 +1,5 @@
+/** @satisfies {string} */
+export const PKG_NAME: "eslint-markdown";
+/** @satisfies {string} */
+export const PKG_VERSION: string;
+export function URL_RULE_DOCS(ruleName?: string): string;

package/build/core/tests/get-file-name.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Get the file name of the module.
+ * @param {string} importMetaUrl The absolute `file:` URL of the module.
+ * @returns {string} The file name of the module.
+ */
+export default function getFileName(importMetaUrl: string): string;

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

@@ -0,0 +1,3 @@
+import getFileName from './get-file-name.js';
+import ruleTester from './rule-tester.js';
+export { getFileName, ruleTester };

package/build/core/tests/rule-tester.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Markdown rule tester.
+ * @param {string} ruleName Rule name.
+ * @param {RuleModule<RuleOptions, MessageIds>} rule Rule module.
+ * @param {Tests} tests Tests.
+ */
+export default function ruleTester(ruleName: string, rule: RuleModule<RuleOptions, MessageIds>, tests: Tests): void;
+export type RuleOptions = MarkdownRuleDefinitionTypeOptions["RuleOptions"];
+export type MessageIds = MarkdownRuleDefinitionTypeOptions["MessageIds"];
+export type Tests = Parameters<RuleTester["run"]>[2];
+import type { RuleModule } from '../types.js';
+import type { MarkdownRuleDefinitionTypeOptions } from '@eslint/markdown';
+import { RuleTester } from 'eslint';

package/build/core/types.d.ts

@@ -0,0 +1,14 @@
+/**
+ * @fileoverview Define common types.
+ */
+import type { MarkdownRuleDefinition, MarkdownRuleDefinitionTypeOptions } from '@eslint/markdown';
+export type RuleModule<RuleOptions extends MarkdownRuleDefinitionTypeOptions['RuleOptions'], MessageIds extends MarkdownRuleDefinitionTypeOptions['MessageIds']> = MarkdownRuleDefinition<{
+    RuleOptions: RuleOptions;
+    MessageIds: MessageIds;
+    ExtRuleDocs: Partial<{
+        /**
+         * Indicates whether this rule is part of the stylistic configuration.
+         */
+        stylistic: boolean;
+    }>;
+}>;

package/build/index.d.ts

@@ -0,0 +1,17 @@
+export default plugin;
+declare namespace plugin {
+    export namespace meta {
+        export { name };
+        export { version };
+    }
+    export { rules };
+    export namespace configs {
+        const all: ReturnType<typeof import("./configs/all.js").default>;
+        const base: ReturnType<typeof import("./configs/base.js").default>;
+        const recommended: ReturnType<typeof import("./configs/recommended.js").default>;
+        const stylistic: ReturnType<typeof import("./configs/stylistic.js").default>;
+    }
+}
+import { PKG_NAME as name } from './core/constants.js';
+import { PKG_VERSION as version } from './core/constants.js';
+import rules from './rules/index.js';

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

@@ -0,0 +1,141 @@
+declare const _default: {
+    meta: {
+        type: "problem";
+        docs: {
+            description: string;
+            url: string;
+            recommended: boolean;
+            stylistic: false;
+        };
+        schema: {
+            type: "object";
+            properties: {
+                h1: {
+                    oneOf: ({
+                        enum: false[];
+                        type?: never;
+                        items?: never;
+                        uniqueItems?: never;
+                    } | {
+                        type: "array";
+                        items: {
+                            type: "string";
+                        };
+                        uniqueItems: true;
+                        enum?: never;
+                    })[];
+                };
+                h2: {
+                    oneOf: ({
+                        enum: false[];
+                        type?: never;
+                        items?: never;
+                        uniqueItems?: never;
+                    } | {
+                        type: "array";
+                        items: {
+                            type: "string";
+                        };
+                        uniqueItems: true;
+                        enum?: never;
+                    })[];
+                };
+                h3: {
+                    oneOf: ({
+                        enum: false[];
+                        type?: never;
+                        items?: never;
+                        uniqueItems?: never;
+                    } | {
+                        type: "array";
+                        items: {
+                            type: "string";
+                        };
+                        uniqueItems: true;
+                        enum?: never;
+                    })[];
+                };
+                h4: {
+                    oneOf: ({
+                        enum: false[];
+                        type?: never;
+                        items?: never;
+                        uniqueItems?: never;
+                    } | {
+                        type: "array";
+                        items: {
+                            type: "string";
+                        };
+                        uniqueItems: true;
+                        enum?: never;
+                    })[];
+                };
+                h5: {
+                    oneOf: ({
+                        enum: false[];
+                        type?: never;
+                        items?: never;
+                        uniqueItems?: never;
+                    } | {
+                        type: "array";
+                        items: {
+                            type: "string";
+                        };
+                        uniqueItems: true;
+                        enum?: never;
+                    })[];
+                };
+                h6: {
+                    oneOf: ({
+                        enum: false[];
+                        type?: never;
+                        items?: never;
+                        uniqueItems?: never;
+                    } | {
+                        type: "array";
+                        items: {
+                            type: "string";
+                        };
+                        uniqueItems: true;
+                        enum?: never;
+                    })[];
+                };
+            };
+            additionalProperties: false;
+        }[];
+        defaultOptions: [{
+            h1: false;
+            h2: false;
+            h3: false;
+            h4: false;
+            h5: false;
+            h6: false;
+        }];
+        messages: {
+            allowHeading: string;
+            allowHeadingDepth: string;
+        };
+        language: string;
+        dialects: string[];
+    };
+    create(context: import("@eslint/core").RuleContext<{
+        LangOptions: import("@eslint/markdown").MarkdownLanguageOptions;
+        Code: import("@eslint/markdown").MarkdownSourceCode;
+        RuleOptions: RuleOptions;
+        Node: import("mdast").Node;
+        MessageIds: MessageIds;
+    }>): {
+        heading(node: import("mdast").Heading): void;
+    };
+};
+export default _default;
+export type RuleOptions = [{
+    h1: HeadingOption;
+    h2: HeadingOption;
+    h3: HeadingOption;
+    h4: HeadingOption;
+    h5: HeadingOption;
+    h6: HeadingOption;
+}];
+export type MessageIds = "allowHeading" | "allowHeadingDepth";
+export type HeadingOption = false | string[];

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

@@ -0,0 +1,70 @@
+declare const _default: {
+    meta: {
+        type: "problem";
+        docs: {
+            description: string;
+            url: string;
+            recommended: boolean;
+            stylistic: false;
+        };
+        schema: {
+            type: "object";
+            properties: {
+                allowUrls: {
+                    type: "array";
+                    items: {
+                        type: "object";
+                    };
+                    uniqueItems: true;
+                };
+                disallowUrls: {
+                    type: "array";
+                    items: {
+                        type: "object";
+                    };
+                    uniqueItems: true;
+                };
+                allowDefinitions: {
+                    type: "array";
+                    items: {
+                        type: "string";
+                    };
+                    uniqueItems: true;
+                };
+            };
+            additionalProperties: false;
+        }[];
+        defaultOptions: [{
+            allowUrls: RegExp[];
+            disallowUrls: never[];
+            allowDefinitions: string[];
+        }];
+        messages: {
+            allowImageUrl: string;
+            disallowImageUrl: string;
+        };
+        language: string;
+        dialects: string[];
+    };
+    create(context: import("@eslint/core").RuleContext<{
+        LangOptions: import("@eslint/markdown").MarkdownLanguageOptions;
+        Code: import("@eslint/markdown").MarkdownSourceCode;
+        RuleOptions: RuleOptions;
+        Node: import("mdast").Node;
+        MessageIds: MessageIds;
+    }>): {
+        image(node: import("mdast").Image): void;
+        html(node: import("mdast").Html): void;
+        imageReference(node: import("mdast").ImageReference): void;
+        definition(node: Definition): void;
+        'root:exit'(): void;
+    };
+};
+export default _default;
+export type RuleOptions = [{
+    allowUrls: RegExp[];
+    disallowUrls: RegExp[];
+    allowDefinitions: string[];
+}];
+export type MessageIds = "allowImageUrl" | "disallowImageUrl";
+import type { Definition } from 'mdast';

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

@@ -0,0 +1,70 @@
+declare const _default: {
+    meta: {
+        type: "problem";
+        docs: {
+            description: string;
+            url: string;
+            recommended: boolean;
+            stylistic: false;
+        };
+        schema: {
+            type: "object";
+            properties: {
+                allowUrls: {
+                    type: "array";
+                    items: {
+                        type: "object";
+                    };
+                    uniqueItems: true;
+                };
+                disallowUrls: {
+                    type: "array";
+                    items: {
+                        type: "object";
+                    };
+                    uniqueItems: true;
+                };
+                allowDefinitions: {
+                    type: "array";
+                    items: {
+                        type: "string";
+                    };
+                    uniqueItems: true;
+                };
+            };
+            additionalProperties: false;
+        }[];
+        defaultOptions: [{
+            allowUrls: RegExp[];
+            disallowUrls: never[];
+            allowDefinitions: string[];
+        }];
+        messages: {
+            allowLinkUrl: string;
+            disallowLinkUrl: string;
+        };
+        language: string;
+        dialects: string[];
+    };
+    create(context: import("@eslint/core").RuleContext<{
+        LangOptions: import("@eslint/markdown").MarkdownLanguageOptions;
+        Code: import("@eslint/markdown").MarkdownSourceCode;
+        RuleOptions: RuleOptions;
+        Node: import("mdast").Node;
+        MessageIds: MessageIds;
+    }>): {
+        link(node: import("mdast").Link): void;
+        html(node: import("mdast").Html): void;
+        linkReference(node: import("mdast").LinkReference): void;
+        definition(node: Definition): void;
+        'root:exit'(): void;
+    };
+};
+export default _default;
+export type RuleOptions = [{
+    allowUrls: RegExp[];
+    disallowUrls: RegExp[];
+    allowDefinitions: string[];
+}];
+export type MessageIds = "allowLinkUrl" | "disallowLinkUrl";
+import type { Definition } from 'mdast';

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

@@ -0,0 +1,55 @@
+declare const _default: {
+    meta: {
+        type: "problem";
+        docs: {
+            description: string;
+            url: string;
+            recommended: boolean;
+            stylistic: false;
+        };
+        fixable: "code";
+        schema: {
+            type: "object";
+            properties: {
+                allow: {
+                    type: "array";
+                    items: {
+                        type: "string";
+                    };
+                    uniqueItems: true;
+                };
+                override: {
+                    type: "object";
+                    additionalProperties: {
+                        type: "string";
+                    };
+                };
+            };
+            additionalProperties: false;
+        }[];
+        defaultOptions: [{
+            allow: never[];
+            override: {};
+        }];
+        messages: {
+            codeLangShorthand: string;
+        };
+        language: string;
+        dialects: string[];
+    };
+    create(context: import("@eslint/core").RuleContext<{
+        LangOptions: import("@eslint/markdown").MarkdownLanguageOptions;
+        Code: import("@eslint/markdown").MarkdownSourceCode;
+        RuleOptions: RuleOptions;
+        Node: import("mdast").Node;
+        MessageIds: "codeLangShorthand";
+    }>): {
+        code(node: import("mdast").Code): void;
+    };
+};
+export default _default;
+export type RuleOptions = [{
+    allow: string[];
+    override: Record<string, string>;
+}];
+export type MessageIds = "codeLangShorthand";

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

@@ -0,0 +1,43 @@
+declare const _default: {
+    meta: {
+        type: "layout";
+        docs: {
+            description: string;
+            url: string;
+            recommended: boolean;
+            stylistic: true;
+        };
+        fixable: "code";
+        schema: {
+            type: "object";
+            properties: {
+                style: {
+                    enum: string[];
+                };
+            };
+            additionalProperties: false;
+        }[];
+        defaultOptions: [{
+            style: "consistent";
+        }];
+        messages: {
+            style: string;
+        };
+        language: string;
+        dialects: string[];
+    };
+    create(context: import("@eslint/core").RuleContext<{
+        LangOptions: import("@eslint/markdown").MarkdownLanguageOptions;
+        Code: import("@eslint/markdown").MarkdownSourceCode;
+        RuleOptions: RuleOptions;
+        Node: import("mdast").Node;
+        MessageIds: "style";
+    }>): {
+        delete(node: import("mdast").Delete): void;
+    };
+};
+export default _default;
+export type RuleOptions = [{
+    style: "consistent" | "~" | "~~";
+}];
+export type MessageIds = "style";