eslint-plugin-md-style 0.3.0 → 0.3.1

package/dist/index.d.mts

@@ -1,5 +1,48 @@
+import "@eslint/markdown";
 import { ESLint, Linter } from "eslint";
-//#region src/index.d.ts
+//#region types/typegen.d.ts
+interface RuleOptions {
+  /**
+   * Enforce padding around VitePress custom containers.
+   * @see https://github.com/NoiseFan/eslint-plugin-md-style/blob/main/docs/rules/en/padding-around-custom-container.md
+   */
+  'md-style/padding-around-custom-container'?: Linter.RuleEntry<MdStylePaddingAroundCustomContainer>;
+  /**
+   * Enforce spacing around VitePress custom-container markers.
+   * @see https://github.com/NoiseFan/eslint-plugin-md-style/blob/main/docs/rules/en/space-around-custom-container.md
+   */
+  'md-style/space-around-custom-container'?: Linter.RuleEntry<[]>;
+  /**
+   * Enforce spacing around Markdown inline elements.
+   * @see https://github.com/NoiseFan/eslint-plugin-md-style/blob/main/docs/rules/en/space-around-inline-element.md
+   */
+  'md-style/space-around-inline-element'?: Linter.RuleEntry<[]>;
+  /**
+   * Enforce a single space between CJK characters and numbers.
+   * @see https://github.com/NoiseFan/eslint-plugin-md-style/blob/main/docs/rules/en/space-around-number.md
+   */
+  'md-style/space-around-number'?: Linter.RuleEntry<[]>;
+  /**
+   * Enforce a single space between CJK characters and Latin words.
+   * @see https://github.com/NoiseFan/eslint-plugin-md-style/blob/main/docs/rules/en/space-around-word.md
+   */
+  'md-style/space-around-word'?: Linter.RuleEntry<[]>;
+  /**
+   * Require custom containers to use a supported type.
+   * @see https://github.com/NoiseFan/eslint-plugin-md-style/blob/main/docs/rules/en/valid-custom-container-type.md
+   */
+  'md-style/valid-custom-container-type'?: Linter.RuleEntry<[]>;
+  /**
+   * Require strict lowercase anchors for headings that contain CJK text.
+   * @see https://github.com/NoiseFan/eslint-plugin-md-style/blob/main/docs/rules/en/valid-heading-anchor.md
+   */
+  'md-style/valid-heading-anchor'?: Linter.RuleEntry<[]>;
+}
+/* ======= Declarations ======= */
+// ----- md-style/padding-around-custom-container -----
+type MdStylePaddingAroundCustomContainer = [] | [("compact" | "loose")];
+//#endregion
+//#region index.d.ts
 declare const plugin: ESLint.Plugin;
 interface PluginConfigMap {
   recommended: Linter.Config;
@@ -11,4 +54,4 @@ type MdStylePlugin = ESLint.Plugin & {
 };
 declare const mdStylePlugin: MdStylePlugin;
 //#endregion
-export { MdStylePlugin, configs, mdStylePlugin as default, plugin };
+export { MdStylePlugin, type RuleOptions, configs, mdStylePlugin as default, plugin };

package/dist/index.mjs

@@ -1,5 +1,5 @@
 import markdown, { MarkdownLanguage } from "@eslint/markdown";
-//#region src/parser/ast.ts
+//#region parser/ast.ts
 function isObject(val) {
 	return !!val && typeof val === "object";
 }
@@ -87,7 +87,7 @@ function getAdjacentChar(str, position) {
 	return position === "head" ? str[0] : str[str.length - 1];
 }
 //#endregion
-//#region src/parser/custom-container/parse.ts
+//#region parser/custom-container/parser.ts
 /**
 * Parses top-level text into container, blank-line, and text nodes.
 */
@@ -344,18 +344,22 @@ function getCodeNodeRanges(node) {
 	return ranges;
 }
 //#endregion
-//#region src/utils/index.ts
-function createRule({ create, defaultOptions, meta }) {
+//#region utils/index.ts
+function createRule({ name, create, defaultOptions, meta }) {
 	return {
 		create,
 		meta: {
 			defaultOptions,
-			...meta
+			...meta,
+			docs: {
+				...meta?.docs,
+				url: `https://github.com/NoiseFan/eslint-plugin-md-style/blob/main/docs/rules/en/${name}.md`
+			}
 		}
 	};
 }
 //#endregion
-//#region src/rules/padding-around-custom-container/analyzs.ts
+//#region rules/padding-around-custom-container/analyzs.ts
 /**
 * Analyzes custom containers and returns de-duplicated padding issues.
 */
@@ -402,7 +406,7 @@ function analyzeInnerBoundary(children, containerBoundary, opts) {
 	});
 }
 /**
-*  Checks one side of a container's inner boundary for the selected mode.
+* Checks one side of a container's inner boundary for the selected mode.
 */
 function checkInnerSide(node, opts) {
 	const { direction, children, offset } = opts;
@@ -440,7 +444,7 @@ function getContainerBoundary(container) {
 	};
 }
 /**
-*  Checks both sides of a container for the required external blank line.
+* Checks both sides of a container for the required external blank line.
 */
 function analyzeOuterBoundary(children, boundaryIndex, opts) {
 	checkOuterSide(children, {
@@ -523,7 +527,7 @@ function getLineBreakFromChildren(children) {
 	return isBlankNode(blank) ? getLineBreak(blank.value) : "\n";
 }
 //#endregion
-//#region src/rules/padding-around-custom-container/index.ts
+//#region rules/padding-around-custom-container/index.ts
 const RULE_NAME$6 = "padding-around-custom-container";
 const MESSAGE_IDS$4 = {
 	missing: "missing",
@@ -533,7 +537,10 @@ var padding_around_custom_container_default = createRule({
 	name: RULE_NAME$6,
 	meta: {
 		type: "layout",
-		docs: { description: "Enforce padding around VitePress custom containers." },
+		docs: {
+			description: "Enforce padding around VitePress custom containers.",
+			recommended: true
+		},
 		messages: {
 			missing: "A custom container must be separated from surrounding content by one blank line.",
 			unexpected: "Unexpected blank lines around a custom container."
@@ -569,7 +576,7 @@ var padding_around_custom_container_default = createRule({
 	}
 });
 //#endregion
-//#region src/rules/space-around-custom-container/analyzs.ts
+//#region rules/space-around-custom-container/analyzs.ts
 /**
 * Finds custom-container marker lines and normalizes their surrounding spaces.
 *
@@ -621,7 +628,7 @@ function getMarkerMessageId(tag) {
 	return MESSAGE_IDS$3.unexpectedSeparator;
 }
 //#endregion
-//#region src/rules/space-around-custom-container/index.ts
+//#region rules/space-around-custom-container/index.ts
 const RULE_NAME$5 = "space-around-custom-container";
 const MESSAGE_IDS$3 = {
 	unexpectedIndentation: "unexpectedIndentation",
@@ -664,7 +671,7 @@ var space_around_custom_container_default = createRule({
 	}
 });
 //#endregion
-//#region src/utils/anchor.ts
+//#region utils/anchor.ts
 /**
 * Match the trailing anchor-like fragment from a heading or adjacent text.
 * @example `中文标题 {#Chinese-Title}` -> `{#Chinese-Title}`
@@ -693,7 +700,7 @@ function getLikeAnchor(str) {
 	};
 }
 //#endregion
-//#region src/utils/punctuation.ts
+//#region utils/punctuation.ts
 const OPENING_PAIRED_PUNCTUATION = /* @__PURE__ */ new Set([
 	"(",
 	"[",
@@ -774,7 +781,7 @@ function hasPunctuation(str, position = "head") {
 	else return isPunctuation(str[str.length - 1]);
 }
 //#endregion
-//#region src/utils/space.ts
+//#region utils/space.ts
 /**
 * Gets the count and range of consecutive whitespace at the start or end of a string.
 * @example `  text`, `head` -> { count: 2, start: 0, end: 2 }
@@ -806,7 +813,7 @@ function getWhiteSpace(str, position = "head") {
 	}
 }
 //#endregion
-//#region src/rules/space-around-inline-element/analyze.ts
+//#region rules/space-around-inline-element/analyze.ts
 /**
 * Validates whether a spacing run contains exactly one required space.
 */
@@ -863,13 +870,6 @@ const INLINE_ELEMENT_TYPES = /* @__PURE__ */ new Set([
 function isInlineElement(node) {
 	return !!node && INLINE_ELEMENT_TYPES.has(node.type);
 }
-/**
-* Checks whether the current inline element is nested inside another selected inline element.
-*/
-function isNestedInlineElement(nodeContext) {
-	const { parent } = nodeContext;
-	return isInlineElement(parent);
-}
 function getSpaceContext(nodeContext) {
 	const { prev, next } = nodeContext;
 	const prevValue = getNodeValue(prev);
@@ -927,7 +927,7 @@ function validateSpace(nodeContext) {
 	return validateDefaultSpace(nodeContext);
 }
 //#endregion
-//#region src/rules/space-around-inline-element/index.ts
+//#region rules/space-around-inline-element/index.ts
 const RULE_NAME$4 = "space-around-inline-element";
 const MESSAGE_IDS$2 = {
 	missingSpaceBefore: "missingSpaceBefore",
@@ -957,7 +957,10 @@ var space_around_inline_element_default = createRule({
 	name: RULE_NAME$4,
 	meta: {
 		type: "layout",
-		docs: { description: "Enforce spacing around Markdown inline elements." },
+		docs: {
+			description: "Enforce spacing around Markdown inline elements.",
+			recommended: true
+		},
 		messages: {
 			missingSpaceBefore: "A space is required before the inline element.",
 			missingSpaceAfter: "A space is required after the inline element.",
@@ -999,7 +1002,6 @@ function checkInlineElement(context, node) {
 	/* v8 ignore if -- @preserve */
 	if (!position) return;
 	const nodeContext = getNodeContext(context, node);
-	if (isNestedInlineElement(nodeContext)) return;
 	const spaceContext = getSpaceContext(nodeContext);
 	const issue = validateSpace(nodeContext);
 	if (!issue) return;
@@ -1029,7 +1031,7 @@ function checkInlineElement(context, node) {
 	}
 }
 //#endregion
-//#region src/utils/text/tokenizer.ts
+//#region parser/text/parser.ts
 const TEXT_TYPE = {
 	"cjk": "cjk",
 	"latin": "latin",
@@ -1206,7 +1208,7 @@ function buildTextNodeAst(node) {
 	};
 }
 //#endregion
-//#region src/rules/shared/text-boundary-spacing.ts
+//#region rules/shared/text-boundary-spacing.ts
 /**
 * Normalizes an existing space token around the target token type.
 * When multiple spaces are collapsed, the redundant side is recorded so the
@@ -1351,7 +1353,7 @@ var space_around_word_default = createRule({
 	}
 });
 //#endregion
-//#region src/rules/valid-custom-container-type/index.ts
+//#region rules/valid-custom-container-type/index.ts
 const RULE_NAME$1 = "valid-custom-container-type";
 const MESSAGE_IDS$1 = {
 	invalidType: "invalidType",
@@ -1361,7 +1363,10 @@ var valid_custom_container_type_default = createRule({
 	name: RULE_NAME$1,
 	meta: {
 		type: "problem",
-		docs: { description: "Require custom containers to use a supported type." },
+		docs: {
+			description: "Require custom containers to use a supported type.",
+			recommended: true
+		},
 		messages: {
 			invalidType: "Invalid custom container type \"{{type}}\". Use info, tip, warning, danger, details, raw, code-group, v-pre, or tabs.",
 			invalidTypeCase: "Custom container type \"{{type}}\" must be lowercase."
@@ -1415,7 +1420,7 @@ function getTypeIssue(type) {
 	return { messageId: MESSAGE_IDS$1.invalidType };
 }
 //#endregion
-//#region src/rules/valid-heading-anchor/anchor.ts
+//#region rules/valid-heading-anchor/anchor.ts
 /**
 * Check if the string has an anchor.
 * @example: {#chinese-anchor}
@@ -1453,7 +1458,7 @@ function calcAnchorPositionCompensate(content) {
 	return match.length - anchor.rawLikeAnchor.length;
 }
 //#endregion
-//#region src/parser/markdown.ts
+//#region parser/markdown.ts
 const language = new MarkdownLanguage({ mode: "gfm" });
 /**
 * Parses Markdown with the same GFM language implementation used by the
@@ -1478,7 +1483,7 @@ function parseMarkdown(markdown) {
 	};
 }
 //#endregion
-//#region src/rules/valid-heading-anchor/frontmatter.ts
+//#region rules/valid-heading-anchor/frontmatter.ts
 /**
 * Returns true when the Markdown document starts with YAML frontmatter.
 */
@@ -1488,14 +1493,14 @@ function hasFrontmatter(markdown, prevNode) {
 	return ast.children[0]?.type === "yaml";
 }
 //#endregion
-//#region src/rules/valid-heading-anchor/index.ts
+//#region rules/valid-heading-anchor/index.ts
 const RULE_NAME = "valid-heading-anchor";
 const MESSAGE_IDS = {
 	missingAnchor: "missingAnchor",
 	invalidHeadingAnchor: "invalidHeadingAnchor"
 };
 //#endregion
-//#region src/rules/index.ts
+//#region rules/index.ts
 const rules = {
 	"padding-around-custom-container": padding_around_custom_container_default,
 	"space-around-inline-element": space_around_inline_element_default,
@@ -1507,7 +1512,10 @@ const rules = {
 		name: RULE_NAME,
 		meta: {
 			type: "layout",
-			docs: { description: "Require strict lowercase anchors for headings that contain CJK text." },
+			docs: {
+				description: "Require strict lowercase anchors for headings that contain CJK text.",
+				recommended: true
+			},
 			messages: {
 				missingAnchor: "Non-ASCII heading must have an anchor in the format \"{#lowercase-anchor}\".",
 				invalidHeadingAnchor: "Anchor must use lowercase letters and valid characters only."
@@ -1534,14 +1542,13 @@ const rules = {
 				}
 				const { rawLikeAnchor, isLikeAnchor } = liked;
 				const compensate = calcAnchorPositionCompensate(source);
-				const remainingContent = source.slice(0, -rawLikeAnchor.length - compensate).trim();
-				const anchor = normalizeAnchor(rawLikeAnchor);
-				if (rawLikeAnchor === anchor) return;
+				const fixed = `${source.slice(0, -rawLikeAnchor.length - compensate).trim()} {#${normalizeAnchor(rawLikeAnchor)}}`;
+				if (source === fixed) return;
 				context.report({
 					node,
 					messageId: isLikeAnchor ? MESSAGE_IDS.missingAnchor : MESSAGE_IDS.invalidHeadingAnchor,
 					fix(fixer) {
-						return fixer.replaceTextRange([start, end], `${remainingContent} {#${anchor}}`);
+						return fixer.replaceTextRange([start, end], fixed);
 					}
 				});
 			} };
@@ -1549,18 +1556,13 @@ const rules = {
 	})
 };
 //#endregion
-//#region src/index.ts
+//#region index.ts
 const plugin = {
 	rules,
 	processors: markdown.processors,
 	languages: { gfm: new MarkdownLanguage({ mode: "gfm" }) }
 };
-const recommendedRules = {
-	"md-style/valid-heading-anchor": "error",
-	"md-style/space-around-inline-element": "error",
-	"md-style/padding-around-custom-container": "error",
-	"md-style/valid-custom-container-type": "error"
-};
+const recommendedRules = Object.fromEntries(Object.entries(rules).filter(([, rule]) => rule.meta?.docs?.recommended).map(([ruleName]) => [`md-style/${ruleName}`, "error"]));
 const allRules = Object.fromEntries(Object.keys(rules).map((ruleName) => [`md-style/${ruleName}`, "error"]));
 const configs = {
 	recommended: {

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "eslint-plugin-md-style",
   "type": "module",
-  "version": "0.3.0",
+  "version": "0.3.1",
   "packageManager": "pnpm@10.21.0",
   "description": "ESLint plugin for enforcing style rules in Markdown-based documentation",
   "author": "noisefan <noisefan@163.com>",
@@ -9,7 +9,8 @@
   "homepage": "https://github.com/NoiseFan/eslint-plugin-md-style#readme",
   "repository": {
     "type": "git",
-    "url": "git+github.com:NoiseFan/eslint-plugin-md-style.git"
+    "url": "git+https://github.com/NoiseFan/eslint-plugin-md-style",
+    "directory": "packages/eslint-plugin-md-style"
   },
   "bugs": {
     "url": "https://github.com/NoiseFan/eslint-plugin-md-style/issues"
@@ -29,16 +30,15 @@
     "node": ">=20.19.0"
   },
   "scripts": {
-    "lint": "eslint .",
-    "lint:fix": "pnpm run lint --fix",
-    "build": "tsdown",
+    "build": "pnpm gen:types && tsdown",
+    "gen:types": "tsx scripts/typegen.ts",
+    "gen:rules": "tsx scripts/readme.ts",
+    "publish:ci": "tsx scripts/publish.ts",
     "dev": "tsdown --watch",
     "test": "vitest",
     "test:cov": "vitest --coverage",
     "typecheck": "tsc --noEmit",
-    "release": "bumpp",
-    "prepublishOnly": "pnpm run build",
-    "prepare": "simple-git-hooks"
+    "prepublishOnly": "pnpm gen:rules && pnpm build"
   },
   "peerDependencies": {
     "@antfu/eslint-config": "^7.5.0",
@@ -51,33 +51,17 @@
     }
   },
   "devDependencies": {
-    "@antfu/eslint-config": "^9.3.0",
-    "@eslint/markdown": "^8.0.3",
-    "@types/mdast": "^4.0.4",
-    "@types/node": "^26.2.0",
-    "@types/unist": "^3.0.3",
-    "@typescript-eslint/utils": "^8.67.0",
-    "@vitest/coverage-v8": "^4.1.11",
-    "bumpp": "^12.2.1",
-    "eslint": "10.8.1",
-    "eslint-factory": "^0.1.2",
-    "eslint-plugin-format": "^2.0.1",
-    "eslint-plugin-md-style": "^0.2.0",
-    "eslint-vitest-rule-tester": "^3.1.0",
-    "lint-staged": "^17.3.0",
-    "simple-git-hooks": "^2.13.1",
-    "tinyglobby": "^0.2.17",
-    "tsdown": "^0.22.14",
-    "typescript": "^6.0.3",
-    "vitest": "^4.1.11",
-    "yaml": "^2.9.0"
-  },
-  "simple-git-hooks": {
-    "pre-commit": "pnpx lint-staged"
-  },
-  "lint-staged": {
-    "*.{js,ts,md,yml,yaml,json}": [
-      "eslint --cache --fix"
-    ]
+    "@eslint/markdown": "catalog:lint",
+    "@types/mdast": "catalog:types",
+    "@types/node": "catalog:types",
+    "@types/unist": "catalog:types",
+    "@typescript-eslint/utils": "catalog:dev",
+    "@vitest/coverage-v8": "catalog:test",
+    "eslint-plugin-format": "catalog:lint",
+    "eslint-plugin-md-style": "catalog:lint",
+    "eslint-typegen": "catalog:lint",
+    "eslint-vitest-rule-tester": "catalog:lint",
+    "tinyglobby": "catalog:dev",
+    "yaml": "catalog:dev"
   }
 }

package/LICENSE

@@ -1,21 +0,0 @@
-The MIT License (MIT)
-
-Copyright © 2025-PRESENT Kevin Deng (https://github.com/sxzz)
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.