eslint-markdown 0.1.0-canary.12 → 0.2.0

package/README.md

@@ -2,7 +2,9 @@
 
 [![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)
-[![codecov](https://img.shields.io/codecov/c/gh/lumirlumir/npm-eslint-markdown?token=2zUCHlMFT3&label=Codecov&color=6358d4&labelColor=333333&logo=codecov)](https://codecov.io/gh/lumirlumir/npm-eslint-markdown)
+[![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)
@@ -18,6 +20,11 @@ Lint your Markdown with ESLint.🛠️
 
 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).

package/build/configs/all.d.ts

@@ -14,19 +14,13 @@ export default function all(plugin: ESLint.Plugin): {
     };
     readonly language: "markdown/gfm";
     readonly rules: {
-        readonly 'markdown/no-unused-definitions': "error";
-        readonly 'md/allow-heading': "error";
         readonly 'md/allow-image-url': "error";
         readonly 'md/allow-link-url': "error";
-        readonly 'md/alt-text': "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/en-capitalization': "error";
-        readonly 'md/heading-id': "error";
-        readonly 'md/no-bold-paragraph': "error";
         readonly 'md/no-control-character': "error";
         readonly 'md/no-curly-quote': "error";
         readonly 'md/no-double-space': "error";
@@ -34,6 +28,7 @@ export default function all(plugin: ESLint.Plugin): {
         readonly 'md/no-git-conflict-marker': "error";
         readonly 'md/no-irregular-dash': "error";
         readonly 'md/no-irregular-whitespace': "error";
+        readonly 'md/no-tab': "error";
         readonly 'md/no-url-trailing-slash': "error";
         readonly 'md/require-image-title': "error";
         readonly 'md/require-link-title': "error";

package/build/configs/recommended.d.ts

@@ -14,10 +14,7 @@ export default function recommended(plugin: ESLint.Plugin): {
     };
     readonly language: "markdown/gfm";
     readonly rules: {
-        readonly 'markdown/no-unused-definitions': "error";
-        readonly 'md/alt-text': "error";
         readonly 'md/code-lang-shorthand': "error";
-        readonly 'md/no-bold-paragraph': "error";
         readonly 'md/no-control-character': "error";
         readonly 'md/no-curly-quote': "error";
         readonly 'md/no-double-space': "error";

package/build/configs/stylistic.d.ts

@@ -18,6 +18,7 @@ export default function stylistic(plugin: ESLint.Plugin): {
         readonly 'md/consistent-emphasis-style': "error";
         readonly 'md/consistent-strong-style': "error";
         readonly 'md/consistent-thematic-break-style': "error";
+        readonly 'md/no-tab': "error";
     };
 };
 import type { ESLint } from "eslint";

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

@@ -11,10 +11,10 @@ declare const _default: {
         schema: {
             type: "object";
             properties: {
-                ignores: {
+                allow: {
                     type: "array";
                     items: {
-                        enum: string[];
+                        type: "string";
                     };
                     uniqueItems: true;
                 };
@@ -28,7 +28,7 @@ declare const _default: {
             additionalProperties: false;
         }[];
         defaultOptions: [{
-            ignores: never[];
+            allow: never[];
             override: {};
         }];
         messages: {
@@ -49,7 +49,7 @@ declare const _default: {
 };
 export default _default;
 export type RuleOptions = [{
-    ignores: string[];
+    allow: string[];
     override: Record<string, string>;
 }];
 export type MessageIds = "codeLangShorthand";

package/build/rules/index.d.ts

@@ -1,16 +1,11 @@
 declare const _default: {
-    'allow-heading': import("../core/types.js").RuleModule<import("./allow-heading.js").RuleOptions, import("./allow-heading.js").MessageIds>;
     'allow-image-url': import("../core/types.js").RuleModule<import("./allow-image-url.js").RuleOptions, import("./allow-image-url.js").MessageIds>;
     'allow-link-url': import("../core/types.js").RuleModule<import("./allow-link-url.js").RuleOptions, import("./allow-link-url.js").MessageIds>;
-    'alt-text': import("../core/types.js").RuleModule<[], "altText">;
     'code-lang-shorthand': import("../core/types.js").RuleModule<import("./code-lang-shorthand.js").RuleOptions, "codeLangShorthand">;
     'consistent-delete-style': import("../core/types.js").RuleModule<import("./consistent-delete-style.js").RuleOptions, "style">;
     'consistent-emphasis-style': import("../core/types.js").RuleModule<import("./consistent-emphasis-style.js").RuleOptions, "style">;
     'consistent-strong-style': import("../core/types.js").RuleModule<import("./consistent-strong-style.js").RuleOptions, "style">;
     'consistent-thematic-break-style': import("../core/types.js").RuleModule<import("./consistent-thematic-break-style.js").RuleOptions, "style">;
-    'en-capitalization': import("../core/types.js").RuleModule<import("./en-capitalization.js").RuleOptions, "enCapitalization">;
-    'heading-id': import("../core/types.js").RuleModule<import("./heading-id.js").RuleOptions, import("./heading-id.js").MessageIds>;
-    'no-bold-paragraph': import("../core/types.js").RuleModule<[], "noBoldParagraph">;
     'no-control-character': import("../core/types.js").RuleModule<import("./no-control-character.js").RuleOptions, "noControlCharacter">;
     'no-curly-quote': import("../core/types.js").RuleModule<import("./no-curly-quote.js").RuleOptions, "noCurlyQuote">;
     'no-double-space': import("../core/types.js").RuleModule<import("./no-double-space.js").RuleOptions, import("./no-double-space.js").MessageIds>;
@@ -18,6 +13,7 @@ declare const _default: {
     'no-git-conflict-marker': import("../core/types.js").RuleModule<import("./no-git-conflict-marker.js").RuleOptions, "noGitConflictMarker">;
     'no-irregular-dash': import("../core/types.js").RuleModule<import("./no-irregular-dash.js").RuleOptions, "noIrregularDash">;
     'no-irregular-whitespace': import("../core/types.js").RuleModule<import("./no-irregular-whitespace.js").RuleOptions, "noIrregularWhitespace">;
+    'no-tab': import("../core/types.js").RuleModule<import("./no-tab.js").RuleOptions, "noTab">;
     'no-url-trailing-slash': import("../core/types.js").RuleModule<[], "noUrlTrailingSlash">;
     'require-image-title': import("../core/types.js").RuleModule<import("./require-image-title.js").RuleOptions, "requireImageTitle">;
     'require-link-title': import("../core/types.js").RuleModule<import("./require-link-title.js").RuleOptions, "requireLinkTitle">;

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

@@ -10,6 +10,13 @@ declare const _default: {
         schema: {
             type: "object";
             properties: {
+                allow: {
+                    type: "array";
+                    items: {
+                        type: "string";
+                    };
+                    uniqueItems: true;
+                };
                 skipCode: {
                     type: "boolean";
                 };
@@ -20,6 +27,7 @@ declare const _default: {
             additionalProperties: false;
         }[];
         defaultOptions: [{
+            allow: never[];
             skipCode: true;
             skipInlineCode: true;
         }];
@@ -43,6 +51,7 @@ declare const _default: {
 };
 export default _default;
 export type RuleOptions = [{
+    allow: string[];
     skipCode: boolean;
     skipInlineCode: boolean;
 }];

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

@@ -10,6 +10,13 @@ declare const _default: {
         schema: {
             type: "object";
             properties: {
+                allow: {
+                    type: "array";
+                    items: {
+                        type: "string";
+                    };
+                    uniqueItems: true;
+                };
                 skipCode: {
                     type: "boolean";
                 };
@@ -20,6 +27,7 @@ declare const _default: {
             additionalProperties: false;
         }[];
         defaultOptions: [{
+            allow: never[];
             skipCode: true;
             skipInlineCode: true;
         }];
@@ -43,6 +51,7 @@ declare const _default: {
 };
 export default _default;
 export type RuleOptions = [{
+    allow: string[];
     skipCode: boolean;
     skipInlineCode: boolean;
 }];

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

@@ -10,6 +10,13 @@ declare const _default: {
         schema: {
             type: "object";
             properties: {
+                allow: {
+                    type: "array";
+                    items: {
+                        type: "string";
+                    };
+                    uniqueItems: true;
+                };
                 skipCode: {
                     type: "boolean";
                 };
@@ -20,6 +27,7 @@ declare const _default: {
             additionalProperties: false;
         }[];
         defaultOptions: [{
+            allow: never[];
             skipCode: true;
             skipInlineCode: true;
         }];
@@ -43,6 +51,7 @@ declare const _default: {
 };
 export default _default;
 export type RuleOptions = [{
+    allow: string[];
     skipCode: boolean;
     skipInlineCode: boolean;
 }];

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

@@ -0,0 +1,56 @@
+declare const _default: {
+    meta: {
+        type: "problem";
+        docs: {
+            description: string;
+            url: string;
+            recommended: boolean;
+            stylistic: true;
+        };
+        fixable: "whitespace";
+        schema: {
+            type: "object";
+            properties: {
+                skipCode: {
+                    type: "boolean";
+                };
+                skipInlineCode: {
+                    type: "boolean";
+                };
+                tabWidth: {
+                    type: "integer";
+                    minimum: number;
+                };
+            };
+            additionalProperties: false;
+        }[];
+        defaultOptions: [{
+            skipCode: true;
+            skipInlineCode: true;
+            tabWidth: number;
+        }];
+        messages: {
+            noTab: 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: "noTab";
+    }>): {
+        code(node: import("mdast").Code): void;
+        inlineCode(node: import("mdast").InlineCode): void;
+        'root:exit'(): void;
+    };
+};
+export default _default;
+export type RuleOptions = [{
+    skipCode: boolean;
+    skipInlineCode: boolean;
+    tabWidth: number;
+}];
+export type MessageIds = "noTab";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eslint-markdown",
-  "version": "0.1.0-canary.12",
+  "version": "0.2.0",
   "type": "module",
   "description": "Lint your Markdown with ESLint.🛠️",
   "exports": {
@@ -58,13 +58,13 @@
   },
   "scripts": {
     "prepublishOnly": "npm run build",
-    "build": "npx tsc && node ../../scripts/cp.mjs ../../LICENSE.md LICENSE.md ../../README.md README.md",
+    "build": "node ../../scripts/build-config.mjs && npx tsc && node ../../scripts/cp.mjs ../../LICENSE.md LICENSE.md ../../README.md README.md",
     "test": "npm run test:types && npm run test:unit",
     "test:types": "tsc -p ./tsconfig.test.json",
     "test:unit": "node --test"
   },
   "peerDependencies": {
-    "eslint": "^9.15.0"
+    "eslint": "^9.31.0 || ^10.0.0-beta.0"
   },
   "peerDependenciesMeta": {
     "eslint": {

package/src/configs/all.js

@@ -38,19 +38,13 @@ export default function all(plugin) {
     },
     language: 'markdown/gfm',
     rules: {
-      'markdown/no-unused-definitions': 'error',
-      'md/allow-heading': 'error',
       'md/allow-image-url': 'error',
       'md/allow-link-url': 'error',
-      'md/alt-text': 'error',
       'md/code-lang-shorthand': 'error',
       'md/consistent-delete-style': 'error',
       'md/consistent-emphasis-style': 'error',
       'md/consistent-strong-style': 'error',
       'md/consistent-thematic-break-style': 'error',
-      'md/en-capitalization': 'error',
-      'md/heading-id': 'error',
-      'md/no-bold-paragraph': 'error',
       'md/no-control-character': 'error',
       'md/no-curly-quote': 'error',
       'md/no-double-space': 'error',
@@ -58,6 +52,7 @@ export default function all(plugin) {
       '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-image-title': 'error',
       'md/require-link-title': 'error',

package/src/configs/recommended.js

@@ -38,10 +38,7 @@ export default function recommended(plugin) {
     },
     language: 'markdown/gfm',
     rules: {
-      'markdown/no-unused-definitions': 'error',
-      'md/alt-text': 'error',
       'md/code-lang-shorthand': 'error',
-      'md/no-bold-paragraph': 'error',
       'md/no-control-character': 'error',
       'md/no-curly-quote': 'error',
       'md/no-double-space': 'error',

package/src/configs/stylistic.js

@@ -42,6 +42,7 @@ export default function stylistic(plugin) {
       'md/consistent-emphasis-style': 'error',
       'md/consistent-strong-style': 'error',
       'md/consistent-thematic-break-style': 'error',
+      'md/no-tab': 'error',
     },
   });
 }

package/src/rules/code-lang-shorthand.js

@@ -1,13 +1,8 @@
 /**
  * @fileoverview Rule to enforce the use of shorthand for code block language identifiers.
  * @author 루밀LuMir(lumirlumir)
- * @see https://shiki.style/languages#bundled-languages
- * @see https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object/fromEntries
- * @see https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object/entries
  */
 
-// @ts-nocheck -- TODO
-
 // --------------------------------------------------------------------------------
 // Import
 // --------------------------------------------------------------------------------
@@ -15,20 +10,24 @@
 import { URL_RULE_DOCS } from '../core/constants.js';
 
 // --------------------------------------------------------------------------------
-// Typedefs
+// Typedef
 // --------------------------------------------------------------------------------
 
 /**
  * @import { RuleModule } from '../core/types.js';
- * @typedef {[{ ignores: string[], override: Record<string, string> }]} RuleOptions
+ * @typedef {[{ allow: string[], override: Record<string, string> }]} RuleOptions
  * @typedef {'codeLangShorthand'} MessageIds
  */
 
 // --------------------------------------------------------------------------------
-// Helpers
+// Helper
 // --------------------------------------------------------------------------------
 
-/** @satisfies {Record<string, string>} */
+/**
+ * Please note that the keys and values should be in lowercase.
+ * @see https://shiki.style/languages#bundled-languages
+ * @type {Record<string, string>}
+ */
 const langShorthandMap = Object.freeze({
   asciidoc: 'adoc',
   batch: 'bat',
@@ -101,6 +100,11 @@ const langShorthandMap = Object.freeze({
   yaml: 'yml',
 });
 
+/** @param {string} str */
+function normalize(str) {
+  return str.toLowerCase();
+}
+
 // --------------------------------------------------------------------------------
 // Rule Definition
 // --------------------------------------------------------------------------------
@@ -123,10 +127,10 @@ export default {
       {
         type: 'object',
         properties: {
-          ignores: {
+          allow: {
             type: 'array',
             items: {
-              enum: Object.keys(langShorthandMap),
+              type: 'string',
             },
             uniqueItems: true,
           },
@@ -143,7 +147,7 @@ export default {
 
     defaultOptions: [
       {
-        ignores: [],
+        allow: [],
         override: {},
       },
     ],
@@ -158,36 +162,50 @@ export default {
   },
 
   create(context) {
+    const { sourceCode } = context;
+    const [{ allow, override }] = context.options;
+
+    const normalizedAllow = new Set(allow.map(normalize));
+    const normalizedOverride = Object.fromEntries(
+      Object.entries(override).map(([key, value]) => [normalize(key), normalize(value)]), // Normalize keys and values.
+    );
+
+    const mergedLangShorthandMap = {
+      ...langShorthandMap,
+      ...normalizedOverride,
+    };
+
     return {
       code(node) {
-        const [{ ignores, override }] = context.options;
-        const langShorthandMapMerged = Object.fromEntries(
-          Object.entries({
-            ...langShorthandMap,
-            ...override, // `override` option handling.
-          })
-            .map(([key, value]) => [key.toLowerCase(), value.toLowerCase()]) // Normalize keys and values.
-            .filter(([key]) => !ignores.includes(key)), // `ignores` option handling.
-        );
-        const langShorthand = langShorthandMapMerged[node.lang?.toLowerCase()]; // Normalize lang.
+        // If it's 'Indented code block' or 'Fenced code block without lang', skip it.
+        if (node.lang === null || node.lang === undefined) {
+          return;
+        }
+
+        const normalizedLang = normalize(node.lang);
 
-        if (langShorthand === undefined) return;
+        // If the lang is in the allow list, skip it.
+        if (normalizedAllow.has(normalizedLang)) {
+          return;
+        }
 
-        const match = context.sourceCode.getText(node).match(node.lang);
+        const langShorthand = mergedLangShorthandMap[normalizedLang];
 
-        const matchIndexStart = match.index;
-        const matchIndexEnd = matchIndexStart + match[0].length;
+        // If there is no shorthand for the lang, skip it.
+        if (langShorthand === undefined) {
+          return;
+        }
+
+        const [nodeStartOffset] = sourceCode.getRange(node);
+        const matchIndex = sourceCode.getText(node).indexOf(node.lang);
+
+        const startOffset = nodeStartOffset + matchIndex;
+        const endOffset = startOffset + node.lang.length;
 
         context.report({
           loc: {
-            start: {
-              line: node.position.start.line,
-              column: node.position.start.column + matchIndexStart,
-            },
-            end: {
-              line: node.position.start.line,
-              column: node.position.start.column + matchIndexEnd,
-            },
+            start: sourceCode.getLocFromIndex(startOffset),
+            end: sourceCode.getLocFromIndex(endOffset),
           },
 
           data: {
@@ -198,13 +216,7 @@ export default {
           messageId: 'codeLangShorthand',
 
           fix(fixer) {
-            return fixer.replaceTextRange(
-              [
-                node.position.start.offset + matchIndexStart,
-                node.position.start.offset + matchIndexEnd,
-              ],
-              langShorthand,
-            );
+            return fixer.replaceTextRange([startOffset, endOffset], langShorthand);
           },
         });
       },

package/src/rules/index.js

@@ -1,17 +1,18 @@
 /* eslint sort-imports: 'error', sort-keys: 'error' */
 
-import allowHeading from './allow-heading.js';
+// TODO: Re-enable the commented-out rules once they stabilize.
+
+// import allowHeading from './allow-heading.js';
 import allowImageUrl from './allow-image-url.js';
 import allowLinkUrl from './allow-link-url.js';
-import altText from './alt-text.js';
 import codeLangShorthand from './code-lang-shorthand.js';
 import consistentDeleteStyle from './consistent-delete-style.js';
 import consistentEmphasisStyle from './consistent-emphasis-style.js';
 import consistentStrongStyle from './consistent-strong-style.js';
 import consistentThematicBreakStyle from './consistent-thematic-break-style.js';
-import enCapitalization from './en-capitalization.js';
-import headingId from './heading-id.js';
-import noBoldParagraph from './no-bold-paragraph.js';
+// import enCapitalization from './en-capitalization.js';
+// import headingId from './heading-id.js';
+// import noBoldParagraph from './no-bold-paragraph.js';
 import noControlCharacter from './no-control-character.js';
 import noCurlyQuote from './no-curly-quote.js';
 import noDoubleSpace from './no-double-space.js';
@@ -19,23 +20,23 @@ import noEmoji from './no-emoji.js';
 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 noUrlTrailingSlash from './no-url-trailing-slash.js';
 import requireImageTitle from './require-image-title.js';
 import requireLinkTitle from './require-link-title.js';
 
 export default {
-  'allow-heading': allowHeading,
+  // 'allow-heading': allowHeading,
   'allow-image-url': allowImageUrl,
   'allow-link-url': allowLinkUrl,
-  'alt-text': altText,
   'code-lang-shorthand': codeLangShorthand,
   'consistent-delete-style': consistentDeleteStyle,
   'consistent-emphasis-style': consistentEmphasisStyle,
   'consistent-strong-style': consistentStrongStyle,
   'consistent-thematic-break-style': consistentThematicBreakStyle,
-  'en-capitalization': enCapitalization,
-  'heading-id': headingId,
-  'no-bold-paragraph': noBoldParagraph,
+  // 'en-capitalization': enCapitalization,
+  // 'heading-id': headingId,
+  // 'no-bold-paragraph': noBoldParagraph,
   'no-control-character': noControlCharacter,
   'no-curly-quote': noCurlyQuote,
   'no-double-space': noDoubleSpace,
@@ -43,6 +44,7 @@ export default {
   'no-git-conflict-marker': noGitConflictMarker,
   'no-irregular-dash': noIrregularDash,
   'no-irregular-whitespace': noIrregularWhitespace,
+  'no-tab': noTab,
   'no-url-trailing-slash': noUrlTrailingSlash,
   'require-image-title': requireImageTitle,
   'require-link-title': requireLinkTitle,

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

@@ -16,7 +16,7 @@ import { URL_RULE_DOCS } from '../core/constants.js';
 
 /**
  * @import { RuleModule } from '../core/types.js';
- * @typedef {[{ skipCode: boolean, skipInlineCode: boolean }]} RuleOptions
+ * @typedef {[{ allow: string[], skipCode: boolean, skipInlineCode: boolean }]} RuleOptions
  * @typedef {'noControlCharacter'} MessageIds
  */
 
@@ -47,6 +47,13 @@ export default {
       {
         type: 'object',
         properties: {
+          allow: {
+            type: 'array',
+            items: {
+              type: 'string',
+            },
+            uniqueItems: true,
+          },
           skipCode: {
             type: 'boolean',
           },
@@ -60,6 +67,7 @@ export default {
 
     defaultOptions: [
       {
+        allow: [],
         skipCode: true,
         skipInlineCode: true,
       },
@@ -76,7 +84,7 @@ export default {
 
   create(context) {
     const { sourceCode } = context;
-    const [{ skipCode, skipInlineCode }] = context.options;
+    const [{ allow, skipCode, skipInlineCode }] = context.options;
 
     const skipRanges = new SkipRanges();
 
@@ -95,6 +103,8 @@ export default {
         for (const match of matches) {
           const controlCharacter = match[0];
 
+          if (allow.includes(controlCharacter)) continue;
+
           const startOffset = match.index;
           const endOffset = startOffset + controlCharacter.length;
 

package/src/rules/no-irregular-dash.js

@@ -16,7 +16,7 @@ import { URL_RULE_DOCS } from '../core/constants.js';
 
 /**
  * @import { RuleModule } from '../core/types.js';
- * @typedef {[{ skipCode: boolean, skipInlineCode: boolean }]} RuleOptions
+ * @typedef {[{ allow: string[], skipCode: boolean, skipInlineCode: boolean }]} RuleOptions
  * @typedef {'noIrregularDash'} MessageIds
  */
 
@@ -47,6 +47,13 @@ export default {
       {
         type: 'object',
         properties: {
+          allow: {
+            type: 'array',
+            items: {
+              type: 'string',
+            },
+            uniqueItems: true,
+          },
           skipCode: {
             type: 'boolean',
           },
@@ -60,6 +67,7 @@ export default {
 
     defaultOptions: [
       {
+        allow: [],
         skipCode: true,
         skipInlineCode: true,
       },
@@ -76,7 +84,7 @@ export default {
 
   create(context) {
     const { sourceCode } = context;
-    const [{ skipCode, skipInlineCode }] = context.options;
+    const [{ allow, skipCode, skipInlineCode }] = context.options;
 
     const skipRanges = new SkipRanges();
 
@@ -95,6 +103,8 @@ export default {
         for (const match of matches) {
           const irregularDash = match[0];
 
+          if (allow.includes(irregularDash)) continue;
+
           const startOffset = match.index;
           const endOffset = startOffset + irregularDash.length;
 

package/src/rules/no-irregular-whitespace.js

@@ -16,7 +16,7 @@ import { URL_RULE_DOCS } from '../core/constants.js';
 
 /**
  * @import { RuleModule } from '../core/types.js';
- * @typedef {[{ skipCode: boolean, skipInlineCode: boolean }]} RuleOptions
+ * @typedef {[{ allow: string[], skipCode: boolean, skipInlineCode: boolean }]} RuleOptions
  * @typedef {'noIrregularWhitespace'} MessageIds
  */
 
@@ -47,6 +47,13 @@ export default {
       {
         type: 'object',
         properties: {
+          allow: {
+            type: 'array',
+            items: {
+              type: 'string',
+            },
+            uniqueItems: true,
+          },
           skipCode: {
             type: 'boolean',
           },
@@ -60,6 +67,7 @@ export default {
 
     defaultOptions: [
       {
+        allow: [],
         skipCode: true,
         skipInlineCode: true,
       },
@@ -77,7 +85,7 @@ export default {
 
   create(context) {
     const { sourceCode } = context;
-    const [{ skipCode, skipInlineCode }] = context.options;
+    const [{ allow, skipCode, skipInlineCode }] = context.options;
 
     const skipRanges = new SkipRanges();
 
@@ -96,6 +104,8 @@ export default {
         for (const match of matches) {
           const irregularWhitespace = match[0];
 
+          if (allow.includes(irregularWhitespace)) continue;
+
           const startOffset = match.index;
           const endOffset = startOffset + irregularWhitespace.length;
 

package/src/rules/no-tab.js

@@ -0,0 +1,128 @@
+/**
+ * @fileoverview Rule to disallow tab characters.
+ * @author 루밀LuMir(lumirlumir)
+ */
+
+// --------------------------------------------------------------------------------
+// Import
+// --------------------------------------------------------------------------------
+
+import { SkipRanges } from '../core/ast/index.js';
+import { URL_RULE_DOCS } from '../core/constants.js';
+
+// --------------------------------------------------------------------------------
+// Typedef
+// --------------------------------------------------------------------------------
+
+/**
+ * @import { RuleModule } from '../core/types.js';
+ * @typedef {[{ skipCode: boolean, skipInlineCode: boolean, tabWidth: number }]} RuleOptions
+ * @typedef {'noTab'} MessageIds
+ */
+
+// --------------------------------------------------------------------------------
+// Helper
+// --------------------------------------------------------------------------------
+
+const tabRegex = /\t/gu;
+
+// --------------------------------------------------------------------------------
+// Rule Definition
+// --------------------------------------------------------------------------------
+
+/** @type {RuleModule<RuleOptions, MessageIds>} */
+export default {
+  meta: {
+    type: 'problem',
+
+    docs: {
+      description: 'Disallow tab characters',
+      url: URL_RULE_DOCS('no-tab'),
+      recommended: false,
+      stylistic: true,
+    },
+
+    fixable: 'whitespace',
+
+    schema: [
+      {
+        type: 'object',
+        properties: {
+          skipCode: {
+            type: 'boolean',
+          },
+          skipInlineCode: {
+            type: 'boolean',
+          },
+          tabWidth: {
+            type: 'integer',
+            minimum: 1,
+          },
+        },
+        additionalProperties: false,
+      },
+    ],
+
+    defaultOptions: [
+      {
+        skipCode: true,
+        skipInlineCode: true,
+        tabWidth: 4,
+      },
+    ],
+
+    messages: {
+      noTab: 'Tab character is not allowed. Please use spaces instead.',
+    },
+
+    language: 'markdown',
+
+    dialects: ['commonmark', 'gfm'],
+  },
+
+  create(context) {
+    const { sourceCode } = context;
+    const [{ skipCode, skipInlineCode, tabWidth }] = context.options;
+
+    const skipRanges = new SkipRanges();
+
+    return {
+      code(node) {
+        if (skipCode) skipRanges.push(sourceCode.getRange(node)); // Store range information of `Code`.
+      },
+
+      inlineCode(node) {
+        if (skipInlineCode) skipRanges.push(sourceCode.getRange(node)); // Store range information of `InlineCode`.
+      },
+
+      'root:exit'() {
+        const matches = sourceCode.text.matchAll(tabRegex);
+
+        for (const match of matches) {
+          const tab = match[0];
+
+          const startOffset = match.index;
+          const endOffset = startOffset + tab.length;
+
+          if (skipRanges.includes(startOffset)) continue;
+
+          context.report({
+            loc: {
+              start: sourceCode.getLocFromIndex(startOffset),
+              end: sourceCode.getLocFromIndex(endOffset),
+            },
+
+            messageId: 'noTab',
+
+            fix(fixer) {
+              return fixer.replaceTextRange(
+                [startOffset, endOffset],
+                ' '.repeat(tabWidth),
+              );
+            },
+          });
+        }
+      },
+    };
+  },
+};

package/build/rules/alt-text.d.ts

@@ -1,30 +0,0 @@
-declare const _default: {
-    meta: {
-        type: "problem";
-        docs: {
-            description: string;
-            url: string;
-            recommended: boolean;
-            stylistic: false;
-        };
-        messages: {
-            altText: string;
-        };
-        language: string;
-        dialects: string[];
-    };
-    create(context: import("@eslint/core").RuleContext<{
-        LangOptions: import("@eslint/markdown").MarkdownLanguageOptions;
-        Code: import("@eslint/markdown").MarkdownSourceCode;
-        RuleOptions: [];
-        Node: import("mdast").Node;
-        MessageIds: "altText";
-    }>): {
-        image(node: import("mdast").Image): void;
-        imageReference(node: import("mdast").ImageReference): void;
-        html(node: import("mdast").Html): void;
-    };
-};
-export default _default;
-export type RuleOptions = [];
-export type MessageIds = "altText";

package/src/rules/alt-text.js

@@ -1,88 +0,0 @@
-/**
- * @fileoverview Rule to enforce the use of alternative text for images.
- * @author 루밀LuMir(lumirlumir)
- */
-
-// --------------------------------------------------------------------------------
-// Import
-// --------------------------------------------------------------------------------
-
-import { getElementsByTagName } from '../core/ast/index.js';
-import { URL_RULE_DOCS } from '../core/constants.js';
-
-// --------------------------------------------------------------------------------
-// Typedefs
-// --------------------------------------------------------------------------------
-
-/**
- * @import { RuleModule } from '../core/types.js';
- * @typedef {[]} RuleOptions
- * @typedef {'altText'} MessageIds
- */
-
-// --------------------------------------------------------------------------------
-// Rule Definition
-// --------------------------------------------------------------------------------
-
-/** @type {RuleModule<RuleOptions, MessageIds>} */
-export default {
-  meta: {
-    type: 'problem',
-
-    docs: {
-      description: 'Enforce the use of alternative text for images',
-      url: URL_RULE_DOCS('alt-text'),
-      recommended: true,
-      stylistic: false,
-    },
-
-    messages: {
-      altText: 'Images should have an alternative text (alt text).',
-    },
-
-    language: 'markdown',
-
-    dialects: ['commonmark', 'gfm'],
-  },
-
-  create(context) {
-    return {
-      image(node) {
-        if (node.alt === '') {
-          context.report({
-            node,
-            messageId: 'altText',
-          });
-        }
-      },
-
-      imageReference(node) {
-        if (node.alt === '') {
-          context.report({
-            node,
-            messageId: 'altText',
-          });
-        }
-      },
-
-      html(node) {
-        getElementsByTagName(node.value, 'img').forEach(({ attrs }) => {
-          let hasAltText = false;
-
-          attrs.forEach(({ name, value }) => {
-            if (name === 'alt' && value) {
-              hasAltText = true;
-            }
-          });
-
-          if (!hasAltText) {
-            context.report({
-              node,
-              messageId: 'altText',
-            });
-          }
-        });
-      },
-    };
-  },
-};