eslint-markdown 0.6.0 → 0.7.0

package/README.md

@@ -1,8 +1,7 @@
 # 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)
+[![ci](https://img.shields.io/github/actions/workflow/status/lumirlumir/npm-eslint-markdown/ci.yml?label=ci&color=6358d4&labelColor=333333&logo=github)](https://github.com/lumirlumir/npm-eslint-markdown/actions/workflows/ci.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)
 

package/build/configs/all.d.ts

@@ -26,6 +26,7 @@ export default function all(plugin: ESLint.Plugin): {
         readonly 'md/consistent-unordered-list-style': "error";
         readonly 'md/no-control-character': "error";
         readonly 'md/no-curly-quote': "error";
+        readonly 'md/no-double-punctuation': "error";
         readonly 'md/no-double-space': "error";
         readonly 'md/no-emoji': "error";
         readonly 'md/no-git-conflict-marker': "error";

package/build/core/ast/is-blank-line.d.ts

@@ -1,6 +1,8 @@
 /**
  * Check if a line is blank.
+ * - NOTE: The `blockquoteDepth` parameter is zero-based: `0` means one blockquote marker, `1` means two, and so on.
  * @param {string} str Line string.
+ * @param {number} [blockquoteDepth] The depth of blockquotes. Default is `-1`.
  * @returns {boolean} `true` if the line is blank. `false` otherwise.
  */
-export default function isBlankLine(str: string): boolean;
+export default function isBlankLine(str: string, blockquoteDepth?: number): boolean;

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

@@ -58,7 +58,9 @@ declare const _default: {
         Node: import("mdast").Node;
         MessageIds: MessageIds;
     }>): {
+        blockquote(): void;
         code(node: import("mdast").Code): void;
+        'blockquote:exit'(): void;
     };
 };
 export default _default;

package/build/rules/index.d.ts

@@ -11,6 +11,7 @@ declare const _default: {
     '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-punctuation': import("../core/types.js").RuleModule<import("./no-double-punctuation.js").RuleOptions, "noDoublePunctuation">;
     'no-double-space': import("../core/types.js").RuleModule<import("./no-double-space.js").RuleOptions, import("./no-double-space.js").MessageIds>;
     'no-emoji': import("../core/types.js").RuleModule<[], "noEmoji">;
     'no-git-conflict-marker': import("../core/types.js").RuleModule<import("./no-git-conflict-marker.js").RuleOptions, "noGitConflictMarker">;

package/build/rules/no-double-punctuation.d.ts

@@ -0,0 +1,49 @@
+declare const _default: {
+    meta: {
+        type: "problem";
+        docs: {
+            description: string;
+            url: string;
+            recommended: boolean;
+            stylistic: false;
+        };
+        schema: {
+            type: "object";
+            properties: {
+                allow: {
+                    type: "array";
+                    items: {
+                        type: "string";
+                        minLength: number;
+                        maxLength: number;
+                        pattern: string;
+                    };
+                    uniqueItems: true;
+                };
+            };
+            additionalProperties: false;
+        }[];
+        defaultOptions: [{
+            allow: never[];
+        }];
+        messages: {
+            noDoublePunctuation: 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: "noDoublePunctuation";
+    }>): {
+        text(node: import("mdast").Text): void;
+    };
+};
+export default _default;
+export type RuleOptions = [{
+    allow: string[];
+}];
+export type MessageIds = "noDoublePunctuation";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eslint-markdown",
-  "version": "0.6.0",
+  "version": "0.7.0",
   "type": "module",
   "description": "Lint your Markdown with ESLint.🛠️",
   "exports": {
@@ -59,7 +59,7 @@
   },
   "scripts": {
     "prepublishOnly": "npm run build",
-    "build": "node ../../scripts/build-config.mjs && npx tsc && node ../../scripts/cp.mjs ../../LICENSE.md LICENSE.md ../../README.md README.md",
+    "build": "node ../../scripts/build-config.js && tsc && node ../../scripts/cp.js ../../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"
@@ -75,10 +75,11 @@
   "dependencies": {
     "@eslint/markdown": "^7.5.1",
     "micromark-util-normalize-identifier": "^2.0.1",
-    "parse5": "^8.0.0"
+    "parse5": "^8.0.1"
   },
   "devDependencies": {
     "@types/mdast": "^4.0.4",
+    "@types/unist": "^3.0.3",
     "eslint": "^9.39.4"
   }
 }

package/src/configs/all.js

@@ -1,6 +1,6 @@
 /**
  * @fileoverview `all` configuration.
- * WARNING: This file is autogenerated using the `scripts/build-config.mjs`
+ * WARNING: This file is autogenerated using the `scripts/build-config.js`
  */
 
 // --------------------------------------------------------------------------------
@@ -50,6 +50,7 @@ export default function all(plugin) {
       'md/consistent-unordered-list-style': 'error',
       'md/no-control-character': 'error',
       'md/no-curly-quote': 'error',
+      'md/no-double-punctuation': 'error',
       'md/no-double-space': 'error',
       'md/no-emoji': 'error',
       'md/no-git-conflict-marker': 'error',

package/src/configs/base.js

@@ -1,6 +1,6 @@
 /**
  * @fileoverview `base` configuration.
- * WARNING: This file is autogenerated using the `scripts/build-config.mjs`
+ * WARNING: This file is autogenerated using the `scripts/build-config.js`
  */
 
 // --------------------------------------------------------------------------------

package/src/configs/recommended.js

@@ -1,6 +1,6 @@
 /**
  * @fileoverview `recommended` configuration.
- * WARNING: This file is autogenerated using the `scripts/build-config.mjs`
+ * WARNING: This file is autogenerated using the `scripts/build-config.js`
  */
 
 // --------------------------------------------------------------------------------

package/src/configs/stylistic.js

@@ -1,6 +1,6 @@
 /**
  * @fileoverview `stylistic` configuration.
- * WARNING: This file is autogenerated using the `scripts/build-config.mjs`
+ * WARNING: This file is autogenerated using the `scripts/build-config.js`
  */
 
 // --------------------------------------------------------------------------------

package/src/core/ast/is-blank-line.js

@@ -8,6 +8,7 @@
 // --------------------------------------------------------------------------------
 
 const whitespaceChars = new Set([' ', '\t']);
+const blockquoteChar = '>';
 
 // --------------------------------------------------------------------------------
 // Export
@@ -15,15 +16,25 @@ const whitespaceChars = new Set([' ', '\t']);
 
 /**
  * Check if a line is blank.
+ * - NOTE: The `blockquoteDepth` parameter is zero-based: `0` means one blockquote marker, `1` means two, and so on.
  * @param {string} str Line string.
+ * @param {number} [blockquoteDepth] The depth of blockquotes. Default is `-1`.
  * @returns {boolean} `true` if the line is blank. `false` otherwise.
  */
-export default function isBlankLine(str) {
+export default function isBlankLine(str, blockquoteDepth = -1) {
   // `.length` is cached for performance.
   const strLength = str.length;
+  let remainingBlockquotes = blockquoteDepth + 1;
 
   for (let i = 0; i < strLength; i++) {
-    if (!whitespaceChars.has(str[i])) {
+    const char = str[i];
+
+    if (!whitespaceChars.has(char)) {
+      if (remainingBlockquotes > 0 && char === blockquoteChar) {
+        remainingBlockquotes--;
+        continue;
+      }
+
       return false;
     }
   }

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

@@ -132,8 +132,14 @@ export default {
 
     /** @type {CodeStyle | null} */
     let codeStyle = style === 'consistent' ? null : style;
+    let blockquoteDepth = -1; // NOTE: Depth `0` is the first blockquote level, which is the top level.
 
     return {
+      blockquote() {
+        // When entering a `blockquote` node, increase the depth.
+        blockquoteDepth++;
+      },
+
       code(node) {
         // ------------------------------------------------------------------------
         // 1. Check code style consistency.
@@ -182,7 +188,7 @@ export default {
             }
 
             // If the line is blank, continue checking the next line. If it's not blank, report the issue.
-            if (isBlankLine(line)) {
+            if (isBlankLine(line, blockquoteDepth)) {
               continue;
             }
 
@@ -225,7 +231,7 @@ export default {
             }
 
             // If the line is blank, continue checking the next line. If it's not blank, report the issue.
-            if (isBlankLine(line)) {
+            if (isBlankLine(line, blockquoteDepth)) {
               continue;
             }
 
@@ -244,6 +250,11 @@ export default {
           }
         }
       },
+
+      'blockquote:exit'() {
+        // When exiting a `blockquote` node, decrease the depth.
+        blockquoteDepth--;
+      },
     };
   },
 };

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

@@ -94,7 +94,7 @@ export default {
     const unorderedListStyle = [
       style === 'consistent' || style === 'sublist' ? null : style,
     ];
-    let listDepth = -1;
+    let listDepth = -1; // NOTE: Depth `0` is the first list level, which is the top level.
 
     return {
       list() {

package/src/rules/index.js

@@ -18,6 +18,7 @@ import consistentUnorderedListStyle from './consistent-unordered-list-style.js';
 // import noBoldParagraph from './no-bold-paragraph.js';
 import noControlCharacter from './no-control-character.js';
 import noCurlyQuote from './no-curly-quote.js';
+import noDoublePunctuation from './no-double-punctuation.js';
 import noDoubleSpace from './no-double-space.js';
 import noEmoji from './no-emoji.js';
 import noGitConflictMarker from './no-git-conflict-marker.js';
@@ -45,6 +46,7 @@ export default {
   // 'no-bold-paragraph': noBoldParagraph,
   'no-control-character': noControlCharacter,
   'no-curly-quote': noCurlyQuote,
+  'no-double-punctuation': noDoublePunctuation,
   'no-double-space': noDoubleSpace,
   'no-emoji': noEmoji,
   'no-git-conflict-marker': noGitConflictMarker,

package/src/rules/no-double-punctuation.js

@@ -0,0 +1,115 @@
+/**
+ * @fileoverview Rule to disallow double consecutive punctuation in text.
+ * @author 루밀LuMir(lumirlumir)
+ */
+
+// --------------------------------------------------------------------------------
+// Import
+// --------------------------------------------------------------------------------
+
+import { URL_RULE_DOCS } from '../core/constants.js';
+
+// --------------------------------------------------------------------------------
+// Typedef
+// --------------------------------------------------------------------------------
+
+/**
+ * @import { RuleModule } from '../core/types.js';
+ * @typedef {[{ allow: string[] }]} RuleOptions
+ * @typedef {'noDoublePunctuation'} MessageIds
+ */
+
+// --------------------------------------------------------------------------------
+// Helper
+// --------------------------------------------------------------------------------
+
+/**
+ * This pattern is based on the punctuation list used by `remark-lint`.
+ * @see https://github.com/remarkjs/remark-lint/tree/main/packages/remark-lint-no-heading-punctuation#parameters
+ */
+const doublePunctuationRegex = /(?:^|(?<=[^!,.:;?]))[!,.:;?]{2}(?:$|(?=[^!,.:;?]))/g;
+
+// --------------------------------------------------------------------------------
+// Rule Definition
+// --------------------------------------------------------------------------------
+
+/** @type {RuleModule<RuleOptions, MessageIds>} */
+export default {
+  meta: {
+    type: 'problem',
+
+    docs: {
+      description: 'Disallow double consecutive punctuation in text',
+      url: URL_RULE_DOCS('no-double-punctuation'),
+      recommended: false,
+      stylistic: false,
+    },
+
+    schema: [
+      {
+        type: 'object',
+        properties: {
+          allow: {
+            type: 'array',
+            items: {
+              type: 'string',
+              minLength: 2,
+              maxLength: 2,
+              pattern: '^[!,.:;?]{2}$',
+            },
+            uniqueItems: true,
+          },
+        },
+        additionalProperties: false,
+      },
+    ],
+
+    defaultOptions: [
+      {
+        allow: [],
+      },
+    ],
+
+    messages: {
+      noDoublePunctuation: 'Double punctuation mark `{{ punctuation }}` is not allowed.',
+    },
+
+    language: 'markdown',
+
+    dialects: ['commonmark', 'gfm'],
+  },
+
+  create(context) {
+    const { sourceCode } = context;
+    const [{ allow }] = context.options;
+
+    return {
+      text(node) {
+        const [nodeStartOffset] = sourceCode.getRange(node);
+        const matches = sourceCode.getText(node).matchAll(doublePunctuationRegex);
+
+        for (const match of matches) {
+          const punctuation = match[0];
+
+          const startOffset = nodeStartOffset + match.index;
+          const endOffset = startOffset + punctuation.length;
+
+          if (allow.includes(punctuation)) continue;
+
+          context.report({
+            loc: {
+              start: sourceCode.getLocFromIndex(startOffset),
+              end: sourceCode.getLocFromIndex(endOffset),
+            },
+
+            data: {
+              punctuation,
+            },
+
+            messageId: 'noDoublePunctuation',
+          });
+        }
+      },
+    };
+  },
+};