eslint-plugin-markdown-preferences 0.18.0 → 0.19.0

package/README.md

@@ -119,6 +119,7 @@ The rules with the following star ⭐ are included in the configs.
 | [markdown-preferences/blockquote-marker-alignment](https://ota-meshi.github.io/eslint-plugin-markdown-preferences/rules/blockquote-marker-alignment.html) | enforce consistent alignment of blockquote markers | 🔧 | ⭐ |
 | [markdown-preferences/bullet-list-marker-style](https://ota-meshi.github.io/eslint-plugin-markdown-preferences/rules/bullet-list-marker-style.html) | enforce consistent bullet list (unordered list) marker style | 🔧 |  |
 | [markdown-preferences/definitions-last](https://ota-meshi.github.io/eslint-plugin-markdown-preferences/rules/definitions-last.html) | require link definitions and footnote definitions to be placed at the end of the document | 🔧 |  |
+| [markdown-preferences/emphasis-delimiters-style](https://ota-meshi.github.io/eslint-plugin-markdown-preferences/rules/emphasis-delimiters-style.html) | enforce a consistent delimiter style for emphasis and strong emphasis | 🔧 |  |
 | [markdown-preferences/hard-linebreak-style](https://ota-meshi.github.io/eslint-plugin-markdown-preferences/rules/hard-linebreak-style.html) | enforce consistent hard linebreak style. | 🔧 | ⭐ |
 | [markdown-preferences/level1-heading-style](https://ota-meshi.github.io/eslint-plugin-markdown-preferences/rules/level1-heading-style.html) | enforce consistent style for level 1 headings | 🔧 |  |
 | [markdown-preferences/level2-heading-style](https://ota-meshi.github.io/eslint-plugin-markdown-preferences/rules/level2-heading-style.html) | enforce consistent style for level 2 headings | 🔧 |  |
@@ -135,6 +136,7 @@ The rules with the following star ⭐ are included in the configs.
 | [markdown-preferences/prefer-link-reference-definitions](https://ota-meshi.github.io/eslint-plugin-markdown-preferences/rules/prefer-link-reference-definitions.html) | enforce using link reference definitions instead of inline links | 🔧 |  |
 | [markdown-preferences/setext-heading-underline-length](https://ota-meshi.github.io/eslint-plugin-markdown-preferences/rules/setext-heading-underline-length.html) | enforce setext heading underline length | 🔧 |  |
 | [markdown-preferences/sort-definitions](https://ota-meshi.github.io/eslint-plugin-markdown-preferences/rules/sort-definitions.html) | enforce a specific order for link definitions and footnote definitions | 🔧 |  |
+| [markdown-preferences/strikethrough-delimiters-style](https://ota-meshi.github.io/eslint-plugin-markdown-preferences/rules/strikethrough-delimiters-style.html) | enforce a consistent delimiter style for strikethrough | 🔧 |  |
 | [markdown-preferences/thematic-break-character-style](https://ota-meshi.github.io/eslint-plugin-markdown-preferences/rules/thematic-break-character-style.html) | enforce consistent character style for thematic breaks (horizontal rules) in Markdown. | 🔧 |  |
 | [markdown-preferences/thematic-break-length](https://ota-meshi.github.io/eslint-plugin-markdown-preferences/rules/thematic-break-length.html) | enforce consistent length for thematic breaks (horizontal rules) in Markdown. | 🔧 |  |
 | [markdown-preferences/thematic-break-sequence-pattern](https://ota-meshi.github.io/eslint-plugin-markdown-preferences/rules/thematic-break-sequence-pattern.html) | enforce consistent repeating patterns for thematic breaks (horizontal rules) in Markdown. | 🔧 |  |

package/lib/index.d.ts

@@ -45,6 +45,11 @@ interface RuleOptions {
    * @see https://ota-meshi.github.io/eslint-plugin-markdown-preferences/rules/emoji-notation.html
    */
   'markdown-preferences/emoji-notation'?: Linter.RuleEntry<MarkdownPreferencesEmojiNotation>;
+  /**
+   * enforce a consistent delimiter style for emphasis and strong emphasis
+   * @see https://ota-meshi.github.io/eslint-plugin-markdown-preferences/rules/emphasis-delimiters-style.html
+   */
+  'markdown-preferences/emphasis-delimiters-style'?: Linter.RuleEntry<MarkdownPreferencesEmphasisDelimitersStyle>;
   /**
    * enforce consistent hard linebreak style.
    * @see https://ota-meshi.github.io/eslint-plugin-markdown-preferences/rules/hard-linebreak-style.html
@@ -145,6 +150,11 @@ interface RuleOptions {
    * @see https://ota-meshi.github.io/eslint-plugin-markdown-preferences/rules/sort-definitions.html
    */
   'markdown-preferences/sort-definitions'?: Linter.RuleEntry<MarkdownPreferencesSortDefinitions>;
+  /**
+   * enforce a consistent delimiter style for strikethrough
+   * @see https://ota-meshi.github.io/eslint-plugin-markdown-preferences/rules/strikethrough-delimiters-style.html
+   */
+  'markdown-preferences/strikethrough-delimiters-style'?: Linter.RuleEntry<MarkdownPreferencesStrikethroughDelimitersStyle>;
   /**
    * enforce consistent casing in table header cells.
    * @see https://ota-meshi.github.io/eslint-plugin-markdown-preferences/rules/table-header-casing.html
@@ -193,6 +203,23 @@ type MarkdownPreferencesEmojiNotation = [] | [{
   ignoreUnknown?: boolean;
   ignoreList?: string[];
 }];
+type MarkdownPreferencesEmphasisDelimitersStyle = [] | [{
+  emphasis?: ("*" | "_");
+  strong?: ("**" | "__");
+  strongEmphasis?: (("***" | "___") | {
+    outer: "*";
+    inner: "__";
+  } | {
+    outer: "**";
+    inner: "_";
+  } | {
+    outer: "_";
+    inner: "**";
+  } | {
+    outer: "__";
+    inner: "*";
+  });
+}];
 type MarkdownPreferencesHardLinebreakStyle = [] | [{
   style?: ("backslash" | "spaces");
 }];
@@ -283,6 +310,9 @@ type MarkdownPreferencesSortDefinitions = [] | [{
   })[];
   alphabetical?: boolean;
 }];
+type MarkdownPreferencesStrikethroughDelimitersStyle = [] | [{
+  delimiter?: ("~" | "~~");
+}];
 type MarkdownPreferencesTableHeaderCasing = [] | [{
   style?: ("Title Case" | "Sentence case");
   preserveWords?: string[];
@@ -316,7 +346,7 @@ declare namespace meta_d_exports {
   export { name, version };
 }
 declare const name: "eslint-plugin-markdown-preferences";
-declare const version: "0.18.0";
+declare const version: "0.19.0";
 //#endregion
 //#region src/index.d.ts
 declare const configs: {

package/lib/index.js

@@ -130,6 +130,27 @@ function getSourceLocationFromRange(sourceCode, node, range) {
 	};
 }
 
+//#endregion
+//#region src/utils/unicode.ts
+/**
+* Check if the string is whitespace
+*/
+function isWhitespace(string) {
+	return /^[\p{Zs}\t\n\f\r]+$/u.test(string);
+}
+/**
+* Check if the string is a space or tab
+*/
+function isSpaceOrTab(string) {
+	return /^[\t ]+$/u.test(string);
+}
+/**
+* Check if the character is a punctuation character
+*/
+function isPunctuation(char) {
+	return /^[\p{P}\p{S}]+$/u.test(char);
+}
+
 //#endregion
 //#region src/utils/atx-heading.ts
 /**
@@ -262,7 +283,7 @@ function parseATXHeadingOpeningSequenceFromText(text) {
 	function skipWhitespace(index) {
 		let result = index;
 		let c;
-		while (result < text.length && (c = text[result]) && (c === " " || c === "	")) result++;
+		while (result < text.length && (c = text[result]) && isSpaceOrTab(c)) result++;
 		return result;
 	}
 }
@@ -287,7 +308,7 @@ function parseATXHeadingClosingSequenceFromText(text) {
 	function skipEndWhitespace(index) {
 		let result = index;
 		let c;
-		while (result >= 0 && (c = text[result]) && (c === " " || c === "	")) result--;
+		while (result >= 0 && (c = text[result]) && isSpaceOrTab(c)) result--;
 		return result;
 	}
 }
@@ -3043,6 +3064,199 @@ var emoji_notation_default = createRule("emoji-notation", {
 	}
 });
 
+//#endregion
+//#region src/rules/emphasis-delimiters-style.ts
+/**
+* Check if the emphasis/strong node is intraword (inside a word)
+* CommonMark: Intraword emphasis with _ is not allowed
+*/
+function isIntrawordForUnderline(text, range) {
+	const before = text[range[0] - 1];
+	if (!isWhitespace(before) && !isPunctuation(before)) return true;
+	const after = text[range[1]];
+	if (!isWhitespace(after) && !isPunctuation(after)) return true;
+	return false;
+}
+var emphasis_delimiters_style_default = createRule("emphasis-delimiters-style", {
+	meta: {
+		type: "layout",
+		docs: {
+			description: "enforce a consistent delimiter style for emphasis and strong emphasis",
+			categories: [],
+			listCategory: "Stylistic"
+		},
+		fixable: "code",
+		hasSuggestions: false,
+		schema: [{
+			type: "object",
+			properties: {
+				emphasis: { enum: ["*", "_"] },
+				strong: { enum: ["**", "__"] },
+				strongEmphasis: { anyOf: [
+					{ enum: ["***", "___"] },
+					{
+						type: "object",
+						properties: {
+							outer: { const: "*" },
+							inner: { const: "__" }
+						},
+						required: ["outer", "inner"],
+						additionalProperties: false
+					},
+					{
+						type: "object",
+						properties: {
+							outer: { const: "**" },
+							inner: { const: "_" }
+						},
+						required: ["outer", "inner"],
+						additionalProperties: false
+					},
+					{
+						type: "object",
+						properties: {
+							outer: { const: "_" },
+							inner: { const: "**" }
+						},
+						required: ["outer", "inner"],
+						additionalProperties: false
+					},
+					{
+						type: "object",
+						properties: {
+							outer: { const: "__" },
+							inner: { const: "*" }
+						},
+						required: ["outer", "inner"],
+						additionalProperties: false
+					}
+				] }
+			},
+			additionalProperties: false
+		}],
+		messages: {
+			wrongEmphasis: "Emphasis delimiter should be '{{expectedOpening}}' (was '{{actualOpening}}').",
+			wrongStrong: "Strong emphasis delimiter should be '{{expectedOpening}}' (was '{{actualOpening}}').",
+			wrongStrongEmphasis: "Delimiter for strong+emphasis should be '{{expectedOpening}}' (was '{{actualOpening}}').",
+			wrongStrongEmphasisDelimiterPair: "Delimiters for strong+emphasis should be '{{expectedOpening}}' ... '{{expectedClosing}}' (was '{{actualOpening}}' ... '{{actualClosing}}')."
+		}
+	},
+	create(context) {
+		const sourceCode = context.sourceCode;
+		const option = context.options[0] ?? {};
+		const emphasisDelimiter = option.emphasis ?? "_";
+		const emphasis = {
+			opening: emphasisDelimiter,
+			closing: emphasisDelimiter
+		};
+		const strongDelimiter = option.strong ?? "**";
+		const strong = {
+			opening: strongDelimiter,
+			closing: strongDelimiter
+		};
+		const strongEmphasis = parseStrongEmphasis(emphasisDelimiter, strongDelimiter, option.strongEmphasis);
+		const processed = /* @__PURE__ */ new Set();
+		/**
+		* Verify the delimiter of the node
+		*/
+		function verifyDelimiter(node, expected, messageId) {
+			const range = sourceCode.getRange(node);
+			if (sourceCode.text.startsWith(expected.opening, range[0]) && sourceCode.text.endsWith(expected.closing, range[1])) return;
+			if (sourceCode.text[range[0] - 1] === expected.opening[0] || sourceCode.text[range[1]] === expected.closing.at(-1) || sourceCode.text[range[0] + expected.opening.length] === expected.opening.at(-1) || sourceCode.text[range[1] - expected.closing.length - 1] === expected.closing[0]) return;
+			if ((expected.opening.startsWith("_") || expected.closing.at(-1) === "_") && isIntrawordForUnderline(sourceCode.text, range)) return;
+			const actual = {
+				opening: sourceCode.text.slice(range[0], range[0] + expected.opening.length),
+				closing: sourceCode.text.slice(range[1] - expected.closing.length, range[1])
+			};
+			context.report({
+				node,
+				messageId: expected.opening === expected.closing && actual.opening === actual.closing ? messageId : "wrongStrongEmphasisDelimiterPair",
+				data: {
+					expectedOpening: expected.opening,
+					actualOpening: actual.opening,
+					expectedClosing: expected.closing,
+					actualClosing: actual.closing
+				},
+				fix(fixer) {
+					return [fixer.replaceTextRange([range[0], range[0] + expected.opening.length], expected.opening), fixer.replaceTextRange([range[1] - expected.closing.length, range[1]], expected.closing)];
+				}
+			});
+		}
+		/**
+		* Verify the emphasis node has the correct delimiter
+		*/
+		function verifyEmphasis(node) {
+			verifyDelimiter(node, emphasis, "wrongEmphasis");
+		}
+		/**
+		* Verify the emphasis node has the correct delimiter
+		*/
+		function verifyStrong(node) {
+			verifyDelimiter(node, strong, "wrongStrong");
+		}
+		/**
+		* Verify the strong emphasis node has the correct delimiter
+		*/
+		function verifyStrongEmphasis(node) {
+			verifyDelimiter(node, strongEmphasis, "wrongStrongEmphasis");
+		}
+		return {
+			emphasis(node) {
+				if (processed.has(node)) return;
+				processed.add(node);
+				if (node.children.length === 1 && node.children[0].type === "strong") {
+					processed.add(node.children[0]);
+					verifyStrongEmphasis(node);
+					return;
+				}
+				verifyEmphasis(node);
+			},
+			strong(node) {
+				if (processed.has(node)) return;
+				processed.add(node);
+				if (node.children.length === 1 && node.children[0].type === "emphasis") {
+					processed.add(node.children[0]);
+					verifyStrongEmphasis(node);
+					return;
+				}
+				verifyStrong(node);
+			}
+		};
+	}
+});
+/**
+* Parse strongEmphasis option to normalized object form
+*/
+function parseStrongEmphasis(emphasis, strong, strongEmphasisOpt) {
+	if (strongEmphasisOpt != null) {
+		if (typeof strongEmphasisOpt === "string") return {
+			opening: strongEmphasisOpt,
+			closing: strongEmphasisOpt
+		};
+		return {
+			opening: strongEmphasisOpt.outer + strongEmphasisOpt.inner,
+			closing: strongEmphasisOpt.inner + strongEmphasisOpt.outer
+		};
+	}
+	if (emphasis === "*") {
+		if (strong === "**") return {
+			opening: "***",
+			closing: "***"
+		};
+		return {
+			opening: "*__",
+			closing: "__*"
+		};
+	} else if (strong === "**") return {
+		opening: "**_",
+		closing: "_**"
+	};
+	return {
+		opening: "___",
+		closing: "___"
+	};
+}
+
 //#endregion
 //#region src/rules/hard-linebreak-style.ts
 var hard_linebreak_style_default = createRule("hard-linebreak-style", {
@@ -6183,7 +6397,7 @@ var sort_definitions_default = createRule("sort-definitions", {
 				const last = group.at(-1);
 				if (last && (node.type !== "definition" && node.type !== "footnoteDefinition" || sourceCode.getParent(node) !== sourceCode.getParent(last))) {
 					const range = sourceCode.getRange(node);
-					const lastDefinitionRange = sourceCode.getRange(node);
+					const lastDefinitionRange = sourceCode.getRange(last);
 					if (lastDefinitionRange[1] <= range[0]) {
 						verify(group);
 						group.length = 0;
@@ -6341,6 +6555,48 @@ function normalizedURL(url) {
 	return urlObj.href.endsWith("/") ? urlObj.href : `${urlObj.href}/`;
 }
 
+//#endregion
+//#region src/rules/strikethrough-delimiters-style.ts
+var strikethrough_delimiters_style_default = createRule("strikethrough-delimiters-style", {
+	meta: {
+		type: "layout",
+		docs: {
+			description: "enforce a consistent delimiter style for strikethrough",
+			categories: [],
+			listCategory: "Stylistic"
+		},
+		fixable: "code",
+		hasSuggestions: false,
+		schema: [{
+			type: "object",
+			properties: { delimiter: { enum: ["~", "~~"] } },
+			additionalProperties: false
+		}],
+		messages: { wrongDelimiter: "Strikethrough delimiter should be '{{expected}}' (was '{{actual}}')." }
+	},
+	create(context) {
+		const sourceCode = context.sourceCode;
+		const option = context.options[0] ?? {};
+		const delimiter = option.delimiter ?? "~~";
+		return { delete(node) {
+			const range = sourceCode.getRange(node);
+			const actualDelimiter = ["~~", "~"].find((d) => sourceCode.text.startsWith(d, range[0]) && sourceCode.text.endsWith(d, range[1]));
+			if (!actualDelimiter || actualDelimiter === delimiter) return;
+			context.report({
+				node,
+				messageId: "wrongDelimiter",
+				data: {
+					expected: delimiter,
+					actual: actualDelimiter
+				},
+				fix(fixer) {
+					return [fixer.replaceTextRange([range[0], range[0] + actualDelimiter.length], delimiter), fixer.replaceTextRange([range[1] - actualDelimiter.length, range[1]], delimiter)];
+				}
+			});
+		} };
+	}
+});
+
 //#endregion
 //#region src/rules/table-header-casing.ts
 var table_header_casing_default = createRule("table-header-casing", {
@@ -6696,6 +6952,7 @@ const rules$1 = [
 	canonical_code_block_language_default,
 	definitions_last_default,
 	emoji_notation_default,
+	emphasis_delimiters_style_default,
 	hard_linebreak_style_default,
 	heading_casing_default,
 	level1_heading_style_default,
@@ -6716,6 +6973,7 @@ const rules$1 = [
 	prefer_linked_words_default,
 	setext_heading_underline_length_default,
 	sort_definitions_default,
+	strikethrough_delimiters_style_default,
 	table_header_casing_default,
 	thematic_break_character_style_default,
 	thematic_break_length_default,
@@ -6762,7 +7020,7 @@ __export(meta_exports, {
 	version: () => version
 });
 const name = "eslint-plugin-markdown-preferences";
-const version = "0.18.0";
+const version = "0.19.0";
 
 //#endregion
 //#region src/index.ts

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eslint-plugin-markdown-preferences",
-  "version": "0.18.0",
+  "version": "0.19.0",
   "description": "ESLint plugin that enforces our markdown preferences",
   "type": "module",
   "exports": {