eslint-markdown 0.7.0 → 0.9.0

package/build/rules/index.d.ts

@@ -11,9 +11,9 @@ 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-punctuation': import("../core/types.js").RuleModule<import("./no-double-punctuation.js").RuleOptions, import("./no-double-punctuation.js").MessageIds>;
     '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-emoji': import("../core/types.js").RuleModule<import("./no-emoji.js").RuleOptions, "noEmoji">;
     '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">;

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

@@ -7,6 +7,8 @@ declare const _default: {
             recommended: boolean;
             stylistic: false;
         };
+        fixable: "code";
+        hasSuggestions: true;
         schema: {
             type: "object";
             properties: {
@@ -28,6 +30,8 @@ declare const _default: {
         }];
         messages: {
             noDoublePunctuation: string;
+            suggestReplaceWithLeft: string;
+            suggestReplaceWithRight: string;
         };
         language: string;
         dialects: string[];
@@ -37,7 +41,7 @@ declare const _default: {
         Code: import("@eslint/markdown").MarkdownSourceCode;
         RuleOptions: RuleOptions;
         Node: import("mdast").Node;
-        MessageIds: "noDoublePunctuation";
+        MessageIds: MessageIds;
     }>): {
         text(node: import("mdast").Text): void;
     };
@@ -46,4 +50,4 @@ export default _default;
 export type RuleOptions = [{
     allow: string[];
 }];
-export type MessageIds = "noDoublePunctuation";
+export type MessageIds = "noDoublePunctuation" | "suggestReplaceWithLeft" | "suggestReplaceWithRight";

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

@@ -7,6 +7,22 @@ declare const _default: {
             recommended: boolean;
             stylistic: false;
         };
+        schema: {
+            type: "object";
+            properties: {
+                allow: {
+                    type: "array";
+                    items: {
+                        type: "string";
+                    };
+                    uniqueItems: true;
+                };
+            };
+            additionalProperties: false;
+        }[];
+        defaultOptions: [{
+            allow: never[];
+        }];
         messages: {
             noEmoji: string;
         };
@@ -16,7 +32,7 @@ declare const _default: {
     create(context: import("@eslint/core").RuleContext<{
         LangOptions: import("@eslint/markdown").MarkdownLanguageOptions;
         Code: import("@eslint/markdown").MarkdownSourceCode;
-        RuleOptions: [];
+        RuleOptions: RuleOptions;
         Node: import("mdast").Node;
         MessageIds: "noEmoji";
     }>): {
@@ -24,5 +40,7 @@ declare const _default: {
     };
 };
 export default _default;
-export type RuleOptions = [];
+export type RuleOptions = [{
+    allow: string[];
+}];
 export type MessageIds = "noEmoji";

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

@@ -7,6 +7,7 @@ declare const _default: {
             recommended: boolean;
             stylistic: false;
         };
+        fixable: "code";
         schema: {
             type: "object";
             properties: {

package/package.json

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

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

@@ -16,7 +16,7 @@ import { URL_RULE_DOCS } from '../core/constants.js';
 /**
  * @import { RuleModule } from '../core/types.js';
  * @typedef {[{ allow: string[] }]} RuleOptions
- * @typedef {'noDoublePunctuation'} MessageIds
+ * @typedef {'noDoublePunctuation' | 'suggestReplaceWithLeft' | 'suggestReplaceWithRight'} MessageIds
  */
 
 // --------------------------------------------------------------------------------
@@ -45,6 +45,10 @@ export default {
       stylistic: false,
     },
 
+    fixable: 'code',
+
+    hasSuggestions: true,
+
     schema: [
       {
         type: 'object',
@@ -72,6 +76,10 @@ export default {
 
     messages: {
       noDoublePunctuation: 'Double punctuation mark `{{ punctuation }}` is not allowed.',
+      suggestReplaceWithLeft:
+        'Replace `{{ punctuation }}` with the left punctuation mark `{{ leftPunctuation }}`.',
+      suggestReplaceWithRight:
+        'Replace `{{ punctuation }}` with the right punctuation mark `{{ rightPunctuation }}`.',
     },
 
     language: 'markdown',
@@ -96,7 +104,8 @@ export default {
 
           if (allow.includes(punctuation)) continue;
 
-          context.report({
+          const [leftPunctuation, rightPunctuation] = punctuation;
+          const violation = /** @type {const} */ ({
             loc: {
               start: sourceCode.getLocFromIndex(startOffset),
               end: sourceCode.getLocFromIndex(endOffset),
@@ -108,6 +117,53 @@ export default {
 
             messageId: 'noDoublePunctuation',
           });
+
+          if (leftPunctuation === rightPunctuation) {
+            context.report({
+              ...violation,
+
+              fix(fixer) {
+                return fixer.replaceTextRange([startOffset, endOffset], leftPunctuation);
+              },
+            });
+          } else {
+            context.report({
+              ...violation,
+
+              suggest: [
+                {
+                  messageId: 'suggestReplaceWithLeft',
+
+                  data: {
+                    punctuation,
+                    leftPunctuation,
+                  },
+
+                  fix(fixer) {
+                    return fixer.replaceTextRange(
+                      [startOffset, endOffset],
+                      leftPunctuation,
+                    );
+                  },
+                },
+                {
+                  messageId: 'suggestReplaceWithRight',
+
+                  data: {
+                    punctuation,
+                    rightPunctuation,
+                  },
+
+                  fix(fixer) {
+                    return fixer.replaceTextRange(
+                      [startOffset, endOffset],
+                      rightPunctuation,
+                    );
+                  },
+                },
+              ],
+            });
+          }
         }
       },
     };

package/src/rules/no-emoji.js

@@ -15,7 +15,7 @@ import { URL_RULE_DOCS } from '../core/constants.js';
 
 /**
  * @import { RuleModule } from '../core/types.js';
- * @typedef {[]} RuleOptions
+ * @typedef {[{ allow: string[] }]} RuleOptions
  * @typedef {'noEmoji'} MessageIds
  */
 
@@ -41,6 +41,28 @@ export default {
       stylistic: false,
     },
 
+    schema: [
+      {
+        type: 'object',
+        properties: {
+          allow: {
+            type: 'array',
+            items: {
+              type: 'string',
+            },
+            uniqueItems: true,
+          },
+        },
+        additionalProperties: false,
+      },
+    ],
+
+    defaultOptions: [
+      {
+        allow: [],
+      },
+    ],
+
     messages: {
       noEmoji: 'Emojis are not allowed.',
     },
@@ -52,6 +74,7 @@ export default {
 
   create(context) {
     const { sourceCode } = context;
+    const [{ allow }] = context.options;
 
     return {
       text(node) {
@@ -59,8 +82,12 @@ export default {
         const matches = sourceCode.getText(node).matchAll(emojiRegex);
 
         for (const match of matches) {
+          const emoji = match[0];
+
+          if (allow.includes(emoji)) continue;
+
           const startOffset = nodeStartOffset + match.index;
-          const endOffset = startOffset + match[0].length;
+          const endOffset = startOffset + emoji.length;
 
           context.report({
             loc: {

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

@@ -24,7 +24,8 @@ import { URL_RULE_DOCS } from '../core/constants.js';
 // Helper
 // --------------------------------------------------------------------------------
 
-const gitConflictMarkerRegex = /(?:^|(?<=[\r\n]))(?:<{7}(?!<)|={7}(?!=)|>{7}(?!>))/gu;
+const gitConflictMarkerRegex =
+  /(?:^|(?<=[\r\n]))(?<gitConflictMarker><{7}(?!<)|={7}(?!=)|>{7}(?!>))[^\r\n]*\r?\n?/gu;
 
 // --------------------------------------------------------------------------------
 // Rule Definition
@@ -42,6 +43,8 @@ export default {
       stylistic: false,
     },
 
+    fixable: 'code',
+
     schema: [
       {
         type: 'object',
@@ -99,7 +102,7 @@ export default {
         const matches = sourceCode.text.matchAll(gitConflictMarkerRegex);
 
         for (const match of matches) {
-          const gitConflictMarker = match[0];
+          const gitConflictMarker = match[1];
 
           const startOffset = match.index;
           const endOffset = startOffset + gitConflictMarker.length;
@@ -117,6 +120,11 @@ export default {
             },
 
             messageId: 'noGitConflictMarker',
+
+            fix(fixer) {
+              // Remove the entire line containing the git conflict marker, including the newline character.
+              return fixer.removeRange([startOffset, startOffset + match[0].length]);
+            },
           });
         }
       },

package/build/rules/footnote-order.d.ts

@@ -1 +0,0 @@
-export {};

package/src/rules/footnote-order.js

@@ -1,2 +0,0 @@
-// TODO
-// https://github.com/textlint-rule/textlint-rule-footnote-order