eslint-plugin-markdown-preferences 0.31.0 → 0.33.0

package/lib/index.d.ts

@@ -478,6 +478,12 @@ type MarkdownPreferencesTableLeadingTrailingPipes = [] | [(("always" | "never")
 })];
 type MarkdownPreferencesTablePipeAlignment = [] | [{
   column?: ("minimum" | "consistent");
+  delimiterMinLength?: ("minimum" | number | {
+    defaultDelimiter?: number;
+    leftAlignmentDelimiter?: number;
+    centerAlignmentDelimiter?: number;
+    rightAlignmentDelimiter?: number;
+  });
 }];
 type MarkdownPreferencesTablePipeSpacing = [] | [{
   space?: (("always" | "never") | {
@@ -532,7 +538,7 @@ declare namespace meta_d_exports {
   export { name, version };
 }
 declare const name: "eslint-plugin-markdown-preferences";
-declare const version: "0.31.0";
+declare const version: "0.33.0";
 //#endregion
 //#region src/language/ast-types.d.ts
 type Node = mdast.Node;

package/lib/index.js

@@ -828,7 +828,7 @@ function getOtherMarker(unavailableMarker) {
 /**
 * Parse rule options.
 */
-function parseOptions$5(options) {
+function parseOptions$6(options) {
 	const primary = options.primary || "-";
 	const secondary = options.secondary || getOtherMarker(primary);
 	if (primary === secondary) throw new Error(`\`primary\` and \`secondary\` cannot be the same (primary: "${primary}", secondary: "${secondary}").`);
@@ -896,7 +896,7 @@ var bullet_list_marker_style_default = createRule("bullet-list-marker-style", {
 	},
 	create(context) {
 		const sourceCode = context.sourceCode;
-		const options = parseOptions$5(context.options[0] || {});
+		const options = parseOptions$6(context.options[0] || {});
 		let containerStack = {
 			node: sourceCode.ast,
 			level: 1,
@@ -1509,7 +1509,7 @@ var custom_container_marker_spacing_default = createRule("custom-container-marke
 /**
 * Parse options with defaults.
 */
-function parseOptions$4(options) {
+function parseOptions$5(options) {
 	const linkDefinitionPlacement = {
 		referencedFromSingleSection: options?.linkDefinitionPlacement?.referencedFromSingleSection || "document-last",
 		referencedFromMultipleSections: options?.linkDefinitionPlacement?.referencedFromMultipleSections || "document-last"
@@ -1583,7 +1583,7 @@ var definitions_last_default = createRule("definitions-last", {
 	},
 	create(context) {
 		const sourceCode = context.sourceCode;
-		const options = parseOptions$4(context.options[0]);
+		const options = parseOptions$5(context.options[0]);
 		/**
 		* Determine whether a node can be placed as the last node of the document or a section.
 		*/
@@ -5594,7 +5594,7 @@ function parseMathClosingSequenceFromText(text) {
 /**
 * Parse options.
 */
-function parseOptions$3(options) {
+function parseOptions$4(options) {
 	const listItems = options?.listItems;
 	return { listItems: {
 		first: listItems?.first ?? 1,
@@ -5647,7 +5647,7 @@ var indent_default = createRule("indent", {
 	},
 	create(context) {
 		const sourceCode = context.sourceCode;
-		const options = parseOptions$3(context.options[0]);
+		const options = parseOptions$4(context.options[0]);
 		class AbsBlockStack {
 			violations = [];
 			getCurrentBlockquote() {
@@ -6817,11 +6817,11 @@ var link_bracket_newline_default = createRule("link-bracket-newline", {
 	},
 	create(context) {
 		const sourceCode = context.sourceCode;
-		const optionProvider = parseOptions$6(context.options[0]);
+		const optionProvider = parseOptions$7(context.options[0]);
 		/**
 		* Parse the options.
 		*/
-		function parseOptions$6(option) {
+		function parseOptions$7(option) {
 			const newline = option?.newline ?? "never";
 			const multiline = option?.multiline ?? false;
 			return (bracketsRange) => {
@@ -6952,7 +6952,7 @@ var link_bracket_newline_default = createRule("link-bracket-newline", {
 /**
 * The basic option for links and images.
 */
-function parseOptions$2(option) {
+function parseOptions$3(option) {
 	const space = option?.space ?? "never";
 	const imagesInLinks = option?.imagesInLinks;
 	return {
@@ -7002,7 +7002,7 @@ var link_bracket_spacing_default = createRule("link-bracket-spacing", {
 	},
 	create(context) {
 		const sourceCode = context.sourceCode;
-		const options = parseOptions$2(context.options[0]);
+		const options = parseOptions$3(context.options[0]);
 		/**
 		* Verify the space after the opening bracket and before the closing bracket.
 		*/
@@ -7295,11 +7295,11 @@ var link_paren_newline_default = createRule("link-paren-newline", {
 	},
 	create(context) {
 		const sourceCode = context.sourceCode;
-		const optionProvider = parseOptions$6(context.options[0]);
+		const optionProvider = parseOptions$7(context.options[0]);
 		/**
 		* Parse the options.
 		*/
-		function parseOptions$6(option) {
+		function parseOptions$7(option) {
 			const newline = option?.newline ?? "never";
 			const multiline = option?.multiline ?? false;
 			return (openingParenIndex, closingParenIndex) => {
@@ -8905,7 +8905,7 @@ function markerToKind(marker) {
 /**
 * Parse rule options.
 */
-function parseOptions$1(options) {
+function parseOptions$2(options) {
 	const prefer = markerToKind(options.prefer) || ".";
 	const overrides = (options.overrides ?? []).map((override) => {
 		const preferForOverride = markerToKind(override.prefer) || ".";
@@ -8966,7 +8966,7 @@ var ordered_list_marker_style_default = createRule("ordered-list-marker-style",
 	},
 	create(context) {
 		const sourceCode = context.sourceCode;
-		const options = parseOptions$1(context.options[0] || {});
+		const options = parseOptions$2(context.options[0] || {});
 		let containerStack = {
 			node: sourceCode.ast,
 			level: 1,
@@ -10819,7 +10819,7 @@ function getCurrentTablePipeSpacingOption(sourceCode) {
 /**
 * Parsed options
 */
-function parseOptions(options) {
+function parseOptions$1(options) {
 	const spaceOption = options?.space;
 	const leadingSpace = (typeof spaceOption === "object" ? spaceOption.leading : spaceOption) || "always";
 	const trailingSpace = (typeof spaceOption === "object" ? spaceOption.trailing : spaceOption) || "always";
@@ -10929,7 +10929,7 @@ var table_pipe_spacing_default = createRule("table-pipe-spacing", {
 	},
 	create(context) {
 		const sourceCode = context.sourceCode;
-		const options = parseOptions(context.options[0]);
+		const options = parseOptions$1(context.options[0]);
 		currentOption.set(sourceCode, options);
 		/**
 		* Verify for the leading pipe.
@@ -11190,6 +11190,38 @@ var table_pipe_spacing_default = createRule("table-pipe-spacing", {
 
 //#endregion
 //#region src/rules/table-pipe-alignment.ts
+/**
+* Parse and normalize options
+*/
+function parseOptions(options) {
+	const columnOption = options?.column || "minimum";
+	const delimiterMinLengthOption = options?.delimiterMinLength || 3;
+	let delimiterMinLength;
+	if (delimiterMinLengthOption === "minimum" || delimiterMinLengthOption == null) delimiterMinLength = {
+		defaultDelimiter: 1,
+		leftAlignmentDelimiter: 2,
+		centerAlignmentDelimiter: 3,
+		rightAlignmentDelimiter: 2
+	};
+	else if (typeof delimiterMinLengthOption === "number") {
+		const v = Math.max(3, delimiterMinLengthOption);
+		delimiterMinLength = {
+			defaultDelimiter: v,
+			leftAlignmentDelimiter: v,
+			centerAlignmentDelimiter: v,
+			rightAlignmentDelimiter: v
+		};
+	} else delimiterMinLength = {
+		defaultDelimiter: typeof delimiterMinLengthOption.defaultDelimiter === "number" ? Math.max(1, delimiterMinLengthOption.defaultDelimiter) : 3,
+		leftAlignmentDelimiter: typeof delimiterMinLengthOption.leftAlignmentDelimiter === "number" ? Math.max(2, delimiterMinLengthOption.leftAlignmentDelimiter) : 3,
+		centerAlignmentDelimiter: typeof delimiterMinLengthOption.centerAlignmentDelimiter === "number" ? Math.max(3, delimiterMinLengthOption.centerAlignmentDelimiter) : 3,
+		rightAlignmentDelimiter: typeof delimiterMinLengthOption.rightAlignmentDelimiter === "number" ? Math.max(2, delimiterMinLengthOption.rightAlignmentDelimiter) : 3
+	};
+	return {
+		columnOption,
+		delimiterMinLength
+	};
+}
 var table_pipe_alignment_default = createRule("table-pipe-alignment", {
 	meta: {
 		type: "layout",
@@ -11202,7 +11234,38 @@ var table_pipe_alignment_default = createRule("table-pipe-alignment", {
 		hasSuggestions: false,
 		schema: [{
 			type: "object",
-			properties: { column: { enum: ["minimum", "consistent"] } },
+			properties: {
+				column: { enum: ["minimum", "consistent"] },
+				delimiterMinLength: { anyOf: [
+					{ const: "minimum" },
+					{
+						type: "number",
+						minimum: 3
+					},
+					{
+						type: "object",
+						properties: {
+							defaultDelimiter: {
+								type: "number",
+								minimum: 1
+							},
+							leftAlignmentDelimiter: {
+								type: "number",
+								minimum: 2
+							},
+							centerAlignmentDelimiter: {
+								type: "number",
+								minimum: 3
+							},
+							rightAlignmentDelimiter: {
+								type: "number",
+								minimum: 2
+							}
+						},
+						additionalProperties: false
+					}
+				] }
+			},
 			additionalProperties: false
 		}],
 		messages: {
@@ -11212,14 +11275,17 @@ var table_pipe_alignment_default = createRule("table-pipe-alignment", {
 	},
 	create(context) {
 		const sourceCode = context.sourceCode;
-		const columnOption = (context.options[0] || {}).column || "minimum";
+		const options = parseOptions(context.options[0]);
 		class TableContext {
 			rows;
+			delimiterRow;
 			columnCount;
-			_cacheHasSpaceBetweenContentAndTrailingPipe = /* @__PURE__ */ new Map();
+			_cacheNeedSpaceBetweenLeadingPipeAndContent = /* @__PURE__ */ new Map();
+			_cacheNeedSpaceBetweenContentAndTrailingPipe = /* @__PURE__ */ new Map();
 			_cacheExpectedPipePosition = /* @__PURE__ */ new Map();
 			constructor(parsed) {
-				const rows = [parsedTableRowToRowData(parsed.headerRow), parsedTableDelimiterRowToRowData(parsed.delimiterRow)];
+				this.delimiterRow = parsedTableDelimiterRowToRowData(parsed.delimiterRow);
+				const rows = [parsedTableRowToRowData(parsed.headerRow), this.delimiterRow];
 				for (const bodyRow of parsed.bodyRows) rows.push(parsedTableRowToRowData(bodyRow));
 				this.rows = rows;
 				let columnCount = 0;
@@ -11237,17 +11303,29 @@ var table_pipe_alignment_default = createRule("table-pipe-alignment", {
 				return v;
 			}
 			/**
+			* Check if there is at least one space between leading pipe and content
+			*/
+			isNeedSpaceBetweenLeadingPipeAndContent(pipeIndex) {
+				let v = this._cacheNeedSpaceBetweenLeadingPipeAndContent.get(pipeIndex);
+				if (v != null) return v;
+				if (getCurrentTablePipeSpacingOption(sourceCode)?.leadingSpace === "always") v = true;
+				else v = this._hasSpaceBetweenLeadingPipeAndContentWithoutCache(pipeIndex);
+				this._cacheNeedSpaceBetweenLeadingPipeAndContent.set(pipeIndex, v);
+				return v;
+			}
+			/**
 			* Check if there is at least one space between content and trailing pipe
 			* for the index
 			*
 			* This is used to determine if the pipe should be aligned with a space before it.
 			*/
-			hasSpaceBetweenContentAndTrailingPipe(pipeIndex) {
+			isNeedSpaceBetweenContentAndTrailingPipe(pipeIndex) {
 				if (pipeIndex === 0) return false;
-				let v = this._cacheHasSpaceBetweenContentAndTrailingPipe.get(pipeIndex);
+				let v = this._cacheNeedSpaceBetweenContentAndTrailingPipe.get(pipeIndex);
 				if (v != null) return v;
-				v = this._hasSpaceBetweenContentAndTrailingPipeWithoutCache(pipeIndex);
-				this._cacheHasSpaceBetweenContentAndTrailingPipe.set(pipeIndex, v);
+				if (getCurrentTablePipeSpacingOption(sourceCode)?.trailingSpace === "always") v = true;
+				else v = this._hasSpaceBetweenContentAndTrailingPipeWithoutCache(pipeIndex);
+				this._cacheNeedSpaceBetweenContentAndTrailingPipe.set(pipeIndex, v);
 				return v;
 			}
 			/**
@@ -11258,16 +11336,16 @@ var table_pipe_alignment_default = createRule("table-pipe-alignment", {
 					const firstCell = this.rows[0].cells[0];
 					const firstToken = firstCell.leadingPipe ?? firstCell.content;
 					if (!firstToken) return null;
-					return getTextWidth(sourceCode.lines[firstToken.loc.start.line - 1].slice(0, firstToken.loc.start.column - 1));
+					return getTextWidth(sourceCode.lines[firstToken.loc.start.line - 1], 0, firstToken.loc.start.column - 1);
 				}
-				if (columnOption === "minimum") return this.getMinimumPipePosition(pipeIndex);
-				else if (columnOption === "consistent") {
+				if (options.columnOption === "minimum") return this.getMinimumPipePosition(pipeIndex);
+				else if (options.columnOption === "consistent") {
 					const columnIndex = pipeIndex - 1;
 					for (const row of this.rows) {
 						if (row.cells.length <= columnIndex) continue;
 						const cell = row.cells[columnIndex];
 						if (cell.type === "delimiter" || !cell.trailingPipe) continue;
-						const width = getTextWidth(sourceCode.lines[cell.trailingPipe.loc.start.line - 1].slice(0, cell.trailingPipe.loc.start.column - 1));
+						const width = getTextWidth(sourceCode.lines[cell.trailingPipe.loc.start.line - 1], 0, cell.trailingPipe.loc.start.column - 1);
 						return Math.max(width, this.getMinimumPipePosition(pipeIndex) || 0);
 					}
 				}
@@ -11277,20 +11355,29 @@ var table_pipe_alignment_default = createRule("table-pipe-alignment", {
 			* Get the minimum pipe position for the index
 			*/
 			getMinimumPipePosition(pipeIndex) {
-				const spacingRuleOptions = getCurrentTablePipeSpacingOption(sourceCode);
-				const needSpaceBeforePipe = spacingRuleOptions ? spacingRuleOptions.trailingSpace === "always" : this.hasSpaceBetweenContentAndTrailingPipe(pipeIndex);
+				const needSpaceAfterPipe = this.isNeedSpaceBetweenLeadingPipeAndContent(pipeIndex - 1);
+				const needSpaceBeforePipe = this.isNeedSpaceBetweenContentAndTrailingPipe(pipeIndex);
 				let maxWidth = 0;
 				const columnIndex = pipeIndex - 1;
 				for (const row of this.rows) {
 					if (row.cells.length <= columnIndex) continue;
 					const cell = row.cells[columnIndex];
 					let width;
-					if (cell.type === "delimiter") {
+					if (cell.leadingPipe) {
+						const leadingPipeEndOffset = getTextWidth(sourceCode.lines[cell.leadingPipe.loc.end.line - 1], 0, cell.leadingPipe.loc.end.column - 1);
+						let contentLength;
+						if (cell.type === "delimiter") contentLength = getMinimumDelimiterLength(cell.align);
+						else {
+							if (!cell.content) continue;
+							contentLength = getTextWidth(sourceCode.lines[cell.content.loc.start.line - 1], cell.content.loc.start.column - 1, cell.content.loc.end.column - 1);
+						}
+						width = leadingPipeEndOffset + (needSpaceAfterPipe ? 1 : 0) + contentLength;
+					} else if (cell.type === "delimiter") {
 						const minimumDelimiterLength = getMinimumDelimiterLength(cell.align);
-						width = getTextWidth(sourceCode.lines[cell.delimiter.loc.start.line - 1].slice(0, cell.delimiter.loc.start.column - 1)) + minimumDelimiterLength;
+						width = getTextWidth(sourceCode.lines[cell.delimiter.loc.start.line - 1], 0, cell.delimiter.loc.start.column - 1) + minimumDelimiterLength;
 					} else {
 						if (!cell.content) continue;
-						width = getTextWidth(sourceCode.lines[cell.content.loc.end.line - 1].slice(0, cell.content.loc.end.column - 1));
+						width = getTextWidth(sourceCode.lines[cell.content.loc.end.line - 1], 0, cell.content.loc.end.column - 1);
 					}
 					if (needSpaceBeforePipe) width += 1;
 					maxWidth = Math.max(maxWidth, width);
@@ -11298,6 +11385,26 @@ var table_pipe_alignment_default = createRule("table-pipe-alignment", {
 				return maxWidth;
 			}
 			/**
+			* Check if there is at least one space between leading pipe and content
+			*/
+			_hasSpaceBetweenLeadingPipeAndContentWithoutCache(pipeIndex) {
+				const columnIndex = pipeIndex;
+				for (const row of this.rows) {
+					if (row.cells.length <= columnIndex) continue;
+					const cell = row.cells[columnIndex];
+					if (!cell.leadingPipe) continue;
+					let content;
+					if (cell.type === "delimiter") content = cell.delimiter;
+					else {
+						if (!cell.content) continue;
+						content = cell.content;
+					}
+					if (cell.leadingPipe.range[1] < content.range[0]) continue;
+					return false;
+				}
+				return true;
+			}
+			/**
 			* Check if there is at least one space between content and trailing pipe
 			*/
 			_hasSpaceBetweenContentAndTrailingPipeWithoutCache(pipeIndex) {
@@ -11350,7 +11457,7 @@ var table_pipe_alignment_default = createRule("table-pipe-alignment", {
 		function verifyPipe(pipe, pipeIndex, table, cell) {
 			const expected = table.getExpectedPipePosition(pipeIndex);
 			if (expected == null) return true;
-			const actual = getTextWidth(sourceCode.lines[pipe.loc.start.line - 1].slice(0, pipe.loc.start.column - 1));
+			const actual = getTextWidth(sourceCode.lines[pipe.loc.start.line - 1], 0, pipe.loc.start.column - 1);
 			const diff = expected - actual;
 			if (diff === 0) return true;
 			context.report({
@@ -11373,12 +11480,19 @@ var table_pipe_alignment_default = createRule("table-pipe-alignment", {
 					const widthBeforeDelimiter = getTextWidth(beforeDelimiter);
 					const newLength = expected - widthBeforeDelimiter;
 					const minimumDelimiterLength = getMinimumDelimiterLength(cell.align);
-					const spaceAfter = table.hasSpaceBetweenContentAndTrailingPipe(pipeIndex) ? " " : "";
-					if (newLength < minimumDelimiterLength + spaceAfter.length) return null;
+					const spaceAfter = table.isNeedSpaceBetweenContentAndTrailingPipe(pipeIndex) ? " " : "";
+					if (newLength < minimumDelimiterLength + spaceAfter.length) {
+						const edit = fixRemoveSpacesFromLeadingSpaces(Math.abs(newLength - minimumDelimiterLength) + spaceAfter.length);
+						if (!edit) return null;
+						const delimiterPrefix$1 = cell.align === "left" || cell.align === "center" ? ":" : "";
+						const delimiterSuffix$1 = cell.align === "right" || cell.align === "center" ? ":" : "";
+						const newDelimiter$1 = "-".repeat(minimumDelimiterLength - delimiterPrefix$1.length - delimiterSuffix$1.length);
+						return [edit, fixer.replaceTextRange([cell.delimiter.range[0], pipe.range[0]], delimiterPrefix$1 + newDelimiter$1 + delimiterSuffix$1 + spaceAfter)];
+					}
 					const delimiterPrefix = cell.align === "left" || cell.align === "center" ? ":" : "";
-					const delimiterSuffix = (cell.align === "right" || cell.align === "center" ? ":" : "") + spaceAfter;
-					const newDelimiter = "-".repeat(newLength - delimiterPrefix.length - delimiterSuffix.length);
-					return fixer.replaceTextRange([cell.delimiter.range[0], pipe.range[0]], delimiterPrefix + newDelimiter + delimiterSuffix);
+					const delimiterSuffix = cell.align === "right" || cell.align === "center" ? ":" : "";
+					const newDelimiter = "-".repeat(newLength - delimiterPrefix.length - delimiterSuffix.length - spaceAfter.length);
+					return fixer.replaceTextRange([cell.delimiter.range[0], pipe.range[0]], delimiterPrefix + newDelimiter + delimiterSuffix + spaceAfter);
 					/**
 					* Fixer to remove spaces before the pipe
 					*/
@@ -11388,18 +11502,38 @@ var table_pipe_alignment_default = createRule("table-pipe-alignment", {
 						const spacesBeforePipeLength = beforePipe.length - trimmedBeforePipe.length;
 						const widthBeforePipe = getTextWidth(trimmedBeforePipe);
 						const newSpacesLength = expected - widthBeforePipe;
-						if (newSpacesLength < (table.hasSpaceBetweenContentAndTrailingPipe(pipeIndex) ? 1 : 0)) return null;
+						const minTrailingSpaceWidth = table.isNeedSpaceBetweenContentAndTrailingPipe(pipeIndex) ? 1 : 0;
+						if (newSpacesLength < minTrailingSpaceWidth) {
+							const edit = fixRemoveSpacesFromLeadingSpaces(Math.abs(newSpacesLength) + minTrailingSpaceWidth);
+							if (!edit) return null;
+							return [edit, fixer.replaceTextRange([pipe.range[0] - spacesBeforePipeLength, pipe.range[0]], " ".repeat(minTrailingSpaceWidth))];
+						}
 						return fixer.replaceTextRange([pipe.range[0] - spacesBeforePipeLength, pipe.range[0]], " ".repeat(newSpacesLength));
 					}
+					/**
+					* Fixer to remove spaces from the leading spaces
+					*/
+					function fixRemoveSpacesFromLeadingSpaces(removeSpaceLength) {
+						if (!cell.leadingPipe || pipeIndex === 0) return null;
+						const content = cell.type === "delimiter" ? cell.delimiter : cell.content;
+						if (!content) return null;
+						const newSpacesLength = getTextWidth(sourceCode.lines[cell.leadingPipe.loc.end.line - 1], cell.leadingPipe.loc.end.column - 1, content.loc.start.column - 1) - removeSpaceLength;
+						if (newSpacesLength < (table.isNeedSpaceBetweenLeadingPipeAndContent(pipeIndex - 1) ? 1 : 0)) return null;
+						return fixer.replaceTextRange([cell.leadingPipe.range[1], content.range[0]], " ".repeat(newSpacesLength));
+					}
 				}
 			});
 			return false;
 		}
 		/**
-		* Get the minimum delimiter length based on alignment
+		* Get the minimum delimiter length based on alignment and options
 		*/
 		function getMinimumDelimiterLength(align) {
-			return align === "none" ? 1 : align === "center" ? 3 : 2;
+			if (align === "none") return options.delimiterMinLength.defaultDelimiter;
+			if (align === "left") return options.delimiterMinLength.leftAlignmentDelimiter;
+			if (align === "center") return options.delimiterMinLength.centerAlignmentDelimiter;
+			if (align === "right") return options.delimiterMinLength.rightAlignmentDelimiter;
+			return options.delimiterMinLength.defaultDelimiter;
 		}
 		return { table(node) {
 			const parsed = parseTable(sourceCode, node);
@@ -11803,7 +11937,7 @@ var meta_exports = /* @__PURE__ */ __export({
 	version: () => version
 });
 const name = "eslint-plugin-markdown-preferences";
-const version = "0.31.0";
+const version = "0.33.0";
 
 //#endregion
 //#region src/language/extensions/micromark-custom-container.ts

package/package.json

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