eslint-plugin-yml 3.4.0 → 3.6.0

package/README.md

@@ -257,6 +257,7 @@ The rules with the following star :star: are included in the config.
 | [yml/key-spacing](https://ota-meshi.github.io/eslint-plugin-yml/rules/key-spacing.html) | enforce consistent spacing between keys and values in mapping pairs | :wrench: |  | :star: |
 | [yml/no-irregular-whitespace](https://ota-meshi.github.io/eslint-plugin-yml/rules/no-irregular-whitespace.html) | disallow irregular whitespace |  | :star: | :star: |
 | [yml/no-multiple-empty-lines](https://ota-meshi.github.io/eslint-plugin-yml/rules/no-multiple-empty-lines.html) | disallow multiple empty lines | :wrench: |  | :star: |
+| [yml/no-trailing-spaces](https://ota-meshi.github.io/eslint-plugin-yml/rules/no-trailing-spaces.html) | disallow trailing whitespace at the end of lines | :wrench: |  | :star: |
 | [yml/spaced-comment](https://ota-meshi.github.io/eslint-plugin-yml/rules/spaced-comment.html) | enforce consistent spacing after the `#` in a comment | :wrench: |  | :star: |
 
 <!--RULES_TABLE_END-->

package/lib/index.mjs

@@ -3376,6 +3376,99 @@ var no_tab_indent_default = createRule("no-tab-indent", {
 	}
 });
 //#endregion
+//#region src/rules/no-trailing-spaces.ts
+const BLANK_CLASS = "[\\t \\u00a0\\u2000\\u2001\\u2002\\u2003\\u2004\\u2005\\u2006\\u2007\\u2008\\u2009\\u200a\\u200b\\u3000]";
+const TRAILING_SPACES = new RegExp(`${BLANK_CLASS}+$`, "u");
+const BLANK_LINE = new RegExp(`^${BLANK_CLASS}*$`, "u");
+/** Check whether a reported whitespace range is fully inside a known range. */
+function isInRange(rangeStart, rangeEnd, range) {
+	return range[0] <= rangeStart && rangeEnd <= range[1];
+}
+var no_trailing_spaces_default = createRule("no-trailing-spaces", {
+	meta: {
+		docs: {
+			description: "disallow trailing whitespace at the end of lines",
+			categories: ["standard"],
+			extensionRule: "no-trailing-spaces",
+			layout: true
+		},
+		fixable: "whitespace",
+		schema: [{
+			type: "object",
+			properties: {
+				skipBlankLines: {
+					type: "boolean",
+					default: false
+				},
+				ignoreComments: {
+					type: "boolean",
+					default: false
+				}
+			},
+			additionalProperties: false
+		}],
+		messages: { trailingSpace: "Trailing spaces not allowed." },
+		type: "layout"
+	},
+	create(context) {
+		const sourceCode = context.sourceCode;
+		if (!sourceCode.parserServices?.isYAML) return {};
+		const options = context.options[0] || {};
+		const skipBlankLines = Boolean(options.skipBlankLines);
+		const ignoreComments = Boolean(options.ignoreComments);
+		const scalarRanges = [];
+		/** Check ranges that should not be reported or fixed. */
+		function isIgnoredRange(lineNumber, rangeStart, rangeEnd) {
+			if (ignoreComments && sourceCode.getAllComments().some((comment) => isInRange(rangeStart, rangeEnd, comment.range))) return true;
+			return scalarRanges.some((scalar) => lineNumber > scalar.startLine && isInRange(rangeStart, rangeEnd, scalar.range));
+		}
+		return {
+			YAMLScalar(node) {
+				if (node.loc.start.line < node.loc.end.line) scalarRanges.push({
+					range: node.range,
+					startLine: node.loc.start.line
+				});
+			},
+			"Program:exit"() {
+				for (let lineIndex = 0; lineIndex < sourceCode.lines.length; lineIndex++) {
+					const line = sourceCode.lines[lineIndex];
+					const match = TRAILING_SPACES.exec(line);
+					if (!match) continue;
+					if (skipBlankLines && BLANK_LINE.test(line)) continue;
+					const lineNumber = lineIndex + 1;
+					const startColumn = match.index;
+					const endColumn = line.length;
+					const rangeStart = sourceCode.getIndexFromLoc({
+						line: lineNumber,
+						column: startColumn
+					});
+					const rangeEnd = sourceCode.getIndexFromLoc({
+						line: lineNumber,
+						column: endColumn
+					});
+					if (isIgnoredRange(lineNumber, rangeStart, rangeEnd)) continue;
+					context.report({
+						loc: {
+							start: {
+								line: lineNumber,
+								column: startColumn
+							},
+							end: {
+								line: lineNumber,
+								column: endColumn
+							}
+						},
+						messageId: "trailingSpace",
+						fix(fixer) {
+							return fixer.removeRange([rangeStart, rangeEnd]);
+						}
+					});
+				}
+			}
+		};
+	}
+});
+//#endregion
 //#region src/rules/no-trailing-zeros.ts
 var no_trailing_zeros_default = createRule("no-trailing-zeros", {
 	meta: {
@@ -4506,6 +4599,10 @@ var YAMLEntryData = class {
 	get value() {
 		return (this.cached ?? (this.cached = { value: this.node == null ? null : getStaticYAMLValue(this.node) })).value;
 	}
+	getValueForKey(key) {
+		const val = this.value;
+		if (val !== null && typeof val === "object" && !Array.isArray(val)) return val[key];
+	}
 };
 var YAMLSequenceData = class {
 	node;
@@ -4524,7 +4621,7 @@ var YAMLSequenceData = class {
 /**
 * Build function which check that the given 2 names are in specific order.
 */
-function buildValidatorFromType(order, insensitive, natural) {
+function buildValidatorFromType(order, insensitive, natural, key) {
 	let compareValue = ([a, b]) => a <= b;
 	let compareText = compareValue;
 	if (natural) compareText = ([a, b]) => naturalCompare(a, b) <= 0;
@@ -4538,11 +4635,23 @@ function buildValidatorFromType(order, insensitive, natural) {
 		const baseCompareValue = compareValue;
 		compareValue = (args) => baseCompareValue(args.reverse());
 	}
-	return (a, b) => {
-		if (typeof a.value === "string" && typeof b.value === "string") return compareText([a.value, b.value]);
-		const type = getYAMLPrimitiveType(a.value);
-		if (type && type === getYAMLPrimitiveType(b.value)) return compareValue([a.value, b.value]);
+	/**
+	* Compare resolved sequence entry values.
+	*/
+	function compare(aVal, bVal) {
+		if (typeof aVal === "string" && typeof bVal === "string") return compareText([aVal, bVal]);
+		const type = getYAMLPrimitiveType(aVal);
+		if (type && type === getYAMLPrimitiveType(bVal)) return compareValue([aVal, bVal]);
 		return true;
+	}
+	return (a, b) => {
+		if (key) {
+			const aVal = a.getValueForKey(key);
+			const bVal = b.getValueForKey(key);
+			if (aVal === void 0 || bVal === void 0) return true;
+			return compare(aVal, bVal);
+		}
+		return compare(a.value, b.value);
 	};
 }
 /**
@@ -4557,14 +4666,16 @@ function parseOptions(options, sourceCode) {
 			const type = order.type ?? "asc";
 			const insensitive = order.caseSensitive === false;
 			const natural = Boolean(order.natural);
+			const key = order.key;
 			return {
 				isTargetArray,
-				ignore: () => false,
-				isValidOrder: buildValidatorFromType(type, insensitive, natural),
+				ignore: key ? (v) => v.getValueForKey(key) === void 0 : () => false,
+				isValidOrder: buildValidatorFromType(type, insensitive, natural, key),
 				orderText(data) {
-					if (typeof data.value === "string") return `${natural ? "natural " : ""}${insensitive ? "insensitive " : ""}${type}ending`;
-					return `${type}ending`;
-				}
+					const base = typeof data.value === "string" || key ? `${natural ? "natural " : ""}${insensitive ? "insensitive " : ""}${type}ending` : `${type}ending`;
+					return key ? `${base} by '${key}'` : base;
+				},
+				key
 			};
 		}
 		const parsedOrder = [];
@@ -4578,9 +4689,16 @@ function parseOptions(options, sourceCode) {
 			const type = nestOrder.type ?? "asc";
 			const insensitive = nestOrder.caseSensitive === false;
 			const natural = Boolean(nestOrder.natural);
+			const itemKey = nestOrder.key;
 			parsedOrder.push({
-				test: (v) => valuePattern ? Boolean(getYAMLPrimitiveType(v.value)) && valuePattern.test(String(v.value)) : true,
-				isValidNestOrder: buildValidatorFromType(type, insensitive, natural)
+				test: (v) => {
+					if (itemKey) {
+						const keyVal = v.getValueForKey(itemKey);
+						return valuePattern ? keyVal !== void 0 && valuePattern.test(String(keyVal)) : keyVal !== void 0;
+					}
+					return valuePattern ? Boolean(getYAMLPrimitiveType(v.value)) && valuePattern.test(String(v.value)) : true;
+				},
+				isValidNestOrder: buildValidatorFromType(type, insensitive, natural, itemKey)
 			});
 		}
 		return {
@@ -4650,7 +4768,8 @@ const ORDER_OBJECT_SCHEMA = {
 	properties: {
 		type: { enum: ["asc", "desc"] },
 		caseSensitive: { type: "boolean" },
-		natural: { type: "boolean" }
+		natural: { type: "boolean" },
+		key: { type: "string" }
 	},
 	additionalProperties: false
 };
@@ -4745,8 +4864,8 @@ var sort_sequence_values_default = createRule("sort-sequence-values", {
 						loc: edit.a.reportLoc,
 						messageId: "shouldBeAfter",
 						data: {
-							thisValue: toText(edit.a),
-							targetValue: toText(target),
+							thisValue: toText(edit.a, option.key),
+							targetValue: toText(target, option.key),
 							orderText: option.orderText(edit.a)
 						},
 						*fix(fixer) {
@@ -4761,8 +4880,8 @@ var sort_sequence_values_default = createRule("sort-sequence-values", {
 						loc: edit.a.reportLoc,
 						messageId: "shouldBeBefore",
 						data: {
-							thisValue: toText(edit.a),
-							targetValue: toText(target),
+							thisValue: toText(edit.a, option.key),
+							targetValue: toText(target, option.key),
 							orderText: option.orderText(edit.a)
 						},
 						*fix(fixer) {
@@ -4834,7 +4953,11 @@ var sort_sequence_values_default = createRule("sort-sequence-values", {
 		/**
 		* Convert to display text.
 		*/
-		function toText(data) {
+		function toText(data, key) {
+			if (key) {
+				const keyVal = data.getValueForKey(key);
+				if (keyVal !== void 0) return String(keyVal);
+			}
 			if (getYAMLPrimitiveType(data.value)) return String(data.value);
 			return sourceCode.getText(data.node);
 		}
@@ -5088,6 +5211,7 @@ const rules$1 = [
 	no_irregular_whitespace_default,
 	no_multiple_empty_lines_default,
 	no_tab_indent_default,
+	no_trailing_spaces_default,
 	no_trailing_zeros_default,
 	plain_scalar_default,
 	quotes_default,
@@ -5269,6 +5393,7 @@ var standard_default = [...base_default, { rules: {
 	"yml/no-irregular-whitespace": "error",
 	"yml/no-multiple-empty-lines": "error",
 	"yml/no-tab-indent": "error",
+	"yml/no-trailing-spaces": "error",
 	"yml/no-trailing-zeros": "error",
 	"yml/plain-scalar": "error",
 	"yml/quotes": "error",
@@ -5288,13 +5413,14 @@ var prettier_default = [...base_default, { rules: {
 	"yml/indent": "off",
 	"yml/key-spacing": "off",
 	"yml/no-multiple-empty-lines": "off",
+	"yml/no-trailing-spaces": "off",
 	"yml/no-trailing-zeros": "off",
 	"yml/quotes": "off"
 } }];
 //#endregion
 //#region package.json
 var name$1 = "eslint-plugin-yml";
-var version$1 = "3.4.0";
+var version$1 = "3.6.0";
 //#endregion
 //#region src/meta.ts
 var meta_exports = /* @__PURE__ */ __exportAll({

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eslint-plugin-yml",
-  "version": "3.4.0",
+  "version": "3.6.0",
   "description": "This ESLint plugin provides linting rules for YAML.",
   "type": "module",
   "main": "lib/index.mjs",
@@ -89,8 +89,8 @@
     "@types/natural-compare": "^1.4.0",
     "@types/node": "^24.0.0",
     "@types/semver": "^7.3.1",
-    "@typescript-eslint/eslint-plugin": "~8.60.0",
-    "@typescript-eslint/parser": "~8.60.0",
+    "@typescript-eslint/eslint-plugin": "~8.62.0",
+    "@typescript-eslint/parser": "~8.62.0",
     "cross-env": "^10.0.0",
     "env-cmd": "^11.0.0",
     "eslint": "^10.0.0",
@@ -111,7 +111,7 @@
     "mocha": "^11.0.0",
     "monaco-editor": "^0.55.0",
     "nyc": "^18.0.0",
-    "pako": "^2.1.0",
+    "pako": "^3.0.0",
     "prettier": "^3.0.3",
     "semver": "^7.3.2",
     "stylelint": "^17.0.0",