eslint-plugin-markdown-preferences 0.37.0 → 0.38.0

package/README.md

@@ -144,15 +144,16 @@ The rules with the following 💄 are included in the `standard` config.
 
 <!-- prettier-ignore-start -->
 
-| Rule ID                                                                                                                                                       | Description                                                | Fixable | Config |
-| :------------------------------------------------------------------------------------------------------------------------------------------------------------ | :--------------------------------------------------------- | :-----: | :----: |
-| [markdown-preferences/canonical-code-block-language](https://ota-meshi.github.io/eslint-plugin-markdown-preferences/rules/canonical-code-block-language.html) | enforce canonical language names in code blocks            |   🔧    |        |
-| [markdown-preferences/emoji-notation](https://ota-meshi.github.io/eslint-plugin-markdown-preferences/rules/emoji-notation.html)                               | enforce consistent emoji notation style in Markdown files. |   🔧    |        |
-| [markdown-preferences/heading-casing](https://ota-meshi.github.io/eslint-plugin-markdown-preferences/rules/heading-casing.html)                               | enforce consistent casing in headings.                     |   🔧    |        |
-| [markdown-preferences/ordered-list-marker-start](https://ota-meshi.github.io/eslint-plugin-markdown-preferences/rules/ordered-list-marker-start.html)         | enforce that ordered list markers start with 1 or 0        |   🔧    |   💄   |
-| [markdown-preferences/prefer-inline-code-words](https://ota-meshi.github.io/eslint-plugin-markdown-preferences/rules/prefer-inline-code-words.html)           | enforce the use of inline code for specific words.         |   🔧    |        |
-| [markdown-preferences/prefer-linked-words](https://ota-meshi.github.io/eslint-plugin-markdown-preferences/rules/prefer-linked-words.html)                     | enforce the specified word to be a link.                   |   🔧    |        |
-| [markdown-preferences/table-header-casing](https://ota-meshi.github.io/eslint-plugin-markdown-preferences/rules/table-header-casing.html)                     | enforce consistent casing in table header cells.           |   🔧    |        |
+| Rule ID                                                                                                                                                           | Description                                                | Fixable | Config |
+| :---------------------------------------------------------------------------------------------------------------------------------------------------------------- | :--------------------------------------------------------- | :-----: | :----: |
+| [markdown-preferences/canonical-code-block-language](https://ota-meshi.github.io/eslint-plugin-markdown-preferences/rules/canonical-code-block-language.html)     | enforce canonical language names in code blocks            |   🔧    |        |
+| [markdown-preferences/emoji-notation](https://ota-meshi.github.io/eslint-plugin-markdown-preferences/rules/emoji-notation.html)                                   | enforce consistent emoji notation style in Markdown files. |   🔧    |        |
+| [markdown-preferences/heading-casing](https://ota-meshi.github.io/eslint-plugin-markdown-preferences/rules/heading-casing.html)                                   | enforce consistent casing in headings.                     |   🔧    |        |
+| [markdown-preferences/no-heading-trailing-punctuation](https://ota-meshi.github.io/eslint-plugin-markdown-preferences/rules/no-heading-trailing-punctuation.html) | disallow trailing punctuation in headings.                 |         |        |
+| [markdown-preferences/ordered-list-marker-start](https://ota-meshi.github.io/eslint-plugin-markdown-preferences/rules/ordered-list-marker-start.html)             | enforce that ordered list markers start with 1 or 0        |   🔧    |   💄   |
+| [markdown-preferences/prefer-inline-code-words](https://ota-meshi.github.io/eslint-plugin-markdown-preferences/rules/prefer-inline-code-words.html)               | enforce the use of inline code for specific words.         |   🔧    |        |
+| [markdown-preferences/prefer-linked-words](https://ota-meshi.github.io/eslint-plugin-markdown-preferences/rules/prefer-linked-words.html)                         | enforce the specified word to be a link.                   |   🔧    |        |
+| [markdown-preferences/table-header-casing](https://ota-meshi.github.io/eslint-plugin-markdown-preferences/rules/table-header-casing.html)                         | enforce consistent casing in table header cells.           |   🔧    |        |
 
 <!-- prettier-ignore-end -->
 
@@ -203,7 +204,7 @@ The rules with the following 💄 are included in the `standard` config.
 | [markdown-preferences/list-marker-alignment](https://ota-meshi.github.io/eslint-plugin-markdown-preferences/rules/list-marker-alignment.html)                     | enforce consistent alignment of list markers                                   |   🔧    |  ⭐💄  |
 | [markdown-preferences/no-multi-spaces](https://ota-meshi.github.io/eslint-plugin-markdown-preferences/rules/no-multi-spaces.html)                                 | disallow multiple spaces                                                       |   🔧    |   💄   |
 | [markdown-preferences/no-multiple-empty-lines](https://ota-meshi.github.io/eslint-plugin-markdown-preferences/rules/no-multiple-empty-lines.html)                 | disallow multiple empty lines in Markdown files.                               |   🔧    |   💄   |
-| [markdown-preferences/no-tabs](https://ota-meshi.github.io/eslint-plugin-markdown-preferences/rules/no-tabs.html)                                                 | Disallow tab characters in Markdown files.                                     |   🔧    |   💄   |
+| [markdown-preferences/no-tabs](https://ota-meshi.github.io/eslint-plugin-markdown-preferences/rules/no-tabs.html)                                                 | disallow tab characters in Markdown files.                                     |   🔧    |   💄   |
 | [markdown-preferences/no-trailing-spaces](https://ota-meshi.github.io/eslint-plugin-markdown-preferences/rules/no-trailing-spaces.html)                           | disallow trailing whitespace at the end of lines in Markdown files.            |   🔧    |   💄   |
 | [markdown-preferences/padded-custom-containers](https://ota-meshi.github.io/eslint-plugin-markdown-preferences/rules/padded-custom-containers.html)               | disallow or require padding inside custom containers                           |   🔧    |   💄   |
 | [markdown-preferences/padding-line-between-blocks](https://ota-meshi.github.io/eslint-plugin-markdown-preferences/rules/padding-line-between-blocks.html)         | require or disallow padding lines between blocks                               |   🔧    |   💄   |

package/lib/index.d.ts

@@ -140,6 +140,11 @@ interface RuleOptions {
    * @see https://ota-meshi.github.io/eslint-plugin-markdown-preferences/rules/list-marker-alignment.html
    */
   'markdown-preferences/list-marker-alignment'?: Linter.RuleEntry<MarkdownPreferencesListMarkerAlignment>;
+  /**
+   * disallow trailing punctuation in headings.
+   * @see https://ota-meshi.github.io/eslint-plugin-markdown-preferences/rules/no-heading-trailing-punctuation.html
+   */
+  'markdown-preferences/no-heading-trailing-punctuation'?: Linter.RuleEntry<MarkdownPreferencesNoHeadingTrailingPunctuation>;
   /**
    * disallow implicit block closing for fenced code blocks, math blocks, and custom containers
    * @see https://ota-meshi.github.io/eslint-plugin-markdown-preferences/rules/no-implicit-block-closing.html
@@ -161,7 +166,7 @@ interface RuleOptions {
    */
   'markdown-preferences/no-multiple-empty-lines'?: Linter.RuleEntry<MarkdownPreferencesNoMultipleEmptyLines>;
   /**
-   * Disallow tab characters in Markdown files.
+   * disallow tab characters in Markdown files.
    * @see https://ota-meshi.github.io/eslint-plugin-markdown-preferences/rules/no-tabs.html
    */
   'markdown-preferences/no-tabs'?: Linter.RuleEntry<MarkdownPreferencesNoTabs>;
@@ -398,6 +403,32 @@ type MarkdownPreferencesLinkTitleStyle = [] | [{
 type MarkdownPreferencesListMarkerAlignment = [] | [{
   align?: ("left" | "right");
 }];
+type MarkdownPreferencesNoHeadingTrailingPunctuation = [] | [{
+  punctuation?: (string | {
+    "1"?: string;
+    "2"?: string;
+    "3"?: string;
+    "4"?: string;
+    "5"?: string;
+    "6"?: string;
+    default?: string;
+    "1-2"?: string;
+    "1-3"?: string;
+    "1-4"?: string;
+    "1-5"?: string;
+    "1-6"?: string;
+    "2-3"?: string;
+    "2-4"?: string;
+    "2-5"?: string;
+    "2-6"?: string;
+    "3-4"?: string;
+    "3-5"?: string;
+    "3-6"?: string;
+    "4-5"?: string;
+    "4-6"?: string;
+    "5-6"?: string;
+  });
+}];
 type MarkdownPreferencesNoMultipleEmptyLines = [] | [{
   max?: number;
   maxEOF?: number;
@@ -553,7 +584,7 @@ declare namespace meta_d_exports {
   export { name, version };
 }
 declare const name: "eslint-plugin-markdown-preferences";
-declare const version: "0.37.0";
+declare const version: "0.38.0";
 //#endregion
 //#region src/language/ast-types.d.ts
 type Node = mdast.Node;

package/lib/index.js

@@ -7690,6 +7690,153 @@ var list_marker_alignment_default = createRule("list-marker-alignment", {
 	}
 });
 
+//#endregion
+//#region src/rules/no-heading-trailing-punctuation.ts
+const DEFAULT_PUNCTUATION = ".,;:!。、，；：！｡､";
+const LEVEL_RANGE_MAP = {
+	"1": [1, 1],
+	"2": [2, 2],
+	"3": [3, 3],
+	"4": [4, 4],
+	"5": [5, 5],
+	"6": [6, 6],
+	"1-2": [1, 2],
+	"1-3": [1, 3],
+	"1-4": [1, 4],
+	"1-5": [1, 5],
+	"1-6": [1, 6],
+	"2-3": [2, 3],
+	"2-4": [2, 4],
+	"2-5": [2, 5],
+	"2-6": [2, 6],
+	"3-4": [3, 4],
+	"3-5": [3, 5],
+	"3-6": [3, 6],
+	"4-5": [4, 5],
+	"4-6": [4, 6],
+	"5-6": [5, 6]
+};
+const HEADING_LEVELS = [
+	1,
+	2,
+	3,
+	4,
+	5,
+	6
+];
+/**
+* Parse heading level ranges and build a map of level -> punctuation string
+*/
+function buildPunctuationMap(option, segmenter$1) {
+	if (typeof option === "string" || option === void 0) {
+		const punctuation = option ?? DEFAULT_PUNCTUATION;
+		const chars = new Set([...segmenter$1.segment(punctuation)].map((s) => s.segment));
+		return Object.fromEntries(HEADING_LEVELS.map((level) => [level, chars]));
+	}
+	const defaultPunctuation = option.default ?? DEFAULT_PUNCTUATION;
+	const defaultChars = new Set([...segmenter$1.segment(defaultPunctuation)].map((s) => s.segment));
+	const map = Object.fromEntries(HEADING_LEVELS.map((level) => [level, defaultChars]));
+	for (const [key, value] of Object.entries(option)) {
+		if (key === "default" || value == null) continue;
+		const range = LEVEL_RANGE_MAP[key];
+		if (!range) continue;
+		const chars = new Set([...segmenter$1.segment(value)].map((s) => s.segment));
+		for (let level = range[0]; level <= range[1]; level++) map[level] = chars;
+	}
+	return map;
+}
+var no_heading_trailing_punctuation_default = createRule("no-heading-trailing-punctuation", {
+	meta: {
+		type: "suggestion",
+		docs: {
+			description: "disallow trailing punctuation in headings.",
+			categories: [],
+			listCategory: "Preference"
+		},
+		hasSuggestions: true,
+		schema: [{
+			type: "object",
+			properties: { punctuation: { oneOf: [{
+				type: "string",
+				description: "String of punctuation characters to disallow at the end of headings."
+			}, {
+				type: "object",
+				properties: {
+					default: {
+						type: "string",
+						description: "Default punctuation characters for all heading levels."
+					},
+					...Object.fromEntries(Object.entries(LEVEL_RANGE_MAP).map(([key, [start, end]]) => [key, {
+						type: "string",
+						description: start === end ? `Punctuation characters for heading level ${start}.` : `Punctuation characters for heading levels ${start} to ${end}.`
+					}]))
+				},
+				additionalProperties: false
+			}] } },
+			additionalProperties: false
+		}],
+		messages: {
+			trailingPunctuation: "Headings should not end with punctuation '{{char}}'.",
+			removePunctuation: "Remove trailing punctuation '{{char}}'."
+		}
+	},
+	create(context) {
+		const sourceCode = context.sourceCode;
+		const segmenter$1 = new Intl.Segmenter("en", { granularity: "grapheme" });
+		const punctuationMap = buildPunctuationMap(context.options[0]?.punctuation, segmenter$1);
+		return { heading(node) {
+			if (!node.children.length) return;
+			const punctuationChars = punctuationMap[node.depth];
+			if (punctuationChars.size === 0) return;
+			const lastTextNode = findLastTextNode(node.children);
+			if (!lastTextNode) return;
+			const trimmedText = sourceCode.getText(lastTextNode).trimEnd();
+			if (!trimmedText.length) return;
+			const segments = [...segmenter$1.segment(trimmedText)];
+			const lastSegment = segments[segments.length - 1];
+			if (!lastSegment) return;
+			const lastChar = lastSegment.segment;
+			if (!punctuationChars.has(lastChar)) return;
+			const [nodeStart] = sourceCode.getRange(lastTextNode);
+			const punctuationIndex = nodeStart + lastSegment.index;
+			context.report({
+				node: lastTextNode,
+				messageId: "trailingPunctuation",
+				data: { char: lastChar },
+				loc: {
+					start: sourceCode.getLocFromIndex(punctuationIndex),
+					end: sourceCode.getLocFromIndex(punctuationIndex + lastChar.length)
+				},
+				suggest: [{
+					messageId: "removePunctuation",
+					data: { char: lastChar },
+					fix(fixer) {
+						return fixer.removeRange([punctuationIndex, punctuationIndex + lastChar.length]);
+					}
+				}]
+			});
+		} };
+		/**
+		* Find the last text node within a node's children.
+		* Recursively traverses nested structures (emphasis, strong, link, etc.).
+		*/
+		function findLastTextNode(children) {
+			for (let i = children.length - 1; i >= 0; i--) {
+				const child = children[i];
+				if (child.type === "text") {
+					if (child.value.trim()) return child;
+					continue;
+				}
+				if ("children" in child && Array.isArray(child.children)) {
+					const nestedLast = findLastTextNode(child.children);
+					if (nestedLast) return nestedLast;
+				}
+			}
+			return null;
+		}
+	}
+});
+
 //#endregion
 //#region src/rules/no-implicit-block-closing.ts
 var no_implicit_block_closing_default = createRule("no-implicit-block-closing", {
@@ -8504,7 +8651,7 @@ var no_tabs_default = createRule("no-tabs", {
 	meta: {
 		type: "layout",
 		docs: {
-			description: "Disallow tab characters in Markdown files.",
+			description: "disallow tab characters in Markdown files.",
 			categories: ["standard"],
 			listCategory: "Whitespace"
 		},
@@ -12260,6 +12407,7 @@ const rules$1 = [
 	link_paren_spacing_default,
 	link_title_style_default,
 	list_marker_alignment_default,
+	no_heading_trailing_punctuation_default,
 	no_implicit_block_closing_default,
 	no_laziness_blockquotes_default,
 	no_multi_spaces_default,
@@ -12393,7 +12541,7 @@ var meta_exports = /* @__PURE__ */ __export({
 	version: () => version
 });
 const name = "eslint-plugin-markdown-preferences";
-const version = "0.37.0";
+const version = "0.38.0";
 
 //#endregion
 //#region src/language/extensions/micromark-custom-container.ts

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eslint-plugin-markdown-preferences",
-  "version": "0.37.0",
+  "version": "0.38.0",
   "description": "ESLint plugin that enforces our markdown preferences",
   "type": "module",
   "exports": {
@@ -126,7 +126,7 @@
     "stylelint-config-recommended-vue": "^1.6.0",
     "stylelint-config-standard": "^39.0.0",
     "stylelint-config-standard-vue": "^1.0.0",
-    "tsdown": "^0.16.0",
+    "tsdown": "^0.17.0",
     "tsx": "^4.19.3",
     "twoslash-eslint": "^0.3.1",
     "type-fest": "^5.0.0",