eslint-markdown 0.2.0 → 0.4.0

package/build/configs/all.d.ts

@@ -21,6 +21,7 @@ export default function all(plugin: ESLint.Plugin): {
         readonly 'md/consistent-emphasis-style': "error";
         readonly 'md/consistent-strong-style': "error";
         readonly 'md/consistent-thematic-break-style': "error";
+        readonly 'md/consistent-unordered-list-style': "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/consistent-unordered-list-style': "error";
         readonly 'md/no-tab': "error";
     };
 };

package/build/core/types.d.ts

@@ -2,6 +2,11 @@
  * @fileoverview Define common types.
  */
 import type { MarkdownRuleDefinition, MarkdownRuleDefinitionTypeOptions } from '@eslint/markdown';
+/**
+ * Represents a rule module with specific rule options and message IDs.
+ * @template RuleOptions The rule options.
+ * @template MessageIds The message IDs.
+ */
 export type RuleModule<RuleOptions extends MarkdownRuleDefinitionTypeOptions['RuleOptions'], MessageIds extends MarkdownRuleDefinitionTypeOptions['MessageIds']> = MarkdownRuleDefinition<{
     RuleOptions: RuleOptions;
     MessageIds: MessageIds;

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

@@ -0,0 +1,47 @@
+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";
+    }>): {
+        list(): void;
+        'list[ordered=false] > listItem'(node: ListItem): void;
+        'list:exit'(): void;
+    };
+};
+export default _default;
+export type UnorderedListMarker = "*" | "+" | "-";
+export type RuleOptions = [{
+    style: "consistent" | "sublist" | UnorderedListMarker;
+}];
+export type MessageIds = "style";
+import type { ListItem } from 'mdast';

package/build/rules/index.d.ts

@@ -6,6 +6,7 @@ declare const _default: {
     '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">;
+    'consistent-unordered-list-style': import("../core/types.js").RuleModule<import("./consistent-unordered-list-style.js").RuleOptions, "style">;
     '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>;

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

@@ -18,7 +18,17 @@ declare const _default: {
                     uniqueItems: true;
                 };
                 skipCode: {
-                    type: "boolean";
+                    oneOf: ({
+                        type: "boolean";
+                        items?: never;
+                        uniqueItems?: never;
+                    } | {
+                        type: "array";
+                        items: {
+                            type: "string";
+                        };
+                        uniqueItems: true;
+                    })[];
                 };
                 skipInlineCode: {
                     type: "boolean";
@@ -52,7 +62,7 @@ declare const _default: {
 export default _default;
 export type RuleOptions = [{
     allow: string[];
-    skipCode: boolean;
+    skipCode: boolean | string[];
     skipInlineCode: boolean;
 }];
 export type MessageIds = "noControlCharacter";

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

@@ -11,7 +11,17 @@ declare const _default: {
             type: "object";
             properties: {
                 skipCode: {
-                    type: "boolean";
+                    oneOf: ({
+                        type: "boolean";
+                        items?: never;
+                        uniqueItems?: never;
+                    } | {
+                        type: "array";
+                        items: {
+                            type: "string";
+                        };
+                        uniqueItems: true;
+                    })[];
                 };
             };
             additionalProperties: false;
@@ -38,6 +48,6 @@ declare const _default: {
 };
 export default _default;
 export type RuleOptions = [{
-    skipCode: boolean;
+    skipCode: boolean | string[];
 }];
 export type MessageIds = "noGitConflictMarker";

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

@@ -18,7 +18,17 @@ declare const _default: {
                     uniqueItems: true;
                 };
                 skipCode: {
-                    type: "boolean";
+                    oneOf: ({
+                        type: "boolean";
+                        items?: never;
+                        uniqueItems?: never;
+                    } | {
+                        type: "array";
+                        items: {
+                            type: "string";
+                        };
+                        uniqueItems: true;
+                    })[];
                 };
                 skipInlineCode: {
                     type: "boolean";
@@ -52,7 +62,7 @@ declare const _default: {
 export default _default;
 export type RuleOptions = [{
     allow: string[];
-    skipCode: boolean;
+    skipCode: boolean | string[];
     skipInlineCode: boolean;
 }];
 export type MessageIds = "noIrregularDash";

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

@@ -18,7 +18,17 @@ declare const _default: {
                     uniqueItems: true;
                 };
                 skipCode: {
-                    type: "boolean";
+                    oneOf: ({
+                        type: "boolean";
+                        items?: never;
+                        uniqueItems?: never;
+                    } | {
+                        type: "array";
+                        items: {
+                            type: "string";
+                        };
+                        uniqueItems: true;
+                    })[];
                 };
                 skipInlineCode: {
                     type: "boolean";
@@ -52,7 +62,7 @@ declare const _default: {
 export default _default;
 export type RuleOptions = [{
     allow: string[];
-    skipCode: boolean;
+    skipCode: boolean | string[];
     skipInlineCode: boolean;
 }];
 export type MessageIds = "noIrregularWhitespace";

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

@@ -12,7 +12,17 @@ declare const _default: {
             type: "object";
             properties: {
                 skipCode: {
-                    type: "boolean";
+                    oneOf: ({
+                        type: "boolean";
+                        items?: never;
+                        uniqueItems?: never;
+                    } | {
+                        type: "array";
+                        items: {
+                            type: "string";
+                        };
+                        uniqueItems: true;
+                    })[];
                 };
                 skipInlineCode: {
                     type: "boolean";
@@ -49,7 +59,7 @@ declare const _default: {
 };
 export default _default;
 export type RuleOptions = [{
-    skipCode: boolean;
+    skipCode: boolean | string[];
     skipInlineCode: boolean;
     tabWidth: number;
 }];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eslint-markdown",
-  "version": "0.2.0",
+  "version": "0.4.0",
   "type": "module",
   "description": "Lint your Markdown with ESLint.🛠️",
   "exports": {
@@ -64,7 +64,7 @@
     "test:unit": "node --test"
   },
   "peerDependencies": {
-    "eslint": "^9.31.0 || ^10.0.0-beta.0"
+    "eslint": "^9.31.0 || ^10.0.0-rc.0"
   },
   "peerDependenciesMeta": {
     "eslint": {

package/src/configs/all.js

@@ -45,6 +45,7 @@ export default function all(plugin) {
       'md/consistent-emphasis-style': 'error',
       'md/consistent-strong-style': 'error',
       'md/consistent-thematic-break-style': 'error',
+      'md/consistent-unordered-list-style': '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/consistent-unordered-list-style': 'error',
       'md/no-tab': 'error',
     },
   });

package/src/core/types.ts

@@ -15,6 +15,11 @@ import type {
 // Typedef
 // --------------------------------------------------------------------------------
 
+/**
+ * Represents a rule module with specific rule options and message IDs.
+ * @template RuleOptions The rule options.
+ * @template MessageIds The message IDs.
+ */
 export type RuleModule<
   RuleOptions extends MarkdownRuleDefinitionTypeOptions['RuleOptions'],
   MessageIds extends MarkdownRuleDefinitionTypeOptions['MessageIds'],

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

@@ -0,0 +1,156 @@
+/**
+ * @fileoverview Rule to enforce consistent unordered list style.
+ * @author hyoban
+ */
+
+// --------------------------------------------------------------------------------
+// Import
+// --------------------------------------------------------------------------------
+
+import { URL_RULE_DOCS } from '../core/constants.js';
+
+// --------------------------------------------------------------------------------
+// Typedef
+// --------------------------------------------------------------------------------
+
+/**
+ * @import { ListItem } from 'mdast';
+ * @import { RuleModule } from '../core/types.js';
+ * @typedef {'*' | '+' | '-'} UnorderedListMarker
+ * @typedef {[{ style: 'consistent' | 'sublist' | UnorderedListMarker }]} RuleOptions
+ * @typedef {'style'} MessageIds
+ */
+
+// --------------------------------------------------------------------------------
+// Helper
+// --------------------------------------------------------------------------------
+
+/**
+ * Get the next unordered list marker in sequence.
+ * Inspired by [`markdownlint`](https://github.com/DavidAnson/markdownlint/blob/v0.40.0/lib/md004.mjs#L9).
+ * @param {UnorderedListMarker} currentUnorderedListMarker The current unordered list marker.
+ * @returns {UnorderedListMarker} The next unordered list marker.
+ */
+function getNextUnorderedListMarker(currentUnorderedListMarker) {
+  if (currentUnorderedListMarker === '-') {
+    return '+';
+  } else if (currentUnorderedListMarker === '+') {
+    return '*';
+  } else {
+    return '-';
+  }
+}
+
+// --------------------------------------------------------------------------------
+// Rule Definition
+// --------------------------------------------------------------------------------
+
+/** @type {RuleModule<RuleOptions, MessageIds>} */
+export default {
+  meta: {
+    type: 'layout',
+
+    docs: {
+      description: 'Enforce consistent unordered list style',
+      url: URL_RULE_DOCS('consistent-unordered-list-style'),
+      recommended: false,
+      stylistic: true,
+    },
+
+    fixable: 'code',
+
+    schema: [
+      {
+        type: 'object',
+        properties: {
+          style: {
+            enum: ['consistent', 'sublist', '*', '+', '-'],
+          },
+        },
+        additionalProperties: false,
+      },
+    ],
+
+    defaultOptions: [
+      {
+        style: 'consistent',
+      },
+    ],
+
+    messages: {
+      style: 'Unordered list style should be `{{ style }}`.',
+    },
+
+    language: 'markdown',
+
+    dialects: ['commonmark', 'gfm'],
+  },
+
+  create(context) {
+    const { sourceCode } = context;
+    const [{ style }] = context.options;
+
+    /** @type {Array<UnorderedListMarker | null | undefined>} */
+    const unorderedListStyle = [
+      style === 'consistent' || style === 'sublist' ? null : style,
+    ];
+    let listDepth = -1;
+
+    return {
+      list() {
+        // When entering a `list` node, increase the depth.
+        // Counts both ordered and unordered lists, which matches `markdownlint`'s behavior.
+        listDepth++;
+      },
+
+      'list[ordered=false] > listItem'(/** @type {ListItem} */ node) {
+        const [nodeStartOffset] = sourceCode.getRange(node);
+        const currentUnorderedListStyle = /** @type {UnorderedListMarker} */ (
+          sourceCode.text[nodeStartOffset]
+        );
+        const currentListDepth = style === 'sublist' ? listDepth : 0;
+
+        // `unorderedListStyle[currentListDepth]` can be `null` or `undefined`.
+        if (!unorderedListStyle[currentListDepth]) {
+          unorderedListStyle[currentListDepth] =
+            // If the previous depth used the same style, use the next style in sequence.
+            unorderedListStyle[currentListDepth - 1] === currentUnorderedListStyle
+              ? getNextUnorderedListMarker(currentUnorderedListStyle)
+              : currentUnorderedListStyle;
+        }
+
+        if (unorderedListStyle[currentListDepth] !== currentUnorderedListStyle) {
+          const stringifiedUnorderedListStyle = String(
+            unorderedListStyle[currentListDepth],
+          );
+
+          context.report({
+            loc: {
+              start: sourceCode.getLocFromIndex(nodeStartOffset),
+              end: sourceCode.getLocFromIndex(nodeStartOffset + 1),
+            },
+
+            messageId: 'style',
+
+            data: {
+              style: stringifiedUnorderedListStyle,
+            },
+
+            fix(fixer) {
+              return fixer.replaceTextRange(
+                [nodeStartOffset, nodeStartOffset + 1],
+                stringifiedUnorderedListStyle,
+              );
+            },
+          });
+        }
+      },
+
+      'list:exit'() {
+        // When exiting a `list` node, decrease the depth.
+        // Counts both ordered and unordered lists, which matches `markdownlint`'s behavior.
+        listDepth--;
+      },
+    };
+  },
+};

package/src/rules/index.js

@@ -10,6 +10,7 @@ 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 consistentUnorderedListStyle from './consistent-unordered-list-style.js';
 // import enCapitalization from './en-capitalization.js';
 // import headingId from './heading-id.js';
 // import noBoldParagraph from './no-bold-paragraph.js';
@@ -34,6 +35,7 @@ export default {
   'consistent-emphasis-style': consistentEmphasisStyle,
   'consistent-strong-style': consistentStrongStyle,
   'consistent-thematic-break-style': consistentThematicBreakStyle,
+  'consistent-unordered-list-style': consistentUnorderedListStyle,
   // 'en-capitalization': enCapitalization,
   // 'heading-id': headingId,
   // 'no-bold-paragraph': noBoldParagraph,

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 {[{ allow: string[], skipCode: boolean, skipInlineCode: boolean }]} RuleOptions
+ * @typedef {[{ allow: string[], skipCode: boolean | string[], skipInlineCode: boolean }]} RuleOptions
  * @typedef {'noControlCharacter'} MessageIds
  */
 
@@ -55,7 +55,18 @@ export default {
             uniqueItems: true,
           },
           skipCode: {
-            type: 'boolean',
+            oneOf: [
+              {
+                type: 'boolean',
+              },
+              {
+                type: 'array',
+                items: {
+                  type: 'string',
+                },
+                uniqueItems: true,
+              },
+            ],
           },
           skipInlineCode: {
             type: 'boolean',
@@ -90,11 +101,14 @@ export default {
 
     return {
       code(node) {
-        if (skipCode) skipRanges.push(sourceCode.getRange(node)); // Store position information of `Code`.
+        if (
+          Array.isArray(skipCode) ? node.lang && skipCode.includes(node.lang) : skipCode
+        )
+          skipRanges.push(sourceCode.getRange(node)); // Store range information of `Code`.
       },
 
       inlineCode(node) {
-        if (skipInlineCode) skipRanges.push(sourceCode.getRange(node)); // Store position information of `InlineCode`.
+        if (skipInlineCode) skipRanges.push(sourceCode.getRange(node)); // Store range information of `InlineCode`.
       },
 
       'root:exit'() {

package/src/rules/no-git-conflict-marker.js

@@ -16,7 +16,7 @@ import { URL_RULE_DOCS } from '../core/constants.js';
 
 /**
  * @import { RuleModule } from '../core/types.js';
- * @typedef {[{ skipCode: boolean }]} RuleOptions
+ * @typedef {[{ skipCode: boolean | string[] }]} RuleOptions
  * @typedef {'noGitConflictMarker'} MessageIds
  */
 
@@ -47,7 +47,18 @@ export default {
         type: 'object',
         properties: {
           skipCode: {
-            type: 'boolean',
+            oneOf: [
+              {
+                type: 'boolean',
+              },
+              {
+                type: 'array',
+                items: {
+                  type: 'string',
+                },
+                uniqueItems: true,
+              },
+            ],
           },
         },
         additionalProperties: false,
@@ -78,7 +89,10 @@ export default {
 
     return {
       code(node) {
-        if (skipCode) skipRanges.push(sourceCode.getRange(node)); // Store range information of `Code`.
+        if (
+          Array.isArray(skipCode) ? node.lang && skipCode.includes(node.lang) : skipCode
+        )
+          skipRanges.push(sourceCode.getRange(node)); // Store range information of `Code`.
       },
 
       'root:exit'() {

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 {[{ allow: string[], skipCode: boolean, skipInlineCode: boolean }]} RuleOptions
+ * @typedef {[{ allow: string[], skipCode: boolean | string[], skipInlineCode: boolean }]} RuleOptions
  * @typedef {'noIrregularDash'} MessageIds
  */
 
@@ -55,7 +55,18 @@ export default {
             uniqueItems: true,
           },
           skipCode: {
-            type: 'boolean',
+            oneOf: [
+              {
+                type: 'boolean',
+              },
+              {
+                type: 'array',
+                items: {
+                  type: 'string',
+                },
+                uniqueItems: true,
+              },
+            ],
           },
           skipInlineCode: {
             type: 'boolean',
@@ -90,11 +101,14 @@ export default {
 
     return {
       code(node) {
-        if (skipCode) skipRanges.push(sourceCode.getRange(node)); // Store position information of `Code`.
+        if (
+          Array.isArray(skipCode) ? node.lang && skipCode.includes(node.lang) : skipCode
+        )
+          skipRanges.push(sourceCode.getRange(node)); // Store range information of `Code`.
       },
 
       inlineCode(node) {
-        if (skipInlineCode) skipRanges.push(sourceCode.getRange(node)); // Store position information of `InlineCode`.
+        if (skipInlineCode) skipRanges.push(sourceCode.getRange(node)); // Store range information of `InlineCode`.
       },
 
       'root:exit'() {

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 {[{ allow: string[], skipCode: boolean, skipInlineCode: boolean }]} RuleOptions
+ * @typedef {[{ allow: string[], skipCode: boolean | string[], skipInlineCode: boolean }]} RuleOptions
  * @typedef {'noIrregularWhitespace'} MessageIds
  */
 
@@ -55,7 +55,18 @@ export default {
             uniqueItems: true,
           },
           skipCode: {
-            type: 'boolean',
+            oneOf: [
+              {
+                type: 'boolean',
+              },
+              {
+                type: 'array',
+                items: {
+                  type: 'string',
+                },
+                uniqueItems: true,
+              },
+            ],
           },
           skipInlineCode: {
             type: 'boolean',
@@ -91,7 +102,10 @@ export default {
 
     return {
       code(node) {
-        if (skipCode) skipRanges.push(sourceCode.getRange(node)); // Store range information of `Code`.
+        if (
+          Array.isArray(skipCode) ? node.lang && skipCode.includes(node.lang) : skipCode
+        )
+          skipRanges.push(sourceCode.getRange(node)); // Store range information of `Code`.
       },
 
       inlineCode(node) {

package/src/rules/no-tab.js

@@ -16,7 +16,7 @@ import { URL_RULE_DOCS } from '../core/constants.js';
 
 /**
  * @import { RuleModule } from '../core/types.js';
- * @typedef {[{ skipCode: boolean, skipInlineCode: boolean, tabWidth: number }]} RuleOptions
+ * @typedef {[{ skipCode: boolean | string[], skipInlineCode: boolean, tabWidth: number }]} RuleOptions
  * @typedef {'noTab'} MessageIds
  */
 
@@ -49,7 +49,18 @@ export default {
         type: 'object',
         properties: {
           skipCode: {
-            type: 'boolean',
+            oneOf: [
+              {
+                type: 'boolean',
+              },
+              {
+                type: 'array',
+                items: {
+                  type: 'string',
+                },
+                uniqueItems: true,
+              },
+            ],
           },
           skipInlineCode: {
             type: 'boolean',
@@ -88,7 +99,10 @@ export default {
 
     return {
       code(node) {
-        if (skipCode) skipRanges.push(sourceCode.getRange(node)); // Store range information of `Code`.
+        if (
+          Array.isArray(skipCode) ? node.lang && skipCode.includes(node.lang) : skipCode
+        )
+          skipRanges.push(sourceCode.getRange(node)); // Store range information of `Code`.
       },
 
       inlineCode(node) {