eslint-plugin-yml 3.4.0 → 3.5.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: {
@@ -5088,6 +5181,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 +5363,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 +5383,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.5.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.5.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",