eslint-plugin-markdown-preferences 0.33.0 → 0.34.0

package/lib/index.d.ts

@@ -412,6 +412,13 @@ type MarkdownPreferencesOrderedListMarkerStyle = [] | [{
 }];
 type MarkdownPreferencesPaddedCustomContainers = [] | [{
   padding?: ("always" | "never");
+  overrides?: [{
+    info?: (string | [string, ...(string)[]]);
+    padding?: ("always" | "never");
+  }, ...({
+    info?: (string | [string, ...(string)[]]);
+    padding?: ("always" | "never");
+  })[]];
 }];
 type MarkdownPreferencesPaddingLineBetweenBlocks = {
   prev: (("blockquote" | "code" | "heading" | "html" | "list" | "paragraph" | "thematic-break" | "table" | "link-definition" | "footnote-definition" | "frontmatter" | "custom-container" | "math" | "import-code-snippet" | "*") | [("blockquote" | "code" | "heading" | "html" | "list" | "paragraph" | "thematic-break" | "table" | "link-definition" | "footnote-definition" | "frontmatter" | "custom-container" | "math" | "import-code-snippet" | "*"), ...(("blockquote" | "code" | "heading" | "html" | "list" | "paragraph" | "thematic-break" | "table" | "link-definition" | "footnote-definition" | "frontmatter" | "custom-container" | "math" | "import-code-snippet" | "*"))[]] | {
@@ -538,7 +545,7 @@ declare namespace meta_d_exports {
   export { name, version };
 }
 declare const name: "eslint-plugin-markdown-preferences";
-declare const version: "0.33.0";
+declare const version: "0.34.0";
 //#endregion
 //#region src/language/ast-types.d.ts
 type Node = mdast.Node;
@@ -580,7 +587,7 @@ interface CustomContainer extends ExtendChildren<mdast.Parent, CustomContainer |
   /**
    * Info string (e.g., "warning" in ::: warning ... :::).
    */
-  info: string | null;
+  info: string;
   /**
    * Children of custom container.
    */

package/lib/index.js

@@ -828,7 +828,7 @@ function getOtherMarker(unavailableMarker) {
 /**
 * Parse rule options.
 */
-function parseOptions$6(options) {
+function parseOptions$7(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$6(context.options[0] || {});
+		const options = parseOptions$7(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$5(options) {
+function parseOptions$6(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$5(context.options[0]);
+		const options = parseOptions$6(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$4(options) {
+function parseOptions$5(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$4(context.options[0]);
+		const options = parseOptions$5(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$7(context.options[0]);
+		const optionProvider = parseOptions$8(context.options[0]);
 		/**
 		* Parse the options.
 		*/
-		function parseOptions$7(option) {
+		function parseOptions$8(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$3(option) {
+function parseOptions$4(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$3(context.options[0]);
+		const options = parseOptions$4(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$7(context.options[0]);
+		const optionProvider = parseOptions$8(context.options[0]);
 		/**
 		* Parse the options.
 		*/
-		function parseOptions$7(option) {
+		function parseOptions$8(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$2(options) {
+function parseOptions$3(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$2(context.options[0] || {});
+		const options = parseOptions$3(context.options[0] || {});
 		let containerStack = {
 			node: sourceCode.ast,
 			level: 1,
@@ -9056,6 +9056,38 @@ var ordered_list_marker_style_default = createRule("ordered-list-marker-style",
 
 //#endregion
 //#region src/rules/padded-custom-containers.ts
+/**
+* Parse the given options.
+*/
+function parseOptions$2(options) {
+	const padding = options?.padding || "never";
+	const overrides = (options?.overrides || []).map((override) => {
+		return {
+			test: normalizeTest(override.info),
+			padding: override.padding || padding
+		};
+	}).reverse();
+	/**
+	* Get the padding setting for the given container.
+	*/
+	function getPaddingForContainer(node) {
+		for (const override of overrides) if (override.test(node)) return override.padding;
+		return padding;
+	}
+	return { getPaddingForContainer };
+	/**
+	* Normalize the given info option.
+	*/
+	function normalizeTest(infoOption) {
+		if (infoOption == null) return () => false;
+		if (Array.isArray(infoOption)) {
+			const tests = infoOption.map(normalizeTest);
+			return (n) => tests.some((t) => t(n));
+		}
+		const test = toRegExp(infoOption);
+		return (n) => test.test(n.info);
+	}
+}
 var padded_custom_containers_default = createRule("padded-custom-containers", {
 	meta: {
 		type: "layout",
@@ -9068,11 +9100,34 @@ var padded_custom_containers_default = createRule("padded-custom-containers", {
 		hasSuggestions: false,
 		schema: [{
 			type: "object",
-			properties: { padding: {
-				type: "string",
-				enum: ["always", "never"],
-				default: "never"
-			} },
+			properties: {
+				padding: {
+					type: "string",
+					enum: ["always", "never"],
+					default: "never"
+				},
+				overrides: {
+					type: "array",
+					items: {
+						type: "object",
+						properties: {
+							info: { anyOf: [{ type: "string" }, {
+								type: "array",
+								items: { type: "string" },
+								minItems: 1,
+								uniqueItems: true
+							}] },
+							padding: {
+								type: "string",
+								enum: ["always", "never"]
+							}
+						},
+						additionalProperties: false
+					},
+					uniqueItems: true,
+					minItems: 1
+				}
+			},
 			additionalProperties: false
 		}],
 		messages: {
@@ -9084,9 +9139,10 @@ var padded_custom_containers_default = createRule("padded-custom-containers", {
 	},
 	create(context) {
 		const sourceCode = context.sourceCode;
-		const padding = (context.options[0] || {}).padding || "never";
+		const options = parseOptions$2(context.options[0]);
 		return { customContainer(node) {
 			if (node.children.length === 0) return;
+			const padding = options.getPaddingForContainer(node);
 			const parsed = parseCustomContainer(sourceCode, node);
 			if (!parsed) return;
 			const { openingSequence, closingSequence } = parsed;
@@ -9117,30 +9173,28 @@ var padded_custom_containers_default = createRule("padded-custom-containers", {
 				});
 			} else if (padding === "never") {
 				if (paddingAfterOpeningLines > 0) {
-					const firstChildRange = sourceCode.getRange(firstChild);
+					const lines = getParsedLines(sourceCode);
+					const reportLines = [];
+					for (let lineNumber = openingSequence.loc.end.line + 1; lineNumber < firstChildLoc.start.line; lineNumber++) reportLines.push(lines.get(lineNumber));
+					const removeRange = [reportLines[0].range[0], reportLines[reportLines.length - 1].range[1]];
 					context.report({
 						messageId: "unexpectedPaddingAfterOpeningMarker",
-						loc: getSourceLocationFromRange(sourceCode, node, [openingSequence.range[1], firstChildRange[0]]),
-						*fix(fixer) {
-							const lines = getParsedLines(sourceCode);
-							for (let lineNumber = openingSequence.loc.end.line + 1; lineNumber < firstChildLoc.start.line; lineNumber++) {
-								const line = lines.get(lineNumber);
-								yield fixer.removeRange(line.range);
-							}
+						loc: getSourceLocationFromRange(sourceCode, node, removeRange),
+						fix(fixer) {
+							return fixer.removeRange(removeRange);
 						}
 					});
 				}
 				if (closingSequence && paddingBeforeClosingLines !== null && paddingBeforeClosingLines > 0) {
-					const lastChildRange = sourceCode.getRange(lastChild);
+					const lines = getParsedLines(sourceCode);
+					const reportLines = [];
+					for (let lineNumber = lastChildLoc.end.line + 1; lineNumber < closingSequence.loc.start.line; lineNumber++) reportLines.push(lines.get(lineNumber));
+					const removeRange = [reportLines[0].range[0], reportLines[reportLines.length - 1].range[1]];
 					context.report({
 						messageId: "unexpectedPaddingBeforeClosingMarker",
-						loc: getSourceLocationFromRange(sourceCode, node, [lastChildRange[1], closingSequence.range[0]]),
-						*fix(fixer) {
-							const lines = getParsedLines(sourceCode);
-							for (let lineNumber = lastChildLoc.end.line + 1; lineNumber < closingSequence.loc.start.line; lineNumber++) {
-								const line = lines.get(lineNumber);
-								yield fixer.removeRange(line.range);
-							}
+						loc: getSourceLocationFromRange(sourceCode, node, removeRange),
+						fix(fixer) {
+							return fixer.removeRange(removeRange);
 						}
 					});
 				}
@@ -11937,7 +11991,7 @@ var meta_exports = /* @__PURE__ */ __export({
 	version: () => version
 });
 const name = "eslint-plugin-markdown-preferences";
-const version = "0.33.0";
+const version = "0.34.0";
 
 //#endregion
 //#region src/language/extensions/micromark-custom-container.ts

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eslint-plugin-markdown-preferences",
-  "version": "0.33.0",
+  "version": "0.34.0",
   "description": "ESLint plugin that enforces our markdown preferences",
   "type": "module",
   "exports": {
@@ -79,7 +79,7 @@
     "@changesets/changelog-github": "^0.5.1",
     "@changesets/cli": "^2.28.1",
     "@changesets/get-release-plan": "^4.0.8",
-    "@eslint/core": "^0.15.0",
+    "@eslint/core": "^0.16.0",
     "@eslint/markdown": "^7.2.0",
     "@ota-meshi/eslint-plugin": "^0.18.0",
     "@shikijs/vitepress-twoslash": "^3.0.0",