eslint-plugin-markdown-preferences 0.29.1 → 0.30.0

package/README.md

@@ -190,21 +190,23 @@ The rules with the following 💄 are included in the `standard` config.
 
 <!-- prettier-ignore-start -->
 
-| Rule ID                                                                                                                                                   | Description                                                          | Fixable | Config |
-| :-------------------------------------------------------------------------------------------------------------------------------------------------------- | :------------------------------------------------------------------- | :-----: | :----: |
-| [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/indent](https://ota-meshi.github.io/eslint-plugin-markdown-preferences/rules/indent.html)                                           | enforce consistent indentation in Markdown files                     |   🔧    |   💄   |
-| [markdown-preferences/link-bracket-newline](https://ota-meshi.github.io/eslint-plugin-markdown-preferences/rules/link-bracket-newline.html)               | enforce linebreaks after opening and before closing link brackets    |   🔧    |   💄   |
-| [markdown-preferences/link-bracket-spacing](https://ota-meshi.github.io/eslint-plugin-markdown-preferences/rules/link-bracket-spacing.html)               | enforce consistent spacing inside link brackets                      |   🔧    |   💄   |
-| [markdown-preferences/link-paren-newline](https://ota-meshi.github.io/eslint-plugin-markdown-preferences/rules/link-paren-newline.html)                   | enforce linebreaks after opening and before closing link parentheses |   🔧    |   💄   |
-| [markdown-preferences/link-paren-spacing](https://ota-meshi.github.io/eslint-plugin-markdown-preferences/rules/link-paren-spacing.html)                   | enforce consistent spacing inside link parentheses                   |   🔧    |   💄   |
-| [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-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                     |   🔧    |   💄   |
-| [markdown-preferences/table-pipe-spacing](https://ota-meshi.github.io/eslint-plugin-markdown-preferences/rules/table-pipe-spacing.html)                   | enforce consistent spacing around table pipes                        |   🔧    |   💄   |
+| Rule ID                                                                                                                                                           | Description                                                                    | Fixable | Config |
+| :---------------------------------------------------------------------------------------------------------------------------------------------------------------- | :----------------------------------------------------------------------------- | :-----: | :----: |
+| [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/code-fence-spacing](https://ota-meshi.github.io/eslint-plugin-markdown-preferences/rules/code-fence-spacing.html)                           | require or disallow spacing between opening code fence and language identifier |   🔧    |        |
+| [markdown-preferences/custom-container-marker-spacing](https://ota-meshi.github.io/eslint-plugin-markdown-preferences/rules/custom-container-marker-spacing.html) | require or disallow spacing between opening custom container marker and info   |   🔧    |        |
+| [markdown-preferences/indent](https://ota-meshi.github.io/eslint-plugin-markdown-preferences/rules/indent.html)                                                   | enforce consistent indentation in Markdown files                               |   🔧    |   💄   |
+| [markdown-preferences/link-bracket-newline](https://ota-meshi.github.io/eslint-plugin-markdown-preferences/rules/link-bracket-newline.html)                       | enforce linebreaks after opening and before closing link brackets              |   🔧    |   💄   |
+| [markdown-preferences/link-bracket-spacing](https://ota-meshi.github.io/eslint-plugin-markdown-preferences/rules/link-bracket-spacing.html)                       | enforce consistent spacing inside link brackets                                |   🔧    |   💄   |
+| [markdown-preferences/link-paren-newline](https://ota-meshi.github.io/eslint-plugin-markdown-preferences/rules/link-paren-newline.html)                           | enforce linebreaks after opening and before closing link parentheses           |   🔧    |   💄   |
+| [markdown-preferences/link-paren-spacing](https://ota-meshi.github.io/eslint-plugin-markdown-preferences/rules/link-paren-spacing.html)                           | enforce consistent spacing inside link parentheses                             |   🔧    |   💄   |
+| [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-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                               |   🔧    |   💄   |
+| [markdown-preferences/table-pipe-spacing](https://ota-meshi.github.io/eslint-plugin-markdown-preferences/rules/table-pipe-spacing.html)                           | enforce consistent spacing around table pipes                                  |   🔧    |   💄   |
 
 <!-- prettier-ignore-end -->
 

package/lib/index.d.ts

@@ -45,11 +45,21 @@ interface RuleOptions {
    * @see https://ota-meshi.github.io/eslint-plugin-markdown-preferences/rules/code-fence-length.html
    */
   'markdown-preferences/code-fence-length'?: Linter.RuleEntry<MarkdownPreferencesCodeFenceLength>;
+  /**
+   * require or disallow spacing between opening code fence and language identifier
+   * @see https://ota-meshi.github.io/eslint-plugin-markdown-preferences/rules/code-fence-spacing.html
+   */
+  'markdown-preferences/code-fence-spacing'?: Linter.RuleEntry<MarkdownPreferencesCodeFenceSpacing>;
   /**
    * enforce a consistent code fence style (backtick or tilde) in Markdown fenced code blocks.
    * @see https://ota-meshi.github.io/eslint-plugin-markdown-preferences/rules/code-fence-style.html
    */
   'markdown-preferences/code-fence-style'?: Linter.RuleEntry<MarkdownPreferencesCodeFenceStyle>;
+  /**
+   * require or disallow spacing between opening custom container marker and info
+   * @see https://ota-meshi.github.io/eslint-plugin-markdown-preferences/rules/custom-container-marker-spacing.html
+   */
+  'markdown-preferences/custom-container-marker-spacing'?: Linter.RuleEntry<MarkdownPreferencesCustomContainerMarkerSpacing>;
   /**
    * require link definitions and footnote definitions to be placed at the end of the document
    * @see https://ota-meshi.github.io/eslint-plugin-markdown-preferences/rules/definitions-last.html
@@ -287,9 +297,15 @@ type MarkdownPreferencesCodeFenceLength = [] | [{
     fallbackLength?: (number | ("minimum" | "as-is"));
   }[];
 }];
+type MarkdownPreferencesCodeFenceSpacing = [] | [{
+  space?: ("always" | "never");
+}];
 type MarkdownPreferencesCodeFenceStyle = [] | [{
   style?: ("backtick" | "tilde");
 }];
+type MarkdownPreferencesCustomContainerMarkerSpacing = [] | [{
+  space?: ("always" | "never");
+}];
 type MarkdownPreferencesDefinitionsLast = [] | [{
   linkDefinitionPlacement?: {
     referencedFromSingleSection?: ("document-last" | "section-last");
@@ -516,7 +532,7 @@ declare namespace meta_d_exports {
   export { name, version };
 }
 declare const name: "eslint-plugin-markdown-preferences";
-declare const version: "0.29.1";
+declare const version: "0.30.0";
 //#endregion
 //#region src/language/ast-types.d.ts
 type Node = mdast.Node;

package/lib/index.js

@@ -1279,6 +1279,62 @@ var code_fence_length_default = createRule("code-fence-length", {
 	}
 });
 
+//#endregion
+//#region src/rules/code-fence-spacing.ts
+var code_fence_spacing_default = createRule("code-fence-spacing", {
+	meta: {
+		type: "layout",
+		docs: {
+			description: "require or disallow spacing between opening code fence and language identifier",
+			categories: [],
+			listCategory: "Whitespace"
+		},
+		fixable: "whitespace",
+		hasSuggestions: false,
+		schema: [{
+			type: "object",
+			properties: { space: { enum: ["always", "never"] } },
+			additionalProperties: false
+		}],
+		messages: {
+			expectedSpace: "Expected a space between code fence and language identifier.",
+			unexpectedSpace: "Unexpected space between code fence and language identifier."
+		}
+	},
+	create(context) {
+		const sourceCode = context.sourceCode;
+		const space = (context.options[0] || {}).space || "never";
+		return { code(node) {
+			const parsed = parseFencedCodeBlock(sourceCode, node);
+			if (!parsed) return;
+			const { openingFence, language: language$2 } = parsed;
+			if (!language$2) return;
+			const hasSpace = openingFence.range[1] < language$2.range[0];
+			if (space === "always") {
+				if (hasSpace) return;
+				context.report({
+					node,
+					loc: getSourceLocationFromRange(sourceCode, node, language$2.range),
+					messageId: "expectedSpace",
+					fix(fixer) {
+						return fixer.insertTextAfterRange(openingFence.range, " ");
+					}
+				});
+			} else if (space === "never") {
+				if (!hasSpace) return;
+				context.report({
+					node,
+					loc: getSourceLocationFromRange(sourceCode, node, [openingFence.range[1], language$2.range[0]]),
+					messageId: "unexpectedSpace",
+					fix(fixer) {
+						return fixer.removeRange([openingFence.range[1], language$2.range[0]]);
+					}
+				});
+			}
+		} };
+	}
+});
+
 //#endregion
 //#region src/rules/code-fence-style.ts
 var code_fence_style_default = createRule("code-fence-style", {
@@ -1327,6 +1383,127 @@ var code_fence_style_default = createRule("code-fence-style", {
 	}
 });
 
+//#endregion
+//#region src/utils/custom-container.ts
+const RE_OPENING_SEQUENCE = /^(:{3,})/u;
+/**
+* Parse the custom container.
+*/
+function parseCustomContainer(sourceCode, node) {
+	const loc = sourceCode.getLoc(node);
+	const range = sourceCode.getRange(node);
+	const text = sourceCode.text.slice(...range);
+	const match = RE_OPENING_SEQUENCE.exec(text);
+	if (!match) return null;
+	const [, sequenceText] = match;
+	const afterOpeningSequence = sourceCode.lines[loc.start.line - 1].slice(loc.start.column - 1 + sequenceText.length);
+	const trimmedAfterOpeningSequence = afterOpeningSequence.trimStart();
+	const spaceAfterOpeningSequenceLength = afterOpeningSequence.length - trimmedAfterOpeningSequence.length;
+	const infoText = trimmedAfterOpeningSequence.trimEnd();
+	if (!infoText) return null;
+	const openingSequenceRange = [range[0], range[0] + sequenceText.length];
+	const openingSequence = {
+		text: sequenceText,
+		range: openingSequenceRange,
+		loc: getSourceLocationFromRange(sourceCode, node, openingSequenceRange)
+	};
+	const infoRange = [openingSequence.range[1] + spaceAfterOpeningSequenceLength, openingSequence.range[1] + spaceAfterOpeningSequenceLength + infoText.length];
+	const info = {
+		text: infoText,
+		range: infoRange,
+		loc: getSourceLocationFromRange(sourceCode, node, infoRange)
+	};
+	const sequenceChar = sequenceText[0];
+	let closingSequenceText = "";
+	const trimmed = text.trimEnd();
+	const trailingSpacesLength = text.length - trimmed.length;
+	for (let index = trimmed.length - 1; index >= 0; index--) {
+		const c = trimmed[index];
+		if (c === sequenceChar || isSpaceOrTab(c)) {
+			closingSequenceText = c + closingSequenceText;
+			continue;
+		}
+		if (c === ">") {
+			closingSequenceText = ` ${closingSequenceText}`;
+			continue;
+		}
+		if (c === "\n") break;
+		closingSequenceText = "";
+		break;
+	}
+	closingSequenceText = closingSequenceText.trimStart();
+	if (!closingSequenceText || !closingSequenceText.startsWith(sequenceText)) return {
+		openingSequence,
+		info,
+		closingSequence: null
+	};
+	const closingSequenceRange = [range[1] - trailingSpacesLength - closingSequenceText.length, range[1] - trailingSpacesLength];
+	return {
+		openingSequence,
+		info,
+		closingSequence: {
+			text: closingSequenceText,
+			range: closingSequenceRange,
+			loc: getSourceLocationFromRange(sourceCode, node, closingSequenceRange)
+		}
+	};
+}
+
+//#endregion
+//#region src/rules/custom-container-marker-spacing.ts
+var custom_container_marker_spacing_default = createRule("custom-container-marker-spacing", {
+	meta: {
+		type: "layout",
+		docs: {
+			description: "require or disallow spacing between opening custom container marker and info",
+			categories: [],
+			listCategory: "Whitespace"
+		},
+		fixable: "whitespace",
+		hasSuggestions: false,
+		schema: [{
+			type: "object",
+			properties: { space: { enum: ["always", "never"] } },
+			additionalProperties: false
+		}],
+		messages: {
+			expectedSpace: "Expected a space between opening custom container marker and info.",
+			unexpectedSpace: "Unexpected space between opening custom container marker and info."
+		}
+	},
+	create(context) {
+		const sourceCode = context.sourceCode;
+		const space = (context.options[0] || {}).space || "always";
+		return { customContainer(node) {
+			const parsed = parseCustomContainer(sourceCode, node);
+			if (!parsed) return;
+			const { openingSequence, info } = parsed;
+			const hasSpace = openingSequence.range[1] < info.range[0];
+			if (space === "always") {
+				if (hasSpace) return;
+				context.report({
+					node,
+					loc: getSourceLocationFromRange(sourceCode, node, info.range),
+					messageId: "expectedSpace",
+					fix(fixer) {
+						return fixer.insertTextAfterRange(openingSequence.range, " ");
+					}
+				});
+			} else if (space === "never") {
+				if (!hasSpace) return;
+				context.report({
+					node,
+					loc: getSourceLocationFromRange(sourceCode, node, [openingSequence.range[1], info.range[0]]),
+					messageId: "unexpectedSpace",
+					fix(fixer) {
+						return fixer.removeRange([openingSequence.range[1], info.range[0]]);
+					}
+				});
+			}
+		} };
+	}
+});
+
 //#endregion
 //#region src/rules/definitions-last.ts
 /**
@@ -7545,72 +7722,6 @@ var list_marker_alignment_default = createRule("list-marker-alignment", {
 	}
 });
 
-//#endregion
-//#region src/utils/custom-container.ts
-const RE_OPENING_SEQUENCE = /^(:{3,})/u;
-/**
-* Parse the custom container.
-*/
-function parseCustomContainer(sourceCode, node) {
-	const loc = sourceCode.getLoc(node);
-	const range = sourceCode.getRange(node);
-	const text = sourceCode.text.slice(...range);
-	const match = RE_OPENING_SEQUENCE.exec(text);
-	if (!match) return null;
-	const [, sequenceText] = match;
-	const afterOpeningSequence = sourceCode.lines[loc.start.line - 1].slice(loc.start.column - 1 + sequenceText.length);
-	const trimmedAfterOpeningSequence = afterOpeningSequence.trimStart();
-	const spaceAfterOpeningSequenceLength = afterOpeningSequence.length - trimmedAfterOpeningSequence.length;
-	const infoText = trimmedAfterOpeningSequence.trimEnd();
-	if (!infoText) return null;
-	const openingSequenceRange = [range[0], range[0] + sequenceText.length];
-	const openingSequence = {
-		text: sequenceText,
-		range: openingSequenceRange,
-		loc: getSourceLocationFromRange(sourceCode, node, openingSequenceRange)
-	};
-	const infoRange = [openingSequence.range[1] + spaceAfterOpeningSequenceLength, openingSequence.range[1] + spaceAfterOpeningSequenceLength + infoText.length];
-	const info = {
-		text: infoText,
-		range: infoRange,
-		loc: getSourceLocationFromRange(sourceCode, node, infoRange)
-	};
-	const sequenceChar = sequenceText[0];
-	let closingSequenceText = "";
-	const trimmed = text.trimEnd();
-	const trailingSpacesLength = text.length - trimmed.length;
-	for (let index = trimmed.length - 1; index >= 0; index--) {
-		const c = trimmed[index];
-		if (c === sequenceChar || isSpaceOrTab(c)) {
-			closingSequenceText = c + closingSequenceText;
-			continue;
-		}
-		if (c === ">") {
-			closingSequenceText = ` ${closingSequenceText}`;
-			continue;
-		}
-		if (c === "\n") break;
-		closingSequenceText = "";
-		break;
-	}
-	closingSequenceText = closingSequenceText.trimStart();
-	if (!closingSequenceText || !closingSequenceText.startsWith(sequenceText)) return {
-		openingSequence,
-		info,
-		closingSequence: null
-	};
-	const closingSequenceRange = [range[1] - trailingSpacesLength - closingSequenceText.length, range[1] - trailingSpacesLength];
-	return {
-		openingSequence,
-		info,
-		closingSequence: {
-			text: closingSequenceText,
-			range: closingSequenceRange,
-			loc: getSourceLocationFromRange(sourceCode, node, closingSequenceRange)
-		}
-	};
-}
-
 //#endregion
 //#region src/rules/no-implicit-block-closing.ts
 var no_implicit_block_closing_default = createRule("no-implicit-block-closing", {
@@ -11543,7 +11654,9 @@ const rules$1 = [
 	bullet_list_marker_style_default,
 	canonical_code_block_language_default,
 	code_fence_length_default,
+	code_fence_spacing_default,
 	code_fence_style_default,
+	custom_container_marker_spacing_default,
 	definitions_last_default,
 	emoji_notation_default,
 	emphasis_delimiters_style_default,
@@ -11688,7 +11801,7 @@ var meta_exports = /* @__PURE__ */ __export({
 	version: () => version
 });
 const name = "eslint-plugin-markdown-preferences";
-const version = "0.29.1";
+const version = "0.30.0";
 
 //#endregion
 //#region src/language/extensions/micromark-custom-container.ts

package/package.json

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