eslint-plugin-markdown-preferences 0.1.0 → 0.1.1

package/README.md

@@ -1,6 +1,6 @@
-# Introduction
+# eslint-plugin-markdown-preferences
 
-[eslint-plugin-markdown-preferences](https://www.npmjs.com/package/eslint-plugin-markdown-preferences) is ESLint plugin that enforces our markdown preferences.
+A specialized ESLint plugin that helps enforce consistent writing style and formatting conventions in Markdown files. Perfect for documentation projects, blog posts, and any Markdown content where consistency matters.
 
 [![NPM license](https://img.shields.io/npm/l/eslint-plugin-markdown-preferences.svg)](https://www.npmjs.com/package/eslint-plugin-markdown-preferences)
 [![NPM version](https://img.shields.io/npm/v/eslint-plugin-markdown-preferences.svg)](https://www.npmjs.com/package/eslint-plugin-markdown-preferences)
@@ -13,15 +13,18 @@
 
 ## 📛 Features
 
-ESLint plugin that enforces our markdown preferences.
+- **🔧 Auto-fixable rules** - Automatically format your Markdown files to match your style preferences
+- **📝 Line break consistency** - Enforce consistent hard line break styles (backslash `\` vs trailing spaces)
+- **🔗 Link enforcement** - Ensure specific words or terms are properly linked to their documentation
+- **🎯 Customizable** - Configure rules to match your team's specific requirements
 
-You can check on the [Online DEMO](https://eslint-online-playground.netlify.app/#eslint-plugin-markdown-preferences).
+**Try it live:** Check out the [Online Demo](https://eslint-online-playground.netlify.app/#eslint-plugin-markdown-preferences) to see the plugin in action!
 
 <!--DOCS_IGNORE_START-->
 
 ## 📖 Documentation
 
-See [documents](https://ota-meshi.github.io/eslint-plugin-markdown-preferences/).
+For detailed usage instructions, rule configurations, and examples, visit our comprehensive [documentation site](https://ota-meshi.github.io/eslint-plugin-markdown-preferences/).
 
 ## 💿 Installation
 

package/lib/chunk-Cl8Af3a2.js

@@ -0,0 +1,11 @@
+//#region rolldown:runtime
+var __defProp = Object.defineProperty;
+var __export = (target, all) => {
+	for (var name in all) __defProp(target, name, {
+		get: all[name],
+		enumerable: true
+	});
+};
+
+//#endregion
+export { __export };

package/lib/index.d.ts

@@ -1,76 +1,37 @@
-import * as _eslint_core from '@eslint/core';
-import { RuleDefinition } from '@eslint/core';
-import { Linter, ESLint } from 'eslint';
-import markdown from '@eslint/markdown';
-
-declare module 'eslint' {
-    namespace Linter {
-        interface RulesRecord extends RuleOptions {
-        }
-    }
-}
-interface RuleOptions {
-    /**
-     * enforce consistent hard linebreak style.
-     * @see https://ota-meshi.github.io/eslint-plugin-markdown-preferences/rules/hard-linebreak-style.html
-     */
-    'markdown-preferences/hard-linebreak-style'?: Linter.RuleEntry<MarkdownPreferencesHardLinebreakStyle>;
-    /**
-     * enforce the specified word to be a link.
-     * @see https://ota-meshi.github.io/eslint-plugin-markdown-preferences/rules/prefer-linked-words.html
-     */
-    'markdown-preferences/prefer-linked-words'?: Linter.RuleEntry<MarkdownPreferencesPreferLinkedWords>;
+import markdown from "@eslint/markdown";
+import * as _eslint_core0 from "@eslint/core";
+import { RuleDefinition } from "@eslint/core";
+import { ESLint, Linter } from "eslint";
+
+//#region src/configs/recommended.d.ts
+declare namespace recommended_d_exports {
+  export { files, language, name$1 as name, plugins, rules$1 as rules };
 }
-type MarkdownPreferencesHardLinebreakStyle = [] | [
-    {
-        style?: ("backslash" | "spaces");
-    }
-];
-type MarkdownPreferencesPreferLinkedWords = [] | [
-    {
-        words: ({
-            [k: string]: (string | null);
-        } | string[]);
-        [k: string]: unknown | undefined;
-    }
-];
-
 declare const name$1 = "markdown-preferences/recommended";
 declare const files: string[];
 declare const language = "markdown/commonmark";
 declare const plugins: {
-    markdown: typeof markdown;
-    readonly "markdown-preferences": ESLint.Plugin;
+  markdown: typeof markdown;
+  readonly "markdown-preferences": ESLint.Plugin;
 };
 declare const rules$1: Linter.RulesRecord;
-
-declare const recommended_files: typeof files;
-declare const recommended_language: typeof language;
-declare const recommended_plugins: typeof plugins;
-declare namespace recommended {
-  export { recommended_files as files, recommended_language as language, name$1 as name, recommended_plugins as plugins, rules$1 as rules };
+declare namespace meta_d_exports {
+  export { name, version };
 }
-
 declare const name: "eslint-plugin-markdown-preferences";
-declare const version: "0.1.0";
-
-declare const meta_name: typeof name;
-declare const meta_version: typeof version;
-declare namespace meta {
-  export { meta_name as name, meta_version as version };
-}
-
+declare const version: "0.1.1";
+//#endregion
+//#region src/index.d.ts
 declare const configs: {
-    recommended: typeof recommended;
+  recommended: typeof recommended_d_exports;
 };
 declare const rules: Record<string, RuleDefinition>;
-
 declare const _default: {
-    meta: typeof meta;
-    configs: {
-        recommended: typeof recommended;
-    };
-    rules: Record<string, RuleDefinition<_eslint_core.RuleDefinitionTypeOptions>>;
+  meta: typeof meta_d_exports;
+  configs: {
+    recommended: typeof recommended_d_exports;
+  };
+  rules: Record<string, RuleDefinition<_eslint_core0.RuleDefinitionTypeOptions>>;
 };
-
-export { configs, _default as default, meta, rules };
+//#endregion
+export { configs, _default as default, meta_d_exports as meta, rules };

package/lib/index.js

@@ -1,251 +1,219 @@
-import path from 'path';
-import markdown from '@eslint/markdown';
+import { __export } from "./chunk-Cl8Af3a2.js";
+import path from "node:path";
+import markdown from "@eslint/markdown";
 
-var __defProp = Object.defineProperty;
-var __export = (target, all) => {
-  for (var name3 in all)
-    __defProp(target, name3, { get: all[name3], enumerable: true });
-};
-
-// src/utils/index.ts
+//#region src/utils/index.ts
+/**
+* Define the rule.
+* @param ruleName ruleName
+* @param rule rule module
+*/
 function createRule(ruleName, rule) {
-  return {
-    meta: {
-      ...rule.meta,
-      docs: {
-        ...rule.meta.docs,
-        url: `https://ota-meshi.github.io/eslint-plugin-markdown-preferences/rules/${ruleName}.html`,
-        ruleId: `markdown-preferences/${ruleName}`,
-        ruleName
-      }
-    },
-    create(context) {
-      return rule.create(context);
-    }
-  };
+	return {
+		meta: {
+			...rule.meta,
+			docs: {
+				...rule.meta.docs,
+				url: `https://ota-meshi.github.io/eslint-plugin-markdown-preferences/rules/${ruleName}.html`,
+				ruleId: `markdown-preferences/${ruleName}`,
+				ruleName
+			}
+		},
+		create(context) {
+			return rule.create(context);
+		}
+	};
 }
 
-// src/rules/hard-linebreak-style.ts
+//#endregion
+//#region src/rules/hard-linebreak-style.ts
 var hard_linebreak_style_default = createRule("hard-linebreak-style", {
-  meta: {
-    type: "layout",
-    docs: {
-      description: "enforce consistent hard linebreak style.",
-      categories: ["recommended"]
-    },
-    fixable: "code",
-    hasSuggestions: false,
-    schema: [
-      {
-        type: "object",
-        properties: {
-          style: {
-            enum: ["backslash", "spaces"]
-          }
-        },
-        additionalProperties: false
-      }
-    ],
-    messages: {
-      expectedBackslash: "Expected a backslash linebreak.",
-      expectedSpaces: "Expected a space linebreak."
-    }
-  },
-  create(context) {
-    const sourceCode = context.sourceCode;
-    const linebreakStyle = context.options[0]?.style || "backslash";
-    return {
-      break: (node) => {
-        const text = sourceCode.getText(node);
-        if (linebreakStyle === "backslash" && !text.startsWith("\\")) {
-          context.report({
-            node,
-            messageId: "expectedBackslash",
-            fix(fixer) {
-              return fixer.replaceText(node, "\\\n");
-            }
-          });
-        } else if (linebreakStyle === "spaces" && !text.startsWith("  ")) {
-          context.report({
-            node,
-            messageId: "expectedSpaces",
-            fix(fixer) {
-              return fixer.replaceText(node, "  \n");
-            }
-          });
-        }
-      }
-    };
-  }
+	meta: {
+		type: "layout",
+		docs: {
+			description: "enforce consistent hard linebreak style.",
+			categories: ["recommended"]
+		},
+		fixable: "code",
+		hasSuggestions: false,
+		schema: [{
+			type: "object",
+			properties: { style: { enum: ["backslash", "spaces"] } },
+			additionalProperties: false
+		}],
+		messages: {
+			expectedBackslash: "Expected a backslash linebreak.",
+			expectedSpaces: "Expected a space linebreak."
+		}
+	},
+	create(context) {
+		const sourceCode = context.sourceCode;
+		const linebreakStyle = context.options[0]?.style || "backslash";
+		return { break: (node) => {
+			const text = sourceCode.getText(node);
+			if (linebreakStyle === "backslash" && !text.startsWith("\\")) context.report({
+				node,
+				messageId: "expectedBackslash",
+				fix(fixer) {
+					return fixer.replaceText(node, "\\\n");
+				}
+			});
+			else if (linebreakStyle === "spaces" && !text.startsWith("  ")) context.report({
+				node,
+				messageId: "expectedSpaces",
+				fix(fixer) {
+					return fixer.replaceText(node, "  \n");
+				}
+			});
+		} };
+	}
 });
+
+//#endregion
+//#region src/rules/prefer-linked-words.ts
+const RE_PUNCTUATOR = /^[\s,:]*$/u;
 var prefer_linked_words_default = createRule("prefer-linked-words", {
-  meta: {
-    type: "suggestion",
-    docs: {
-      description: "enforce the specified word to be a link.",
-      categories: []
-    },
-    fixable: "code",
-    hasSuggestions: false,
-    schema: [
-      {
-        type: "object",
-        properties: {
-          words: {
-            anyOf: [
-              {
-                type: "object",
-                patternProperties: {
-                  "^[\\s\\S]+$": {
-                    type: ["string", "null"]
-                  }
-                }
-              },
-              {
-                type: "array",
-                items: {
-                  type: "string"
-                }
-              }
-            ]
-          }
-        },
-        required: ["words"]
-      }
-    ],
-    messages: {
-      requireLink: 'The word "{{name}}" should be a link.'
-    }
-  },
-  create(context) {
-    const sourceCode = context.sourceCode;
-    const words = context.options[0]?.words || {};
-    const wordEntries = (Array.isArray(words) ? words.map((word) => [word, void 0]) : Object.entries(words)).map(
-      ([word, link]) => [word, link ? adjustLink(link) : void 0]
-    ).filter(([, link]) => link !== `./${path.basename(context.filename)}`);
-    let ignore = null;
-    return {
-      "link, linkReference, heading"(node) {
-        if (ignore) return;
-        ignore = node;
-      },
-      "link, linkReference, heading:exit"(node) {
-        if (ignore === node) ignore = null;
-      },
-      text(node) {
-        if (ignore) return;
-        for (const [word, link] of wordEntries) {
-          let startPosition = 0;
-          while (true) {
-            const index = node.value.indexOf(word, startPosition);
-            if (index < 0) break;
-            startPosition = index + word.length;
-            if ((node.value[index - 1] || "").trim() || (node.value[index + word.length] || "").trim()) {
-              continue;
-            }
-            const loc = sourceCode.getLoc(node);
-            const beforeLines = node.value.slice(0, index).split(/\n/u);
-            const line = loc.start.line + beforeLines.length - 1;
-            const column = (beforeLines.length === 1 ? loc.start.column : 1) + (beforeLines.at(-1) || "").length;
-            context.report({
-              node,
-              loc: {
-                start: { line, column },
-                end: { line, column: column + word.length }
-              },
-              messageId: "requireLink",
-              data: {
-                name: word
-              },
-              fix: link ? (fixer) => {
-                const [start] = sourceCode.getRange(node);
-                return fixer.replaceTextRange(
-                  [start + index, start + index + word.length],
-                  `[${word}](${link})`
-                );
-              } : null
-            });
-          }
-        }
-      },
-      inlineCode(node) {
-        if (ignore) return;
-        for (const [word, link] of wordEntries) {
-          if (node.value === word) {
-            context.report({
-              node,
-              messageId: "requireLink",
-              data: {
-                name: word
-              },
-              fix: link ? (fixer) => {
-                return fixer.replaceText(node, `[\`${word}\`](${link})`);
-              } : null
-            });
-          }
-        }
-      }
-    };
-    function adjustLink(link) {
-      if (/^\w+:/.test(link)) {
-        return link;
-      }
-      if (link.startsWith("#")) {
-        return link;
-      }
-      const absoluteLink = path.isAbsolute(link) ? link : path.join(context.cwd, link);
-      return `./${path.relative(path.dirname(context.filename), absoluteLink)}`;
-    }
-  }
+	meta: {
+		type: "suggestion",
+		docs: {
+			description: "enforce the specified word to be a link.",
+			categories: []
+		},
+		fixable: "code",
+		hasSuggestions: false,
+		schema: [{
+			type: "object",
+			properties: { words: { anyOf: [{
+				type: "object",
+				patternProperties: { "^[\\s\\S]+$": { type: ["string", "null"] } }
+			}, {
+				type: "array",
+				items: { type: "string" }
+			}] } },
+			required: ["words"]
+		}],
+		messages: { requireLink: "The word \"{{name}}\" should be a link." }
+	},
+	create(context) {
+		const sourceCode = context.sourceCode;
+		const words = context.options[0]?.words || {};
+		const wordEntries = (Array.isArray(words) ? words.map((word) => [word, void 0]) : Object.entries(words)).map(([word, link]) => [word, link ? adjustLink(link) : void 0]).filter(([, link]) => link !== `./${path.basename(context.filename)}`);
+		let ignore = null;
+		return {
+			"link, linkReference, heading"(node) {
+				if (ignore) return;
+				ignore = node;
+			},
+			"link, linkReference, heading:exit"(node) {
+				if (ignore === node) ignore = null;
+			},
+			text(node) {
+				if (ignore) return;
+				const text = sourceCode.getText(node);
+				for (const [word, link] of wordEntries) {
+					let startPosition = 0;
+					while (true) {
+						const index = text.indexOf(word, startPosition);
+						if (index < 0) break;
+						startPosition = index + word.length;
+						if (!RE_PUNCTUATOR.test(text[index - 1] || "") || !RE_PUNCTUATOR.test(text[index + word.length] || "")) continue;
+						const loc = sourceCode.getLoc(node);
+						const beforeLines = text.slice(0, index).split(/\n/u);
+						const line = loc.start.line + beforeLines.length - 1;
+						const column = (beforeLines.length === 1 ? loc.start.column : 1) + (beforeLines.at(-1) || "").length;
+						context.report({
+							node,
+							loc: {
+								start: {
+									line,
+									column
+								},
+								end: {
+									line,
+									column: column + word.length
+								}
+							},
+							messageId: "requireLink",
+							data: { name: word },
+							fix: link ? (fixer) => {
+								const [start] = sourceCode.getRange(node);
+								return fixer.replaceTextRange([start + index, start + index + word.length], `[${word}](${link})`);
+							} : null
+						});
+					}
+				}
+			},
+			inlineCode(node) {
+				if (ignore) return;
+				for (const [word, link] of wordEntries) if (node.value === word) context.report({
+					node,
+					messageId: "requireLink",
+					data: { name: word },
+					fix: link ? (fixer) => {
+						return fixer.replaceText(node, `[\`${word}\`](${link})`);
+					} : null
+				});
+			}
+		};
+		/**
+		* Adjust link to be relative to the file.
+		*/
+		function adjustLink(link) {
+			if (/^\w+:/.test(link)) return link;
+			if (link.startsWith("#")) return link;
+			const absoluteLink = path.isAbsolute(link) || path.posix.isAbsolute(link) ? link : path.join(context.cwd, link);
+			return `./${path.relative(path.dirname(context.filename), absoluteLink)}`;
+		}
+	}
 });
 
-// src/utils/rules.ts
-var rules = [hard_linebreak_style_default, prefer_linked_words_default];
+//#endregion
+//#region src/utils/rules.ts
+const rules$1 = [hard_linebreak_style_default, prefer_linked_words_default];
 
-// src/configs/recommended.ts
+//#endregion
+//#region src/configs/recommended.ts
 var recommended_exports = {};
 __export(recommended_exports, {
-  files: () => files,
-  language: () => language,
-  name: () => name,
-  plugins: () => plugins,
-  rules: () => rules2
+	files: () => files,
+	language: () => language,
+	name: () => name$1,
+	plugins: () => plugins,
+	rules: () => rules$2
 });
-var name = "markdown-preferences/recommended";
-var files = ["**/*.md"];
-var language = "markdown/commonmark";
-var plugins = {
-  markdown,
-  // eslint-disable-next-line @typescript-eslint/naming-convention -- ignore
-  get "markdown-preferences"() {
-    return index_default;
-  }
-};
-var rules2 = {
-  // eslint-plugin-markdown-preferences rules
-  "markdown-preferences/hard-linebreak-style": "error"
+const name$1 = "markdown-preferences/recommended";
+const files = ["**/*.md"];
+const language = "markdown/commonmark";
+const plugins = {
+	markdown,
+	get "markdown-preferences"() {
+		return src_default;
+	}
 };
+const rules$2 = { "markdown-preferences/hard-linebreak-style": "error" };
 
-// src/meta.ts
+//#endregion
+//#region src/meta.ts
 var meta_exports = {};
 __export(meta_exports, {
-  name: () => name2,
-  version: () => version
+	name: () => name,
+	version: () => version
 });
-var name2 = "eslint-plugin-markdown-preferences";
-var version = "0.1.0";
+const name = "eslint-plugin-markdown-preferences";
+const version = "0.1.1";
 
-// src/index.ts
-var configs = {
-  recommended: recommended_exports
+//#endregion
+//#region src/index.ts
+const configs = { recommended: recommended_exports };
+const rules = rules$1.reduce((obj, r) => {
+	obj[r.meta.docs.ruleName] = r;
+	return obj;
+}, {});
+var src_default = {
+	meta: meta_exports,
+	configs,
+	rules
 };
-var rules3 = rules.reduce(
-  (obj, r) => {
-    obj[r.meta.docs.ruleName] = r;
-    return obj;
-  },
-  {}
-);
-var index_default = { meta: meta_exports, configs, rules: rules3 };
 
-export { configs, index_default as default, meta_exports as meta, rules3 as rules };
+//#endregion
+export { configs, src_default as default, meta_exports as meta, rules };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eslint-plugin-markdown-preferences",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "description": "ESLint plugin that enforces our markdown preferences",
   "type": "module",
   "exports": {
@@ -16,9 +16,9 @@
     "node": "^20.19.0 || ^22.12.0 || >=24.0.0"
   },
   "scripts": {
-    "build": "npm run build:meta && npm run build:tsup",
+    "build": "npm run build:meta && npm run build:tsdown",
     "build:meta": "npm run ts -- ./tools/update-meta.ts",
-    "build:tsup": "tsup",
+    "build:tsdown": "tsdown",
     "lint": "eslint .",
     "tsc": "tsc --project tsconfig.build.json",
     "eslint-fix": "eslint . --fix",
@@ -30,7 +30,7 @@
     "docs:watch": "vitepress dev docs --open",
     "docs:build": "vitepress build docs",
     "ts": "node --import=tsx",
-    "mocha": "npm run ts ./node_modules/mocha/bin/mocha.js",
+    "mocha": "npm run ts -- ./node_modules/mocha/bin/mocha.js",
     "generate:version": "env-cmd -e version npm run update && npm run lint -- --fix",
     "changeset:version": "changeset version && npm run generate:version && git add --all",
     "changeset:publish": "npm run build && changeset publish"
@@ -54,10 +54,9 @@
     "url": "https://github.com/ota-meshi/eslint-plugin-markdown-preferences/issues"
   },
   "homepage": "https://ota-meshi.github.io/eslint-plugin-markdown-preferences/",
-  "dependencies": {},
   "peerDependencies": {
-    "eslint": ">=9.0.0",
-    "@eslint/markdown": "^7.1.0"
+    "@eslint/markdown": "^7.1.0",
+    "eslint": ">=9.0.0"
   },
   "devDependencies": {
     "@changesets/changelog-github": "^0.5.1",
@@ -107,7 +106,7 @@
     "stylelint-config-recommended-vue": "^1.6.0",
     "stylelint-config-standard": "^39.0.0",
     "stylelint-config-standard-vue": "^1.0.0",
-    "tsup": "^8.4.0",
+    "tsdown": "^0.13.1",
     "tsx": "^4.19.3",
     "twoslash-eslint": "^0.3.1",
     "type-fest": "^4.37.0",