eslint-markdown 0.1.0 → 0.2.0

package/build/configs/all.d.ts

@@ -28,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/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/index.d.ts

@@ -13,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",
+  "version": "0.2.0",
   "type": "module",
   "description": "Lint your Markdown with ESLint.🛠️",
   "exports": {

package/src/configs/all.js

@@ -52,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/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/index.js

@@ -20,6 +20,7 @@ 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';
@@ -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),
+              );
+            },
+          });
+        }
+      },
+    };
+  },
+};