eslint-markdown 0.8.0 → 0.9.1

package/LICENSE.md

@@ -1,6 +1,6 @@
 The MIT License
 
-Copyright (c) 2024-present 루밀LuMir(lumirlumir)
+Copyright (c) 2024-present lumir(lumirlumir)
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -13,7 +13,7 @@
 > If you like this package, please give it a star on [GitHub](https://github.com/lumirlumir/npm-eslint-markdown)!⭐<br/>
 > Your support helps us improve and maintain the project.
 
-Lint your Markdown with ESLint.🛠️
+Lint your Markdown with ESLint. Additional rules for use with `@eslint/markdown`.🛠️
 
 ## Documentation
 

package/build/rules/index.d.ts

@@ -11,7 +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-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<import("./no-emoji.js").RuleOptions, "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

@@ -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/package.json

@@ -1,8 +1,9 @@
 {
   "name": "eslint-markdown",
-  "version": "0.8.0",
+  "version": "0.9.1",
   "type": "module",
-  "description": "Lint your Markdown with ESLint.🛠️",
+  "sideEffects": false,
+  "description": "Lint your Markdown with ESLint. Additional rules for use with `@eslint/markdown`.🛠️",
   "exports": {
     ".": {
       "types": "./build/index.d.ts",
@@ -26,6 +27,7 @@
     "LICENSE.md",
     "README.md",
     "!src/**/*.test.{js,ts}",
+    "!{src,build}/tests/**",
     "!**/fixtures/**"
   ],
   "keywords": [
@@ -39,7 +41,7 @@
     "commonmark",
     "gfm"
   ],
-  "author": "루밀LuMir <rpfos@naver.com> (https://github.com/lumirlumir)",
+  "author": "lumir <rpfos@naver.com> (https://github.com/lumirlumir)",
   "funding": "https://github.com/sponsors/lumirlumir",
   "license": "MIT",
   "homepage": "https://eslint-markdown.lumir.page",

package/src/rules/allow-heading.js

@@ -1,6 +1,6 @@
 /**
  * @fileoverview Rule to enforce the use of allowed text for headings.
- * @author 루밀LuMir(lumirlumir)
+ * @author lumir(lumirlumir)
  */
 
 // --------------------------------------------------------------------------------

package/src/rules/allow-image-url.js

@@ -1,6 +1,6 @@
 /**
  * @fileoverview Rule to enforce the use of allowed or disallowed URLs for images.
- * @author 루밀LuMir(lumirlumir)
+ * @author lumir(lumirlumir)
  */
 
 // --------------------------------------------------------------------------------

package/src/rules/allow-link-url.js

@@ -1,6 +1,6 @@
 /**
  * @fileoverview Rule to enforce the use of allowed or disallowed URLs for links.
- * @author 루밀LuMir(lumirlumir)
+ * @author lumir(lumirlumir)
  */
 
 // --------------------------------------------------------------------------------

package/src/rules/code-lang-shorthand.js

@@ -1,6 +1,6 @@
 /**
  * @fileoverview Rule to enforce the use of shorthand for code block language identifiers.
- * @author 루밀LuMir(lumirlumir)
+ * @author lumir(lumirlumir)
  */
 
 // --------------------------------------------------------------------------------

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

@@ -1,6 +1,6 @@
 /**
  * @fileoverview Rule to enforce consistent code style.
- * @author 루밀LuMir(lumirlumir)
+ * @author lumir(lumirlumir)
  */
 
 /*

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

@@ -1,6 +1,6 @@
 /**
  * @fileoverview Rule to enforce consistent delete style.
- * @author 루밀LuMir(lumirlumir)
+ * @author lumir(lumirlumir)
  */
 
 // --------------------------------------------------------------------------------

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

@@ -1,6 +1,6 @@
 /**
  * @fileoverview Rule to enforce consistent emphasis style.
- * @author 루밀LuMir(lumirlumir)
+ * @author lumir(lumirlumir)
  */
 
 // --------------------------------------------------------------------------------

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

@@ -1,6 +1,6 @@
 /**
  * @fileoverview Rule to enforce consistent inline code style.
- * @author 루밀LuMir(lumirlumir)
+ * @author lumir(lumirlumir)
  * @see https://github.com/DavidAnson/markdownlint/blob/v0.40.0/lib/md038.mjs
  */
 

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

@@ -1,6 +1,6 @@
 /**
  * @fileoverview Rule to enforce consistent strong style.
- * @author 루밀LuMir(lumirlumir)
+ * @author lumir(lumirlumir)
  */
 
 // --------------------------------------------------------------------------------

package/src/rules/consistent-thematic-break-style.js

@@ -1,6 +1,6 @@
 /**
  * @fileoverview Rule to enforce consistent thematic break style.
- * @author 루밀LuMir(lumirlumir)
+ * @author lumir(lumirlumir)
  */
 
 // --------------------------------------------------------------------------------

package/src/rules/en-capitalization.js

@@ -1,6 +1,6 @@
 /**
  * @fileoverview Rule to enforce the use of capital letters at the beginning of sentences.
- * @author 루밀LuMir(lumirlumir)
+ * @author lumir(lumirlumir)
  */
 
 // @ts-nocheck -- TODO

package/src/rules/heading-id.js

@@ -1,6 +1,6 @@
 /**
  * @fileoverview Rule to enforce the use of heading IDs.
- * @author 루밀LuMir(lumirlumir)
+ * @author lumir(lumirlumir)
  */
 
 // @ts-nocheck -- TODO

package/src/rules/no-bold-paragraph.js

@@ -1,6 +1,6 @@
 /**
  * @fileoverview Rule to disallow using fully bolded paragraphs as headings.
- * @author 루밀LuMir(lumirlumir)
+ * @author lumir(lumirlumir)
  */
 
 // @ts-nocheck -- TODO

package/src/rules/no-control-character.js

@@ -1,6 +1,6 @@
 /**
  * @fileoverview Rule to disallow control character.
- * @author 루밀LuMir(lumirlumir)
+ * @author lumir(lumirlumir)
  */
 
 // --------------------------------------------------------------------------------

package/src/rules/no-curly-quote.js

@@ -1,6 +1,6 @@
 /**
  * @fileoverview Rule to disallow curly quotes(`“`, `”`, `‘` or `’`) in text.
- * @author 루밀LuMir(lumirlumir)
+ * @author lumir(lumirlumir)
  */
 
 // --------------------------------------------------------------------------------

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

@@ -1,6 +1,6 @@
 /**
  * @fileoverview Rule to disallow double consecutive punctuation in text.
- * @author 루밀LuMir(lumirlumir)
+ * @author lumir(lumirlumir)
  */
 
 // --------------------------------------------------------------------------------
@@ -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-double-space.js

@@ -1,6 +1,6 @@
 /**
  * @fileoverview Rule to disallow double or multiple consecutive spaces in text, except for leading and trailing spaces.
- * @author 루밀LuMir(lumirlumir)
+ * @author lumir(lumirlumir)
  */
 
 // --------------------------------------------------------------------------------

package/src/rules/no-emoji.js

@@ -1,6 +1,6 @@
 /**
  * @fileoverview Rule to disallow emojis in text.
- * @author 루밀LuMir(lumirlumir)
+ * @author lumir(lumirlumir)
  */
 
 // --------------------------------------------------------------------------------

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

@@ -1,6 +1,6 @@
 /**
  * @fileoverview Rule to disallow git conflict markers.
- * @author 루밀LuMir(lumirlumir)
+ * @author lumir(lumirlumir)
  */
 
 // --------------------------------------------------------------------------------

package/src/rules/no-irregular-dash.js

@@ -1,6 +1,6 @@
 /**
  * @fileoverview Rule to disallow irregular dash.
- * @author 루밀LuMir(lumirlumir)
+ * @author lumir(lumirlumir)
  */
 
 // --------------------------------------------------------------------------------

package/src/rules/no-irregular-whitespace.js

@@ -1,6 +1,6 @@
 /**
  * @fileoverview Rule to disallow irregular whitespace.
- * @author 루밀LuMir(lumirlumir)
+ * @author lumir(lumirlumir)
  */
 
 // --------------------------------------------------------------------------------

package/src/rules/no-tab.js

@@ -1,6 +1,6 @@
 /**
  * @fileoverview Rule to disallow tab characters.
- * @author 루밀LuMir(lumirlumir)
+ * @author lumir(lumirlumir)
  */
 
 // --------------------------------------------------------------------------------

package/src/rules/no-url-trailing-slash.js

@@ -1,6 +1,6 @@
 /**
  * @fileoverview Rule to disallow URL trailing slash.
- * @author 루밀LuMir(lumirlumir)
+ * @author lumir(lumirlumir)
  */
 
 // --------------------------------------------------------------------------------

package/src/rules/require-image-title.js

@@ -1,6 +1,6 @@
 /**
  * @fileoverview Rule to enforce the use of title attribute for images.
- * @author 루밀LuMir(lumirlumir)
+ * @author lumir(lumirlumir)
  */
 
 // --------------------------------------------------------------------------------

package/src/rules/require-link-title.js

@@ -1,6 +1,6 @@
 /**
  * @fileoverview Rule to enforce the use of title attribute for links.
- * @author 루밀LuMir(lumirlumir)
+ * @author lumir(lumirlumir)
  */
 
 // --------------------------------------------------------------------------------

package/build/core/rule-tester.d.ts

@@ -1,13 +0,0 @@
-/**
- * Markdown rule tester.
- * @param {string} ruleName Rule name.
- * @param {RuleModule<RuleOptions, MessageIds>} rule Rule module.
- * @param {Tests} tests Tests.
- */
-export default function ruleTester(ruleName: string, rule: RuleModule<RuleOptions, MessageIds>, tests: Tests): void;
-export type RuleOptions = MarkdownRuleDefinitionTypeOptions["RuleOptions"];
-export type MessageIds = MarkdownRuleDefinitionTypeOptions["MessageIds"];
-export type Tests = Parameters<RuleTester["run"]>[2];
-import type { RuleModule } from './types.js';
-import type { MarkdownRuleDefinitionTypeOptions } from '@eslint/markdown';
-import { RuleTester } from 'eslint';

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

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

package/src/core/rule-tester.js

@@ -1,127 +0,0 @@
-/**
- * @fileoverview Markdown rule tester.
- */
-
-// --------------------------------------------------------------------------------
-// Import
-// --------------------------------------------------------------------------------
-
-import { describe, it } from 'node:test';
-import { match, ok } from 'node:assert';
-import { RuleTester } from 'eslint';
-import markdown from '@eslint/markdown';
-
-// --------------------------------------------------------------------------------
-// Typedef
-// --------------------------------------------------------------------------------
-
-/**
- * @import { MarkdownRuleDefinitionTypeOptions } from '@eslint/markdown';
- * @import { RuleModule } from './types.js';
- * @typedef {MarkdownRuleDefinitionTypeOptions['RuleOptions']} RuleOptions
- * @typedef {MarkdownRuleDefinitionTypeOptions['MessageIds']} MessageIds
- * @typedef {Parameters<RuleTester['run']>[2]} Tests
- */
-
-// --------------------------------------------------------------------------------
-// Helper
-// --------------------------------------------------------------------------------
-
-/**
- * Rule tester for CommonMark.
- */
-const ruleTesterCommonmark = new RuleTester({
-  plugins: {
-    markdown,
-  },
-  language: 'markdown/commonmark',
-});
-
-/**
- * Rule tester for GFM.
- */
-const ruleTesterGfm = new RuleTester({
-  plugins: {
-    markdown,
-  },
-  language: 'markdown/gfm',
-});
-
-// --------------------------------------------------------------------------------
-// Export
-// --------------------------------------------------------------------------------
-
-/**
- * Markdown rule tester.
- * @param {string} ruleName Rule name.
- * @param {RuleModule<RuleOptions, MessageIds>} rule Rule module.
- * @param {Tests} tests Tests.
- */
-export default function ruleTester(ruleName, rule, tests) {
-  const { meta } = rule;
-
-  describe(ruleName, () => {
-    describe('meta', () => {
-      it('`meta` should exist', () => {
-        ok(meta);
-      });
-
-      it('`meta.type` should exist', () => {
-        ok(meta?.type);
-      });
-
-      it('`meta.docs` should exist', () => {
-        ok(meta?.docs);
-      });
-
-      it('`meta.docs.description` should exist and follow the convention', () => {
-        ok(meta?.docs?.description);
-        match(meta?.docs?.description, /^(?:Enforce|Require|Disallow) .+[^. ]$/);
-      });
-
-      it('`meta.docs.url` should exist and end with the rule name', () => {
-        ok(meta?.docs?.url);
-        match(meta?.docs?.url, new RegExp(`${ruleName}$`));
-      });
-
-      it('`meta.messages` should exist', () => {
-        ok(meta?.messages);
-      });
-
-      it('`meta.messages.messageId` should exist and value should follow the convention', () => {
-        // @ts-expect-error -- Required for testing.
-        Object.values(meta.messages).forEach(message => {
-          ok(message);
-          match(message, /^[^a-z].*\.$/);
-        });
-      });
-
-      it("`meta.language` should exist and be `'markdown'`", () => {
-        ok(meta?.language);
-        match(meta?.language, /^markdown$/);
-      });
-
-      it("`meta.dialects` should exist and be `'commonmark'` or `'gfm'`", () => {
-        ok(meta?.dialects);
-        ok(meta?.dialects.length > 0);
-        meta?.dialects.forEach(dialect => {
-          match(dialect, /^(?:commonmark|gfm)$/);
-        });
-      });
-    });
-
-    describe('rule', () => {
-      if (meta?.dialects?.includes('commonmark')) {
-        it('commonmark', () => {
-          ruleTesterCommonmark.run(ruleName, rule, tests);
-        });
-      }
-
-      if (meta?.dialects?.includes('gfm')) {
-        it('gfm', () => {
-          ruleTesterGfm.run(ruleName, rule, tests);
-        });
-      }
-    });
-  });
-}

package/src/rules/footnote-order.js

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