eslint-plugin-yml 3.5.0 → 3.6.0

package/lib/index.mjs

@@ -4599,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;
@@ -4617,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;
@@ -4631,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);
 	};
 }
 /**
@@ -4650,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 = [];
@@ -4671,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 {
@@ -4743,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
 };
@@ -4838,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) {
@@ -4854,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) {
@@ -4927,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);
 		}
@@ -5390,7 +5420,7 @@ var prettier_default = [...base_default, { rules: {
 //#endregion
 //#region package.json
 var name$1 = "eslint-plugin-yml";
-var version$1 = "3.5.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.5.0",
+  "version": "3.6.0",
   "description": "This ESLint plugin provides linting rules for YAML.",
   "type": "module",
   "main": "lib/index.mjs",
@@ -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",