eslint-plugin-yml 3.2.2 → 3.3.1

package/lib/index.d.mts

@@ -2,7 +2,7 @@ import { AST } from "yaml-eslint-parser";
 import { IDirective, TextSourceCodeBase, TraversalStep } from "@eslint/plugin-kit";
 import { CursorWithCountOptionsWithComment, CursorWithCountOptionsWithFilter, CursorWithCountOptionsWithoutFilter, CursorWithSkipOptionsWithComment, CursorWithSkipOptionsWithFilter, CursorWithSkipOptionsWithoutFilter } from "@ota-meshi/ast-token-store";
 import * as _eslint_core0 from "@eslint/core";
-import { File, FileProblem, Language, OkParseResult, RuleDefinition, RulesConfig } from "@eslint/core";
+import { File, FileProblem, Language, OkParseResult, ParseResult, RuleDefinition, RulesConfig } from "@eslint/core";
 import { Linter, Scope } from "eslint";
 
 //#region src/meta.d.ts
@@ -262,6 +262,7 @@ declare class YAMLSourceCode extends TextSourceCodeBase<{
   getCommentsInside(nodeOrToken: YAMLSyntaxElement): AST.Comment[];
   getCommentsBefore(nodeOrToken: YAMLSyntaxElement): AST.Comment[];
   getCommentsAfter(nodeOrToken: YAMLSyntaxElement): AST.Comment[];
+  commentsExistBetween(first: YAMLSyntaxElement, second: YAMLSyntaxElement): boolean;
   isSpaceBetween(first: AST.Token | AST.Comment, second: AST.Token | AST.Comment): boolean;
   /**
    * Compatibility for ESLint's SourceCode API
@@ -282,13 +283,6 @@ declare class YAMLSourceCode extends TextSourceCodeBase<{
 }
 //#endregion
 //#region src/language/yaml-language.d.ts
-/**
- * Parse result
- */
-interface YAMLParseResult {
-  ok: true;
-  ast: AST.YAMLProgram;
-}
 /**
  * Language options for YAML
  */
@@ -332,11 +326,11 @@ declare class YAMLLanguage implements Language<{
    */
   parse(file: File, context: {
     languageOptions?: YAMLLanguageOptions;
-  }): OkParseResult<AST.YAMLProgram> | YAMLParseResult;
+  }): ParseResult<AST.YAMLProgram>;
   /**
    * Creates a new SourceCode object for the given file and parse result.
    */
-  createSourceCode(file: File, parseResult: OkParseResult<AST.YAMLProgram> | YAMLParseResult): YAMLSourceCode;
+  createSourceCode(file: File, parseResult: OkParseResult<AST.YAMLProgram>): YAMLSourceCode;
 }
 //#endregion
 //#region src/index.d.ts

package/lib/index.mjs

@@ -478,7 +478,7 @@ const OPTIONS_ENUM$1 = [
 /**
 * Parse options
 */
-function parseOptions$4(option) {
+function parseOptions$5(option) {
 	const opt = {
 		singleline: "ignore",
 		multiline: "always"
@@ -517,7 +517,7 @@ var block_mapping_default = createRule("block-mapping", {
 	},
 	create(context) {
 		if (!context.sourceCode.parserServices?.isYAML) return {};
-		const options = parseOptions$4(context.options[0]);
+		const options = parseOptions$5(context.options[0]);
 		let styleStack = null;
 		/**
 		* Moves the stack down.
@@ -750,7 +750,7 @@ const OPTIONS_ENUM = [
 /**
 * Parse options
 */
-function parseOptions$3(option) {
+function parseOptions$4(option) {
 	const opt = {
 		singleline: "ignore",
 		multiline: "always"
@@ -790,7 +790,7 @@ var block_sequence_default = createRule("block-sequence", {
 	create(context) {
 		const sourceCode = context.sourceCode;
 		if (!sourceCode.parserServices?.isYAML) return {};
-		const options = parseOptions$3(context.options[0]);
+		const options = parseOptions$4(context.options[0]);
 		let styleStack = null;
 		/**
 		* Moves the stack down.
@@ -1169,6 +1169,50 @@ var flow_mapping_curly_newline_default = createRule("flow-mapping-curly-newline"
 
 //#endregion
 //#region src/rules/flow-mapping-curly-spacing.ts
+/**
+* Parse rule options and return helpers for spacing checks.
+* @param options The options tuple from the rule configuration.
+* @param sourceCode The sourceCode object for node lookup.
+*/
+function parseOptions$3(options, sourceCode) {
+	const spaced = options[0] ?? "never";
+	/**
+	* Determines whether an exception option is set relative to the base spacing.
+	* @param option The option to check.
+	*/
+	function isOptionSet(option) {
+		return options[1] ? options[1][option] === (spaced === "never") : false;
+	}
+	const arraysInObjectsException = isOptionSet("arraysInObjects");
+	const objectsInObjectsException = isOptionSet("objectsInObjects");
+	const emptyObjects = options[1]?.emptyObjects ?? "ignore";
+	/**
+	* Whether the opening brace must be spaced, considering exceptions.
+	* @param spaced The primary spaced option string.
+	* @param second The token after the opening brace.
+	*/
+	function isOpeningCurlyBraceMustBeSpaced(spaced, second) {
+		const targetPenultimateType = arraysInObjectsException && isOpeningBracketToken(second) ? "YAMLSequence" : objectsInObjectsException && isOpeningBraceToken(second) ? "YAMLMapping" : null;
+		const node = sourceCode.getNodeByRangeIndex(second.range[0]);
+		return targetPenultimateType && node?.type === targetPenultimateType ? spaced === "never" : spaced === "always";
+	}
+	/**
+	* Whether the closing brace must be spaced, considering exceptions.
+	* @param spaced The primary spaced option string.
+	* @param penultimate The token before the closing brace.
+	*/
+	function isClosingCurlyBraceMustBeSpaced(spaced, penultimate) {
+		const targetPenultimateType = arraysInObjectsException && isClosingBracketToken(penultimate) ? "YAMLSequence" : objectsInObjectsException && isClosingBraceToken(penultimate) ? "YAMLMapping" : null;
+		const node = sourceCode.getNodeByRangeIndex(penultimate.range[0]);
+		return targetPenultimateType && node?.type === targetPenultimateType ? spaced === "never" : spaced === "always";
+	}
+	return {
+		spaced,
+		emptyObjects,
+		isOpeningCurlyBraceMustBeSpaced,
+		isClosingCurlyBraceMustBeSpaced
+	};
+}
 var flow_mapping_curly_spacing_default = createRule("flow-mapping-curly-spacing", {
 	meta: {
 		docs: {
@@ -1186,7 +1230,15 @@ var flow_mapping_curly_spacing_default = createRule("flow-mapping-curly-spacing"
 			type: "object",
 			properties: {
 				arraysInObjects: { type: "boolean" },
-				objectsInObjects: { type: "boolean" }
+				objectsInObjects: { type: "boolean" },
+				emptyObjects: {
+					type: "string",
+					enum: [
+						"ignore",
+						"always",
+						"never"
+					]
+				}
 			},
 			additionalProperties: false
 		}],
@@ -1194,36 +1246,15 @@ var flow_mapping_curly_spacing_default = createRule("flow-mapping-curly-spacing"
 			requireSpaceBefore: "A space is required before '{{token}}'.",
 			requireSpaceAfter: "A space is required after '{{token}}'.",
 			unexpectedSpaceBefore: "There should be no space before '{{token}}'.",
-			unexpectedSpaceAfter: "There should be no space after '{{token}}'."
+			unexpectedSpaceAfter: "There should be no space after '{{token}}'.",
+			requiredSpaceInEmptyObject: "A space is required in empty flow mapping.",
+			unexpectedSpaceInEmptyObject: "There should be no space in empty flow mapping."
 		}
 	},
 	create(context) {
 		const sourceCode = context.sourceCode;
 		if (!sourceCode.parserServices?.isYAML) return {};
-		const spaced = context.options[0] === "always";
-		/**
-		* Determines whether an option is set, relative to the spacing option.
-		* If spaced is "always", then check whether option is set to false.
-		* If spaced is "never", then check whether option is set to true.
-		* @param option The option to exclude.
-		* @returns Whether or not the property is excluded.
-		*/
-		function isOptionSet(option) {
-			return context.options[1] ? context.options[1][option] === !spaced : false;
-		}
-		const options = {
-			spaced,
-			arraysInObjectsException: isOptionSet("arraysInObjects"),
-			objectsInObjectsException: isOptionSet("objectsInObjects"),
-			isOpeningCurlyBraceMustBeSpaced(second) {
-				const targetPenultimateType = options.arraysInObjectsException && isOpeningBracketToken(second) ? "YAMLSequence" : options.objectsInObjectsException && isOpeningBraceToken(second) ? "YAMLMapping" : null;
-				return targetPenultimateType && sourceCode.getNodeByRangeIndex(second.range[0])?.type === targetPenultimateType ? !options.spaced : options.spaced;
-			},
-			isClosingCurlyBraceMustBeSpaced(penultimate) {
-				const targetPenultimateType = options.arraysInObjectsException && isClosingBracketToken(penultimate) ? "YAMLSequence" : options.objectsInObjectsException && isClosingBraceToken(penultimate) ? "YAMLMapping" : null;
-				return targetPenultimateType && sourceCode.getNodeByRangeIndex(penultimate.range[0])?.type === targetPenultimateType ? !options.spaced : options.spaced;
-			}
-		};
+		const options = parseOptions$3(context.options, sourceCode);
 		/**
 		* Reports that there shouldn't be a space after the first token
 		* @param node The node to report in the event of an error.
@@ -1304,18 +1335,18 @@ var flow_mapping_curly_spacing_default = createRule("flow-mapping-curly-spacing"
 		* @param penultimate The penultimate token to check (should be last before closing brace)
 		* @param last The last token to check (should be closing brace)
 		*/
-		function validateBraceSpacing(node, first, second, penultimate, last) {
-			if (isTokenOnSameLine(first, second)) {
-				const firstSpaced = sourceCode.isSpaceBetween(first, second);
-				if (options.isOpeningCurlyBraceMustBeSpaced(second)) {
-					if (!firstSpaced) reportRequiredBeginningSpace(node, first);
-				} else if (firstSpaced && second.type !== "Line") reportNoBeginningSpace(node, first);
+		function validateBraceSpacing(node, spaced, openingToken, second, penultimate, closingToken) {
+			if (isTokenOnSameLine(openingToken, second)) {
+				const firstSpaced = sourceCode.isSpaceBetween(openingToken, second);
+				if (options.isOpeningCurlyBraceMustBeSpaced(spaced, second)) {
+					if (!firstSpaced) reportRequiredBeginningSpace(node, openingToken);
+				} else if (firstSpaced && second.type !== "Line") reportNoBeginningSpace(node, openingToken);
 			}
-			if (isTokenOnSameLine(penultimate, last)) {
-				const lastSpaced = sourceCode.isSpaceBetween(penultimate, last);
-				if (options.isClosingCurlyBraceMustBeSpaced(penultimate)) {
-					if (!lastSpaced) reportRequiredEndingSpace(node, last);
-				} else if (lastSpaced) reportNoEndingSpace(node, last);
+			if (isTokenOnSameLine(penultimate, closingToken)) {
+				const lastSpaced = sourceCode.isSpaceBetween(penultimate, closingToken);
+				if (options.isClosingCurlyBraceMustBeSpaced(spaced, penultimate)) {
+					if (!lastSpaced) reportRequiredEndingSpace(node, closingToken);
+				} else if (lastSpaced) reportNoEndingSpace(node, closingToken);
 			}
 		}
 		/**
@@ -1337,11 +1368,61 @@ var flow_mapping_curly_spacing_default = createRule("flow-mapping-curly-spacing"
 		* Reports a given object node if spacing in curly braces is invalid.
 		* @param node An ObjectExpression or ObjectPattern node to check.
 		*/
+		function checkSpaceInEmptyObject(node) {
+			if (options.emptyObjects === "ignore") return;
+			const openingToken = sourceCode.getFirstToken(node);
+			const closingToken = sourceCode.getLastToken(node);
+			const second = sourceCode.getTokenAfter(openingToken, { includeComments: true });
+			if (second !== closingToken && isCommentToken(second)) {
+				const penultimate = sourceCode.getTokenBefore(closingToken, { includeComments: true });
+				validateBraceSpacing(node, options.emptyObjects, openingToken, second, penultimate, closingToken);
+				return;
+			}
+			if (!isTokenOnSameLine(openingToken, closingToken)) return;
+			const sourceBetween = sourceCode.text.slice(openingToken.range[1], closingToken.range[0]);
+			if (sourceBetween.trim() !== "") return;
+			if (options.emptyObjects === "always") {
+				if (sourceBetween) return;
+				context.report({
+					node,
+					loc: {
+						start: openingToken.loc.end,
+						end: closingToken.loc.start
+					},
+					messageId: "requiredSpaceInEmptyObject",
+					fix(fixer) {
+						return fixer.replaceTextRange([openingToken.range[1], closingToken.range[0]], " ");
+					}
+				});
+			} else if (options.emptyObjects === "never") {
+				if (!sourceBetween) return;
+				context.report({
+					node,
+					loc: {
+						start: openingToken.loc.end,
+						end: closingToken.loc.start
+					},
+					messageId: "unexpectedSpaceInEmptyObject",
+					fix(fixer) {
+						return fixer.removeRange([openingToken.range[1], closingToken.range[0]]);
+					}
+				});
+			}
+		}
+		/**
+		* Reports a given mapping node if spacing in curly braces is invalid.
+		* @param node A YAMLMapping node to check.
+		*/
 		function checkForObject(node) {
-			if (node.pairs.length === 0) return;
-			const first = sourceCode.getFirstToken(node);
-			const last = getClosingBraceOfObject(node);
-			validateBraceSpacing(node, first, sourceCode.getTokenAfter(first, { includeComments: true }), sourceCode.getTokenBefore(last, { includeComments: true }), last);
+			if (node.pairs.length === 0) {
+				checkSpaceInEmptyObject(node);
+				return;
+			}
+			const openingToken = sourceCode.getFirstToken(node);
+			const closingToken = getClosingBraceOfObject(node);
+			const second = sourceCode.getTokenAfter(openingToken, { includeComments: true });
+			const penultimate = sourceCode.getTokenBefore(closingToken, { includeComments: true });
+			validateBraceSpacing(node, options.spaced, openingToken, second, penultimate, closingToken);
 		}
 		return { YAMLMapping(node) {
 			if (node.style === "flow") checkForObject(node);
@@ -5255,7 +5336,7 @@ var prettier_default = [...base_default, { rules: {
 //#endregion
 //#region package.json
 var name$1 = "eslint-plugin-yml";
-var version$1 = "3.2.2";
+var version$1 = "3.3.1";
 
 //#endregion
 //#region src/meta.ts
@@ -5493,6 +5574,9 @@ var YAMLSourceCode = class extends TextSourceCodeBase {
 	getCommentsAfter(nodeOrToken) {
 		return this.tokenStore.getCommentsAfter(nodeOrToken);
 	}
+	commentsExistBetween(first, second) {
+		return this.tokenStore.commentsExistBetween(first, second);
+	}
 	isSpaceBetween(first, second) {
 		const [left, right] = first.range[1] <= second.range[0] ? [first, second] : [second, first];
 		return this.tokenStore.isSpaceBetween(left, right);
@@ -5610,13 +5694,26 @@ var YAMLLanguage = class {
 	*/
 	parse(file, context) {
 		const text = file.body;
-		return {
-			ok: true,
-			ast: parseYAML(text, {
-				filePath: file.path,
-				defaultYAMLVersion: context.languageOptions?.parserOptions?.defaultYAMLVersion
-			})
-		};
+		try {
+			return {
+				ok: true,
+				ast: parseYAML(text, {
+					filePath: file.path,
+					defaultYAMLVersion: context.languageOptions?.parserOptions?.defaultYAMLVersion
+				})
+			};
+		} catch (error) {
+			const message = error instanceof Error ? error.message : String(error);
+			const parseError = error;
+			return {
+				ok: false,
+				errors: [{
+					message,
+					line: parseError.lineNumber ?? 1,
+					column: parseError.column ?? 1
+				}]
+			};
+		}
 	}
 	/**
 	* Creates a new SourceCode object for the given file and parse result.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eslint-plugin-yml",
-  "version": "3.2.2",
+  "version": "3.3.1",
   "description": "This ESLint plugin provides linting rules for YAML.",
   "type": "module",
   "main": "lib/index.mjs",
@@ -77,7 +77,7 @@
     "eslint": ">=9.38.0"
   },
   "devDependencies": {
-    "@changesets/changelog-github": "^0.5.0",
+    "@changesets/changelog-github": "^0.6.0",
     "@changesets/cli": "^2.24.2",
     "@eslint-community/eslint-plugin-eslint-comments": "^4.3.0",
     "@eslint/eslintrc": "^3.1.0",
@@ -112,7 +112,7 @@
     "events": "^3.3.0",
     "mocha": "^11.0.0",
     "monaco-editor": "^0.55.0",
-    "nyc": "^17.0.0",
+    "nyc": "^18.0.0",
     "pako": "^2.1.0",
     "prettier": "^3.0.3",
     "semver": "^7.3.2",
@@ -125,7 +125,7 @@
     "tsx": "^4.21.0",
     "typescript": "~5.9.0",
     "typescript-eslint": "^8.0.0",
-    "vite-plugin-eslint4b": "^0.6.0",
+    "vite-plugin-eslint4b": "^0.7.0",
     "vitepress": "^1.0.0-rc.17",
     "vue-eslint-parser": "^10.0.0",
     "yaml": "^2.1.1"