eslint-markdown 0.4.0 → 0.5.0

package/build/configs/all.d.ts

@@ -17,6 +17,7 @@ export default function all(plugin: ESLint.Plugin): {
         readonly 'md/allow-image-url': "error";
         readonly 'md/allow-link-url': "error";
         readonly 'md/code-lang-shorthand': "error";
+        readonly 'md/consistent-code-style': "error";
         readonly 'md/consistent-delete-style': "error";
         readonly 'md/consistent-emphasis-style': "error";
         readonly 'md/consistent-strong-style': "error";

package/build/configs/stylistic.d.ts

@@ -14,6 +14,7 @@ export default function stylistic(plugin: ESLint.Plugin): {
     };
     readonly language: "markdown/gfm";
     readonly rules: {
+        readonly 'md/consistent-code-style': "error";
         readonly 'md/consistent-delete-style': "error";
         readonly 'md/consistent-emphasis-style': "error";
         readonly 'md/consistent-strong-style': "error";

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

@@ -0,0 +1,43 @@
+declare const _default: {
+    meta: {
+        type: "layout";
+        docs: {
+            description: string;
+            url: string;
+            recommended: boolean;
+            stylistic: true;
+        };
+        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";
+    }>): {
+        code(node: import("mdast").Code): void;
+    };
+};
+export default _default;
+export type CodeStyle = "indent" | "fence-backtick" | "fence-tilde";
+export type RuleOptions = [{
+    style: "consistent" | CodeStyle;
+}];
+export type MessageIds = "style";

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

@@ -39,9 +39,9 @@ declare const _default: {
     };
 };
 export default _default;
-export type UnorderedListMarker = "*" | "+" | "-";
+export type UnorderedListStyle = "*" | "+" | "-";
 export type RuleOptions = [{
-    style: "consistent" | "sublist" | UnorderedListMarker;
+    style: "consistent" | "sublist" | UnorderedListStyle;
 }];
 export type MessageIds = "style";
 import type { ListItem } from 'mdast';

package/build/rules/index.d.ts

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eslint-markdown",
-  "version": "0.4.0",
+  "version": "0.5.0",
   "type": "module",
   "description": "Lint your Markdown with ESLint.🛠️",
   "exports": {

package/src/configs/all.js

@@ -41,6 +41,7 @@ export default function all(plugin) {
       'md/allow-image-url': 'error',
       'md/allow-link-url': 'error',
       'md/code-lang-shorthand': 'error',
+      'md/consistent-code-style': 'error',
       'md/consistent-delete-style': 'error',
       'md/consistent-emphasis-style': 'error',
       'md/consistent-strong-style': 'error',

package/src/configs/stylistic.js

@@ -38,6 +38,7 @@ export default function stylistic(plugin) {
     },
     language: 'markdown/gfm',
     rules: {
+      'md/consistent-code-style': 'error',
       'md/consistent-delete-style': 'error',
       'md/consistent-emphasis-style': 'error',
       'md/consistent-strong-style': 'error',

package/src/core/tests/rule-tester.js

@@ -76,7 +76,7 @@ export default function ruleTester(ruleName, rule, tests) {
 
       it('`meta.docs.description` should exist and follow the convention', () => {
         ok(meta?.docs?.description);
-        match(meta?.docs?.description, /^(Enforce|Require|Disallow) .+[^. ]$/);
+        match(meta?.docs?.description, /^(?:Enforce|Require|Disallow) .+[^. ]$/);
       });
 
       it('`meta.docs.url` should exist and end with the rule name', () => {

package/src/rules/consistent-code-style.js

@@ -0,0 +1,129 @@
+/**
+ * @fileoverview Rule to enforce consistent code style.
+ * @author 루밀LuMir(lumirlumir)
+ */
+
+/*
+ * Note on autofix and suggestion safety:
+ * - Converting `fence-backtick` to `fence-tilde` is safe.
+ * - Converting `fence-backtick` to `indent` is not safe, as `lang` and `meta` information would be lost.
+ * - Converting `fence-tilde` to `fence-backtick` is safe.
+ * - Converting `fence-tilde` to `indent` is not safe, as `lang` and `meta` information would be lost.
+ * - Converting `indent` to `fence-backtick` is safe.
+ * - Converting `indent` to `fence-tilde` is safe.
+ */
+
+// --------------------------------------------------------------------------------
+// Import
+// --------------------------------------------------------------------------------
+
+import { URL_RULE_DOCS } from '../core/constants.js';
+
+// --------------------------------------------------------------------------------
+// Typedef
+// --------------------------------------------------------------------------------
+
+/**
+ * @import { RuleModule } from '../core/types.js';
+ * @typedef {'indent' | 'fence-backtick' | 'fence-tilde'} CodeStyle
+ * @typedef {[{ style: 'consistent' | CodeStyle }]} RuleOptions
+ * @typedef {'style'} MessageIds
+ */
+
+// --------------------------------------------------------------------------------
+// Helper
+// --------------------------------------------------------------------------------
+
+/**
+ * Get the current code style based on the given text.
+ * @param {string} text The text to determine the code style from.
+ * @returns {CodeStyle} The current code style.
+ */
+function getCurrentCodeStyle(text) {
+  if (text === '`') {
+    return 'fence-backtick';
+  } else if (text === '~') {
+    return 'fence-tilde';
+  } else {
+    return 'indent';
+  }
+}
+
+// --------------------------------------------------------------------------------
+// Rule Definition
+// --------------------------------------------------------------------------------
+
+/** @type {RuleModule<RuleOptions, MessageIds>} */
+export default {
+  meta: {
+    type: 'layout',
+
+    docs: {
+      description: 'Enforce consistent code style',
+      url: URL_RULE_DOCS('consistent-code-style'),
+      recommended: false,
+      stylistic: true,
+    },
+
+    // fixable: 'code', // TODO
+
+    // hasSuggestions: true, // TODO
+
+    schema: [
+      {
+        type: 'object',
+        properties: {
+          style: {
+            enum: ['consistent', 'indent', 'fence-backtick', 'fence-tilde'],
+          },
+        },
+        additionalProperties: false,
+      },
+    ],
+
+    defaultOptions: [
+      {
+        style: 'consistent',
+      },
+    ],
+
+    messages: {
+      style: 'Code style should be `{{ style }}`.',
+    },
+
+    language: 'markdown',
+
+    dialects: ['commonmark', 'gfm'],
+  },
+
+  create(context) {
+    const { sourceCode } = context;
+    const [{ style }] = context.options;
+
+    /** @type {CodeStyle | null} */
+    let codeStyle = style === 'consistent' ? null : style;
+
+    return {
+      code(node) {
+        const [nodeStartOffset] = sourceCode.getRange(node);
+        const currentCodeStyle = getCurrentCodeStyle(sourceCode.text[nodeStartOffset]);
+
+        if (codeStyle === null) {
+          codeStyle = currentCodeStyle;
+        }
+
+        if (codeStyle !== currentCodeStyle) {
+          context.report({
+            node,
+
+            messageId: 'style',
+
+            data: {
+              style: codeStyle,
+            },
+          });
+        }
+      },
+    };
+  },
+};

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

@@ -16,8 +16,8 @@ import { URL_RULE_DOCS } from '../core/constants.js';
 /**
  * @import { ListItem } from 'mdast';
  * @import { RuleModule } from '../core/types.js';
- * @typedef {'*' | '+' | '-'} UnorderedListMarker
- * @typedef {[{ style: 'consistent' | 'sublist' | UnorderedListMarker }]} RuleOptions
+ * @typedef {'*' | '+' | '-'} UnorderedListStyle
+ * @typedef {[{ style: 'consistent' | 'sublist' | UnorderedListStyle }]} RuleOptions
  * @typedef {'style'} MessageIds
  */
 
@@ -26,15 +26,15 @@ import { URL_RULE_DOCS } from '../core/constants.js';
 // --------------------------------------------------------------------------------
 
 /**
- * Get the next unordered list marker in sequence.
+ * Get the next unordered list style 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.
+ * @param {UnorderedListStyle} currentUnorderedListStyle The current unordered list style.
+ * @returns {UnorderedListStyle} The next unordered list style.
  */
-function getNextUnorderedListMarker(currentUnorderedListMarker) {
-  if (currentUnorderedListMarker === '-') {
+function getNextUnorderedListStyle(currentUnorderedListStyle) {
+  if (currentUnorderedListStyle === '-') {
     return '+';
-  } else if (currentUnorderedListMarker === '+') {
+  } else if (currentUnorderedListStyle === '+') {
     return '*';
   } else {
     return '-';
@@ -90,7 +90,7 @@ export default {
     const { sourceCode } = context;
     const [{ style }] = context.options;
 
-    /** @type {Array<UnorderedListMarker | null | undefined>} */
+    /** @type {Array<UnorderedListStyle | null | undefined>} */
     const unorderedListStyle = [
       style === 'consistent' || style === 'sublist' ? null : style,
     ];
@@ -105,7 +105,7 @@ export default {
 
       'list[ordered=false] > listItem'(/** @type {ListItem} */ node) {
         const [nodeStartOffset] = sourceCode.getRange(node);
-        const currentUnorderedListStyle = /** @type {UnorderedListMarker} */ (
+        const currentUnorderedListStyle = /** @type {UnorderedListStyle} */ (
           sourceCode.text[nodeStartOffset]
         );
         const currentListDepth = style === 'sublist' ? listDepth : 0;
@@ -115,7 +115,7 @@ export default {
           unorderedListStyle[currentListDepth] =
             // If the previous depth used the same style, use the next style in sequence.
             unorderedListStyle[currentListDepth - 1] === currentUnorderedListStyle
-              ? getNextUnorderedListMarker(currentUnorderedListStyle)
+              ? getNextUnorderedListStyle(currentUnorderedListStyle)
               : currentUnorderedListStyle;
         }
 

package/src/rules/index.js

@@ -6,6 +6,7 @@
 import allowImageUrl from './allow-image-url.js';
 import allowLinkUrl from './allow-link-url.js';
 import codeLangShorthand from './code-lang-shorthand.js';
+import consistentCodeStyle from './consistent-code-style.js';
 import consistentDeleteStyle from './consistent-delete-style.js';
 import consistentEmphasisStyle from './consistent-emphasis-style.js';
 import consistentStrongStyle from './consistent-strong-style.js';
@@ -31,6 +32,7 @@ export default {
   'allow-image-url': allowImageUrl,
   'allow-link-url': allowLinkUrl,
   'code-lang-shorthand': codeLangShorthand,
+  'consistent-code-style': consistentCodeStyle,
   'consistent-delete-style': consistentDeleteStyle,
   'consistent-emphasis-style': consistentEmphasisStyle,
   'consistent-strong-style': consistentStrongStyle,