eslint-plugin-markdown-preferences 0.36.3 → 0.37.0

package/README.md

@@ -203,6 +203,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-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/chunk-BAz01cYq.js

@@ -0,0 +1,18 @@
+//#region rolldown:runtime
+var __defProp = Object.defineProperty;
+var __export = (all, symbols) => {
+	let target = {};
+	for (var name in all) {
+		__defProp(target, name, {
+			get: all[name],
+			enumerable: true
+		});
+	}
+	if (symbols) {
+		__defProp(target, Symbol.toStringTag, { value: "Module" });
+	}
+	return target;
+};
+
+//#endregion
+export { __export as t };

package/lib/index.d.ts

@@ -160,6 +160,11 @@ interface RuleOptions {
    * @see https://ota-meshi.github.io/eslint-plugin-markdown-preferences/rules/no-multiple-empty-lines.html
    */
   'markdown-preferences/no-multiple-empty-lines'?: Linter.RuleEntry<MarkdownPreferencesNoMultipleEmptyLines>;
+  /**
+   * 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>;
   /**
    * disallow text backslash at the end of a line.
    * @see https://ota-meshi.github.io/eslint-plugin-markdown-preferences/rules/no-text-backslash-linebreak.html
@@ -398,6 +403,11 @@ type MarkdownPreferencesNoMultipleEmptyLines = [] | [{
   maxEOF?: number;
   maxBOF?: number;
 }];
+type MarkdownPreferencesNoTabs = [] | [{
+  checkTarget?: ("all" | "indentation" | "non-indentation");
+  ignoreCodeBlocks?: string[];
+  codeBlockTabWidth?: number;
+}];
 type MarkdownPreferencesNoTrailingSpaces = [] | [{
   skipBlankLines?: boolean;
   ignoreComments?: boolean;
@@ -543,7 +553,7 @@ declare namespace meta_d_exports {
   export { name, version };
 }
 declare const name: "eslint-plugin-markdown-preferences";
-declare const version: "0.36.3";
+declare const version: "0.37.0";
 //#endregion
 //#region src/language/ast-types.d.ts
 type Node = mdast.Node;

package/lib/index.js

@@ -1,4 +1,4 @@
-import { t as __export } from "./chunk-Bp6m_JJh.js";
+import { t as __export } from "./chunk-BAz01cYq.js";
 import stringWidth from "string-width";
 import emojiRegex from "emoji-regex-xs";
 import path from "node:path";
@@ -732,7 +732,7 @@ function getOtherMarker(unavailableMarker) {
 /**
 * Parse rule options.
 */
-function parseOptions$7(options) {
+function parseOptions$8(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}").`);
@@ -800,7 +800,7 @@ var bullet_list_marker_style_default = createRule("bullet-list-marker-style", {
 	},
 	create(context) {
 		const sourceCode = context.sourceCode;
-		const options = parseOptions$7(context.options[0] || {});
+		const options = parseOptions$8(context.options[0] || {});
 		let containerStack = {
 			node: sourceCode.ast,
 			level: 1,
@@ -1418,7 +1418,7 @@ var custom_container_marker_spacing_default = createRule("custom-container-marke
 /**
 * Parse options with defaults.
 */
-function parseOptions$6(options) {
+function parseOptions$7(options) {
 	return {
 		linkDefinitionPlacement: {
 			referencedFromSingleSection: options?.linkDefinitionPlacement?.referencedFromSingleSection || "document-last",
@@ -1490,7 +1490,7 @@ var definitions_last_default = createRule("definitions-last", {
 	},
 	create(context) {
 		const sourceCode = context.sourceCode;
-		const options = parseOptions$6(context.options[0]);
+		const options = parseOptions$7(context.options[0]);
 		/**
 		* Determine whether a node can be placed as the last node of the document or a section.
 		*/
@@ -5464,7 +5464,7 @@ function parseMathClosingSequenceFromText(text) {
 /**
 * Parse options.
 */
-function parseOptions$5(options) {
+function parseOptions$6(options) {
 	const listItems = options?.listItems;
 	return { listItems: {
 		first: listItems?.first ?? 1,
@@ -5517,7 +5517,7 @@ var indent_default = createRule("indent", {
 	},
 	create(context) {
 		const sourceCode = context.sourceCode;
-		const options = parseOptions$5(context.options[0]);
+		const options = parseOptions$6(context.options[0]);
 		class AbsBlockStack {
 			violations = [];
 			getCurrentBlockquote() {
@@ -6723,11 +6723,11 @@ var link_bracket_newline_default = createRule("link-bracket-newline", {
 	},
 	create(context) {
 		const sourceCode = context.sourceCode;
-		const optionProvider = parseOptions$8(context.options[0]);
+		const optionProvider = parseOptions$9(context.options[0]);
 		/**
 		* Parse the options.
 		*/
-		function parseOptions$8(option) {
+		function parseOptions$9(option) {
 			const newline = option?.newline ?? "never";
 			const multiline = option?.multiline ?? false;
 			return (bracketsRange) => {
@@ -6869,7 +6869,7 @@ var link_bracket_newline_default = createRule("link-bracket-newline", {
 /**
 * The basic option for links and images.
 */
-function parseOptions$4(option) {
+function parseOptions$5(option) {
 	const space = option?.space ?? "never";
 	const imagesInLinks = option?.imagesInLinks;
 	return {
@@ -6919,7 +6919,7 @@ var link_bracket_spacing_default = createRule("link-bracket-spacing", {
 	},
 	create(context) {
 		const sourceCode = context.sourceCode;
-		const options = parseOptions$4(context.options[0]);
+		const options = parseOptions$5(context.options[0]);
 		/**
 		* Verify the space after the opening bracket and before the closing bracket.
 		*/
@@ -7228,11 +7228,11 @@ var link_paren_newline_default = createRule("link-paren-newline", {
 	},
 	create(context) {
 		const sourceCode = context.sourceCode;
-		const optionProvider = parseOptions$8(context.options[0]);
+		const optionProvider = parseOptions$9(context.options[0]);
 		/**
 		* Parse the options.
 		*/
-		function parseOptions$8(option) {
+		function parseOptions$9(option) {
 			const newline = option?.newline ?? "never";
 			const multiline = option?.multiline ?? false;
 			return (openingParenIndex, closingParenIndex) => {
@@ -8486,6 +8486,161 @@ var no_multiple_empty_lines_default = createRule("no-multiple-empty-lines", {
 	}
 });
 
+//#endregion
+//#region src/rules/no-tabs.ts
+/**
+* Parse options
+*/
+function parseOptions$4(options) {
+	const checkTarget = options?.checkTarget || "all";
+	const checkTargets = checkTarget === "all" ? ["indentation", "non-indentation"] : [checkTarget];
+	return {
+		ignoreCodeBlocks: options?.ignoreCodeBlocks || [],
+		checkTargets,
+		codeBlockTabWidth: options?.codeBlockTabWidth ?? 4
+	};
+}
+var no_tabs_default = createRule("no-tabs", {
+	meta: {
+		type: "layout",
+		docs: {
+			description: "Disallow tab characters in Markdown files.",
+			categories: ["standard"],
+			listCategory: "Whitespace"
+		},
+		fixable: "whitespace",
+		hasSuggestions: false,
+		schema: [{
+			type: "object",
+			properties: {
+				checkTarget: {
+					type: "string",
+					enum: [
+						"all",
+						"indentation",
+						"non-indentation"
+					],
+					default: "all"
+				},
+				ignoreCodeBlocks: {
+					type: "array",
+					items: { type: "string" },
+					default: []
+				},
+				codeBlockTabWidth: {
+					type: "integer",
+					minimum: 1,
+					default: 4
+				}
+			},
+			additionalProperties: false
+		}],
+		messages: { unexpectedTab: "Unexpected tab character." }
+	},
+	create(context) {
+		const sourceCode = context.sourceCode;
+		const { ignoreCodeBlocks, checkTargets, codeBlockTabWidth } = parseOptions$4(context.options[0]);
+		const codeBlocks = [];
+		/** Check if a language should be ignored based on ignoreCodeBlocks option */
+		function shouldIgnoreLanguage(language$2) {
+			if (ignoreCodeBlocks.length === 0) return false;
+			if (ignoreCodeBlocks.includes("*")) return true;
+			return language$2 !== null && ignoreCodeBlocks.includes(language$2);
+		}
+		/**
+		* Check if the given index is at indentation (beginning of line)
+		*/
+		function isAtIndentation(index) {
+			const loc = sourceCode.getLocFromIndex(index);
+			const text = sourceCode.lines[loc.line - 1].slice(0, loc.column - 1);
+			return !text || isWhitespace(text);
+		}
+		/**
+		* Find the code block containing the given index
+		*/
+		function findCodeBlock(index) {
+			const codeBlock = codeBlocks.find((block) => index >= block.contentRange[0] && index < block.contentRange[1]);
+			if (!codeBlock) return null;
+			const loc = sourceCode.getLocFromIndex(index);
+			if (getWidth(sourceCode.lines[loc.line - 1].slice(0, loc.column - 1)) < codeBlock.indentWidth) return null;
+			return codeBlock;
+		}
+		/**
+		* Calculate the number of spaces to replace a tab.
+		* Handles both regular tabs and tabs within code block content.
+		*/
+		function calculateReplacementSpaces(tabIndex, codeBlock) {
+			const loc = sourceCode.getLocFromIndex(tabIndex);
+			const beforeText = sourceCode.lines[loc.line - 1].slice(0, loc.column - 1);
+			if (!codeBlock || codeBlockTabWidth === 4) return 4 - getWidth(beforeText) % 4;
+			let tabStop = codeBlock.indentWidth <= 0 ? codeBlockTabWidth : 4;
+			let beforeWidth = 0;
+			for (const c of beforeText) {
+				if (c === "	") beforeWidth += tabStop - beforeWidth % tabStop;
+				else beforeWidth++;
+				if (tabStop === 4 && codeBlock.indentWidth <= beforeWidth) tabStop = codeBlockTabWidth;
+			}
+			return tabStop - beforeWidth % tabStop;
+		}
+		return {
+			code(node) {
+				const range = sourceCode.getRange(node);
+				const loc = sourceCode.getLoc(node);
+				const codeBlockStartLineText = sourceCode.lines[loc.start.line - 1];
+				const codeBlockIndentText = codeBlockStartLineText.slice(0, loc.start.column - 1);
+				if (getCodeBlockKind(sourceCode, node) === "indented") {
+					const baseWidth = getWidth(codeBlockIndentText);
+					let indentText;
+					let indentColumnIndex = loc.start.column;
+					while (getWidth(indentText = codeBlockStartLineText.slice(0, indentColumnIndex)) < baseWidth + 4) indentColumnIndex++;
+					codeBlocks.push({
+						contentRange: [range[0] + 1, range[1]],
+						indentWidth: getWidth(indentText),
+						ignore: shouldIgnoreLanguage(null) ? "check" : indentText.includes("	") ? "fix" : false
+					});
+					return;
+				}
+				const parsed = parseFencedCodeBlock(sourceCode, node);
+				if (!parsed) {
+					codeBlocks.push({
+						contentRange: range,
+						indentWidth: getWidth(codeBlockIndentText),
+						ignore: "check"
+					});
+					return;
+				}
+				codeBlocks.push({
+					contentRange: [(parsed.meta ?? parsed.language ?? parsed.openingFence).range[1], parsed.closingFence?.range[0] ?? range[1]],
+					indentWidth: getWidth(codeBlockIndentText),
+					ignore: shouldIgnoreLanguage(node.lang?.toLowerCase() ?? null) ? "check" : false
+				});
+			},
+			"root:exit"() {
+				for (let i = 0; i < sourceCode.text.length; i++) {
+					if (sourceCode.text[i] !== "	") continue;
+					if (isAtIndentation(i)) {
+						if (!checkTargets.includes("indentation")) continue;
+					} else if (!checkTargets.includes("non-indentation")) continue;
+					const codeBlock = findCodeBlock(i);
+					if (codeBlock?.ignore === "check") continue;
+					context.report({
+						loc: {
+							start: sourceCode.getLocFromIndex(i),
+							end: sourceCode.getLocFromIndex(i + 1)
+						},
+						messageId: "unexpectedTab",
+						fix: (fixer) => {
+							if (codeBlock?.ignore === "fix") return null;
+							const spaces = calculateReplacementSpaces(i, codeBlock);
+							return fixer.replaceTextRange([i, i + 1], " ".repeat(spaces));
+						}
+					});
+				}
+			}
+		};
+	}
+});
+
 //#endregion
 //#region src/rules/no-text-backslash-linebreak.ts
 var no_text_backslash_linebreak_default = createRule("no-text-backslash-linebreak", {
@@ -12109,6 +12264,7 @@ const rules$1 = [
 	no_laziness_blockquotes_default,
 	no_multi_spaces_default,
 	no_multiple_empty_lines_default,
+	no_tabs_default,
 	no_text_backslash_linebreak_default,
 	no_trailing_spaces_default,
 	ordered_list_marker_sequence_default,
@@ -12209,6 +12365,7 @@ const rules$2 = {
 	"markdown-preferences/no-laziness-blockquotes": "error",
 	"markdown-preferences/no-multi-spaces": "error",
 	"markdown-preferences/no-multiple-empty-lines": "error",
+	"markdown-preferences/no-tabs": "error",
 	"markdown-preferences/no-text-backslash-linebreak": "error",
 	"markdown-preferences/no-trailing-spaces": "error",
 	"markdown-preferences/ordered-list-marker-sequence": "error",
@@ -12236,7 +12393,7 @@ var meta_exports = /* @__PURE__ */ __export({
 	version: () => version
 });
 const name = "eslint-plugin-markdown-preferences";
-const version = "0.36.3";
+const version = "0.37.0";
 
 //#endregion
 //#region src/language/extensions/micromark-custom-container.ts

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eslint-plugin-markdown-preferences",
-  "version": "0.36.3",
+  "version": "0.37.0",
   "description": "ESLint plugin that enforces our markdown preferences",
   "type": "module",
   "exports": {
@@ -80,7 +80,7 @@
     "@changesets/changelog-github": "^0.5.1",
     "@changesets/cli": "^2.28.1",
     "@changesets/get-release-plan": "^4.0.8",
-    "@eslint/core": "^0.17.0",
+    "@eslint/core": "^1.0.0",
     "@eslint/markdown": "^7.4.0",
     "@ota-meshi/eslint-plugin": "^0.18.0",
     "@shikijs/vitepress-twoslash": "^3.0.0",
@@ -114,7 +114,7 @@
     "eslint-plugin-yml": "^1.17.0",
     "eslint-snapshot-rule-tester": "^0.1.0",
     "eslint-typegen": "^2.0.0",
-    "espree": "^10.3.0",
+    "espree": "^11.0.0",
     "events": "^3.3.0",
     "globals": "^16.0.0",
     "mocha": "^11.1.0",

package/lib/chunk-Bp6m_JJh.js

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