@effected/yaml 0.10.0 → 0.12.0

package/internal/rules/document-start.js

@@ -1,5 +1,5 @@
 import { YamlEdit } from "../../YamlEdit.js";
-import { YamlLintDiagnostic, YamlLintSeverity } from "../../YamlLintRule.js";
+import { StyleVote, YamlLintDiagnostic, YamlLintSeverity } from "../../YamlLintRule.js";
 import { Schema } from "effect";
 
 //#region src/internal/rules/document-start.ts
@@ -15,13 +15,17 @@ const TRIVIA = /* @__PURE__ */ new Set([
 	"byte-order-mark",
 	"directive"
 ]);
+/** True when the stream carries `%YAML`/`%TAG` directives — which REQUIRE `---`. */
+const hasDirectives = (ctx) => ctx.tokens.some((t) => t.kind === "directive");
+/** The first non-trivia token: it decides whether the stream is headed by `---`. */
+const headToken = (ctx) => ctx.tokens.find((t) => !TRIVIA.has(t.kind));
 /** The `---` marker at the head of the stream. */
 const documentStart = {
 	id: "document-start",
 	check: (ctx, options) => {
 		const present = options?.present ?? true;
-		const hasDirectives = ctx.tokens.some((t) => t.kind === "directive");
-		const first = ctx.tokens.find((t) => !TRIVIA.has(t.kind));
+		const directives = hasDirectives(ctx);
+		const first = headToken(ctx);
 		const headed = first?.kind === "document-start";
 		if (present && !headed && ctx.text.trim() !== "") return [new YamlLintDiagnostic({
 			rule: "document-start",
@@ -31,7 +35,7 @@ const documentStart = {
 			length: 0,
 			line: 0,
 			character: 0,
-			...hasDirectives ? {} : { fix: YamlEdit.make({
+			...directives ? {} : { fix: YamlEdit.make({
 				offset: 0,
 				length: 0,
 				content: "---\n"
@@ -39,7 +43,7 @@ const documentStart = {
 		})];
 		if (!present && headed && first !== void 0) {
 			const lineText = ctx.lines[first.line]?.text ?? "";
-			const alone = !hasDirectives && lineText.trim() === "---";
+			const alone = !directives && lineText.trim() === "---";
 			const terminator = ctx.text.startsWith("\r\n", first.offset + first.length) ? 2 : 1;
 			return [new YamlLintDiagnostic({
 				rule: "document-start",
@@ -57,6 +61,28 @@ const documentStart = {
 			})];
 		}
 		return [];
+	},
+	infer: (ctx) => {
+		if (ctx.text.trim() === "") return [];
+		const first = headToken(ctx);
+		if (first === void 0) return [];
+		const headed = first.kind === "document-start";
+		if (!headed && hasDirectives(ctx)) return [];
+		return [StyleVote.make(headed ? {
+			dimension: "present",
+			value: true,
+			offset: first.offset,
+			length: first.length,
+			line: first.line,
+			character: first.character
+		} : {
+			dimension: "present",
+			value: false,
+			offset: 0,
+			length: 0,
+			line: 0,
+			character: 0
+		})];
 	}
 };
 

package/internal/rules/empty-lines.js

@@ -1,5 +1,5 @@
 import { YamlEdit } from "../../YamlEdit.js";
-import { YamlLintDiagnostic, YamlLintSeverity } from "../../YamlLintRule.js";
+import { StyleFloor, YamlLintDiagnostic, YamlLintSeverity } from "../../YamlLintRule.js";
 import { insideScalarSpan, nonNegativeIntegerOption } from "./util.js";
 import { Schema } from "effect";
 
@@ -63,6 +63,26 @@ const emptyLines = {
 			i = end;
 		}
 		return out;
+	},
+	infer: (ctx) => {
+		let longest = 0;
+		const lines = ctx.lines;
+		let i = 0;
+		while (i < lines.length) {
+			const line = lines[i];
+			if (line === void 0 || line.text !== "" || insideScalarSpan(ctx.tokens, line.offset)) {
+				i++;
+				continue;
+			}
+			let end = i;
+			while (end < lines.length && (lines[end]?.text ?? "x") === "") end++;
+			if (i !== 0 && end !== lines.length && end - i > longest) longest = end - i;
+			i = end;
+		}
+		return longest > 0 ? [StyleFloor.make({
+			dimension: "max",
+			value: longest
+		})] : [];
 	}
 };
 

package/internal/rules/indentation.js

@@ -1,4 +1,4 @@
-import { YamlLintDiagnostic, YamlLintSeverity } from "../../YamlLintRule.js";
+import { StyleVote, YamlLintDiagnostic, YamlLintSeverity } from "../../YamlLintRule.js";
 import { coveringToken, isScalarContinuationLine, nonNegativeIntegerOption } from "./util.js";
 import { Schema } from "effect";
 
@@ -30,6 +30,44 @@ const flowDepthAtLineStarts = (ctx) => {
 	}
 	return depths;
 };
+/**
+* The content lines block structure speaks about — shared by the check and
+* the inference hook so the two read the same lines. Skips blanks, comment
+* lines, directives, tab-indented lines (the parser's error), lines inside
+* flow collections, scalar continuations and document markers.
+*/
+const contentLines = (ctx) => {
+	const flowDepths = flowDepthAtLineStarts(ctx);
+	const content = [];
+	for (const line of ctx.lines) {
+		const indent = line.text.length - line.text.trimStart().length;
+		const firstChar = line.text[indent];
+		if (firstChar === void 0) continue;
+		if (firstChar === "#") continue;
+		if (firstChar === "%") continue;
+		if (line.text.slice(0, indent).includes("	")) continue;
+		if ((flowDepths[line.number] ?? 0) > 0) continue;
+		if (isScalarContinuationLine(ctx.tokens, line.offset, line.offset + indent)) continue;
+		if (line.text.slice(indent).startsWith("---") || line.text.slice(indent).startsWith("...")) continue;
+		content.push({
+			line,
+			indent,
+			firstChar
+		});
+	}
+	return content;
+};
+/**
+* True when consecutive content lines `prev` → `curr` are a mapping key
+* followed by a sequence entry — the pair the `indentSequences` policy is
+* about. Shared by the check and the inference hook.
+*/
+const isKeyThenSeqEntry = (ctx, prev, curr, unit) => {
+	if (curr.firstChar !== "-") return false;
+	if (coveringToken(ctx.tokens, curr.line.offset + curr.indent)?.kind !== "block-seq-entry") return false;
+	if (!prev.line.text.replace(/ #.*$/, "").trimEnd().endsWith(":")) return false;
+	return curr.indent === prev.indent || curr.indent === prev.indent + (unit ?? curr.indent - prev.indent);
+};
 /** Block-structure indent style. */
 const indentation = {
 	id: "indentation",
@@ -38,24 +76,7 @@ const indentation = {
 		const spacesOpt = opts.spaces ?? "consistent";
 		const seqOpt = opts.indentSequences ?? "consistent";
 		const out = [];
-		const flowDepths = flowDepthAtLineStarts(ctx);
-		const content = [];
-		for (const line of ctx.lines) {
-			const indent = line.text.length - line.text.trimStart().length;
-			const firstChar = line.text[indent];
-			if (firstChar === void 0) continue;
-			if (firstChar === "#") continue;
-			if (firstChar === "%") continue;
-			if (line.text.slice(0, indent).includes("	")) continue;
-			if ((flowDepths[line.number] ?? 0) > 0) continue;
-			if (isScalarContinuationLine(ctx.tokens, line.offset, line.offset + indent)) continue;
-			if (line.text.slice(indent).startsWith("---") || line.text.slice(indent).startsWith("...")) continue;
-			content.push({
-				line,
-				indent,
-				firstChar
-			});
-		}
+		const content = contentLines(ctx);
 		let unit = typeof spacesOpt === "number" ? spacesOpt : void 0;
 		const stack = [0];
 		for (const { line, indent } of content) {
@@ -79,10 +100,7 @@ const indentation = {
 		for (let i = 1; i < content.length; i++) {
 			const prev = content[i - 1];
 			const curr = content[i];
-			if (curr.firstChar !== "-") continue;
-			if (coveringToken(ctx.tokens, curr.line.offset + curr.indent)?.kind !== "block-seq-entry") continue;
-			if (!prev.line.text.replace(/ #.*$/, "").trimEnd().endsWith(":")) continue;
-			if (curr.indent !== prev.indent && curr.indent !== prev.indent + (unit ?? curr.indent - prev.indent)) continue;
+			if (!isKeyThenSeqEntry(ctx, prev, curr, unit)) continue;
 			const indented = curr.indent > prev.indent;
 			if (seqIndented === void 0) seqIndented = indented;
 			else if (indented !== seqIndented) out.push(new YamlLintDiagnostic({
@@ -96,6 +114,41 @@ const indentation = {
 			}));
 		}
 		return out;
+	},
+	infer: (ctx) => {
+		const out = [];
+		const content = contentLines(ctx);
+		let unit;
+		const stack = [0];
+		for (const { line, indent } of content) {
+			const top = stack[stack.length - 1];
+			if (indent > top) {
+				out.push(StyleVote.make({
+					dimension: "spaces",
+					value: indent - top,
+					offset: line.offset,
+					length: indent,
+					line: line.number,
+					character: 0
+				}));
+				if (unit === void 0) unit = indent - top;
+				stack.push(indent);
+			} else if (indent < top) while (stack.length > 1 && stack[stack.length - 1] > indent) stack.pop();
+		}
+		for (let i = 1; i < content.length; i++) {
+			const prev = content[i - 1];
+			const curr = content[i];
+			if (!isKeyThenSeqEntry(ctx, prev, curr, unit)) continue;
+			out.push(StyleVote.make({
+				dimension: "indentSequences",
+				value: curr.indent > prev.indent,
+				offset: curr.line.offset,
+				length: curr.indent,
+				line: curr.line.number,
+				character: 0
+			}));
+		}
+		return out;
 	}
 };
 

package/internal/rules/line-length.js

@@ -1,4 +1,4 @@
-import { YamlLintDiagnostic, YamlLintSeverity } from "../../YamlLintRule.js";
+import { StyleFloor, YamlLintDiagnostic, YamlLintSeverity } from "../../YamlLintRule.js";
 import { nonNegativeIntegerOption } from "./util.js";
 import { Schema } from "effect";
 
@@ -29,6 +29,14 @@ const lineLength = {
 			character: max
 		}));
 		return out;
+	},
+	infer: (ctx) => {
+		let longest = 0;
+		for (const line of ctx.lines) if (line.text.length > longest) longest = line.text.length;
+		return longest > 0 ? [StyleFloor.make({
+			dimension: "max",
+			value: longest
+		})] : [];
 	}
 };
 

package/internal/rules/quoted-strings.js

@@ -1,5 +1,6 @@
 import { YamlEdit } from "../../YamlEdit.js";
-import { YamlLintDiagnostic, YamlLintSeverity } from "../../YamlLintRule.js";
+import { requoteScalarText } from "../requote.js";
+import { StyleVote, YamlLintDiagnostic, YamlLintSeverity } from "../../YamlLintRule.js";
 import { positionAt, walkScalars } from "./util.js";
 import { Schema } from "effect";
 
@@ -14,20 +15,19 @@ const quotedStringsOptions = Schema.Struct({
 	quoteType: Schema.optionalKey(Schema.Literals(["single", "double"])),
 	required: Schema.optionalKey(Schema.Boolean)
 });
-/** A value-preserving requote/wrap edit, or undefined when none is safe. */
+/**
+* A value-preserving requote/wrap edit, or undefined when none is safe.
+* Delegates to the shared helper's CONSERVATIVE mode (#347) — the shipped
+* fix behavior stays exactly as released; the escaping-capable mode belongs
+* to the format path's opt-in `requoteScalars`, not the lint fix.
+*/
 const safeQuoteFix = (ctx, scalar, quote) => {
-	if (scalar.tag !== void 0 || scalar.anchor !== void 0) return void 0;
-	if (typeof scalar.value !== "string") return void 0;
-	const raw = ctx.text.slice(scalar.offset, scalar.offset + scalar.length);
-	if (raw.includes("\n")) return void 0;
-	const inner = scalar.style === "plain" ? raw : raw.slice(1, -1);
-	if (inner !== scalar.value) return void 0;
-	if (inner.includes(quote)) return void 0;
-	if (quote === "\"" && inner.includes("\\")) return void 0;
+	const content = requoteScalarText(ctx.text, scalar, quote, "conservative");
+	if (content === void 0) return void 0;
 	return YamlEdit.make({
 		offset: scalar.offset,
 		length: scalar.length,
-		content: `${quote}${inner}${quote}`
+		content
 	});
 };
 /** Quote-style policy for string value scalars. */
@@ -74,6 +74,24 @@ const quotedStrings = {
 			}
 		});
 		return out;
+	},
+	infer: (ctx) => {
+		const out = [];
+		walkScalars(ctx.document.contents, "root", (scalar, role) => {
+			if (role === "key") return;
+			if (typeof scalar.value !== "string") return;
+			if (scalar.style !== "single-quoted" && scalar.style !== "double-quoted") return;
+			const pos = positionAt(ctx.lines, scalar.offset);
+			out.push(StyleVote.make({
+				dimension: "quoteType",
+				value: scalar.style === "single-quoted" ? "single" : "double",
+				offset: scalar.offset,
+				length: scalar.length,
+				line: pos.line,
+				character: pos.character
+			}));
+		});
+		return out;
 	}
 };
 

package/internal/stringifier.js

@@ -105,6 +105,23 @@ function wouldBeResolved(s) {
 	if (FLOAT_RE.test(s)) return true;
 	return false;
 }
+const BOOL_11_RE = /^(?:y|Y|yes|Yes|YES|n|N|no|No|NO|true|True|TRUE|false|False|FALSE|on|On|ON|off|Off|OFF)$/;
+const INT_11_RE = /^[-+]?(?:0b[0-1_]+|0o?[0-7_]+|[0-9][0-9_]*|0x[0-9a-fA-F_]+|[1-9][0-9_]*(?::[0-5]?[0-9])+)$/;
+const FLOAT_11_RE = /^[-+]?(?:[0-9][0-9_]*(?:\.[0-9_]*(?:[eE][-+]?[0-9]+)?|[eE][-+]?[0-9]+)|\.[0-9_]+(?:[eE][-+]?[0-9]+)?|[0-9][0-9_]*(?::[0-5]?[0-9])+\.[0-9_]*)$/;
+const TIMESTAMP_11_RE = /^[0-9][0-9][0-9][0-9]-[0-9][0-9]?-[0-9][0-9]?(?:(?:[Tt]|[ \t]+)[0-9][0-9]?:[0-9][0-9]:[0-9][0-9](?:\.[0-9]*)?(?:[ \t]*(?:Z|[-+][0-9][0-9]?(?::?[0-9][0-9])?))?)?$/;
+/**
+* Returns true if a string value would be resolved as a non-string type by a
+* YAML 1.1 parser. The delta over {@link wouldBeResolved}: null spellings are
+* identical in both editions (and already covered), so only the boolean,
+* integer, float and timestamp families are tested here.
+*/
+function wouldBeResolved11(s) {
+	if (BOOL_11_RE.test(s)) return true;
+	if (INT_11_RE.test(s)) return true;
+	if (FLOAT_11_RE.test(s)) return true;
+	if (TIMESTAMP_11_RE.test(s)) return true;
+	return false;
+}
 /**
 * Returns true if a string requires quoting to be safely represented as a plain scalar.
 *
@@ -112,11 +129,16 @@ function wouldBeResolved(s) {
 * embedded newlines, leading indicator characters or whitespace, and inline
 * comment/mapping-value patterns (`: `, ` #`). This is the single gate that
 * decides whether a plain scalar is safe or must be wrapped in quotes.
+*
+* `quoteCompat` is strictly additive: `"yaml-1.1"` additionally quotes
+* strings a YAML 1.1 parser would coerce ({@link wouldBeResolved11}) and can
+* never un-quote anything the 1.2 rules require quoted.
 */
-function requiresQuoting(s, ignoreType = false) {
+function requiresQuoting(s, ignoreType = false, quoteCompat) {
 	if (s === "") return true;
 	if (s.includes("\n")) return true;
 	if (!ignoreType && wouldBeResolved(s)) return true;
+	if (!ignoreType && quoteCompat === "yaml-1.1" && wouldBeResolved11(s)) return true;
 	const first = s[0];
 	if (first === " " || first === "	") return true;
 	if (first !== void 0 && INDICATOR_CHARS.has(first)) {
@@ -197,7 +219,7 @@ function renderSingleQuoted(s) {
 * Block literal and block folded styles are always accepted for single-line
 * strings even though the output is unusual.
 */
-function renderString(s, style, indent, ignoreType = false, canonical = false, explicitChomp, parentPosition, quoteStyle = "single", explicitIndent) {
+function renderString(s, style, indent, ignoreType = false, canonical = false, explicitChomp, parentPosition, quoteStyle = "single", explicitIndent, quoteCompat) {
 	const fidelity = !canonical;
 	const fidelityIndent = fidelity ? explicitIndent : void 0;
 	if (s.includes("\n")) {
@@ -230,7 +252,7 @@ function renderString(s, style, indent, ignoreType = false, canonical = false, e
 	if (s === "" && (style === "block-literal" || style === "block-folded")) return renderDoubleQuoted(s, canonical);
 	switch (style) {
 		case "plain":
-			if (requiresQuoting(s, ignoreType)) {
+			if (requiresQuoting(s, ignoreType, quoteCompat)) {
 				if (s.includes("	") || s.includes("\r")) return renderDoubleQuoted(s, canonical);
 				for (let i = 0; i < s.length; i++) if (isControlChar(s.charCodeAt(i))) return renderDoubleQuoted(s, canonical);
 				return quoteStyle === "double" ? renderDoubleQuoted(s, canonical) : renderSingleQuoted(s);
@@ -289,6 +311,7 @@ function createContext(options) {
 		sortKeys: options?.sortKeys ?? false,
 		indentSequences: options?.indentSequences ?? false,
 		quoteStyle: options?.quoteStyle ?? "single",
+		quoteCompat: options?.quoteCompat,
 		forceDefaultStyles: options?.forceDefaultStyles ?? false,
 		seen: /* @__PURE__ */ new Set()
 	};
@@ -308,7 +331,7 @@ function stringifyLines(value, ctx, depth, allowFold = true) {
 	if (typeof value === "bigint") return [value.toString()];
 	if (typeof value === "string") {
 		const indentStr = " ".repeat(ctx.indent);
-		const rendered = renderString(value, ctx.defaultScalarStyle, indentStr, false, ctx.forceDefaultStyles, void 0, void 0, ctx.quoteStyle);
+		const rendered = renderString(value, ctx.defaultScalarStyle, indentStr, false, ctx.forceDefaultStyles, void 0, void 0, ctx.quoteStyle, void 0, ctx.quoteCompat);
 		return (allowFold && ctx.lineWidth > 0 ? foldRenderedScalar(rendered, indentStr, ctx.lineWidth) : rendered).split("\n");
 	}
 	if (Array.isArray(value)) {
@@ -373,7 +396,7 @@ function stringifyObjectLines(obj, ctx, depth) {
 	const keys = Object.keys(obj);
 	if (keys.length === 0) return ["{}"];
 	if (ctx.sortKeys) keys.sort();
-	const renderPlainKey = (k) => renderString(k, "plain", "", false, false, void 0, void 0, ctx.quoteStyle);
+	const renderPlainKey = (k) => renderString(k, "plain", "", false, false, void 0, void 0, ctx.quoteStyle, void 0, ctx.quoteCompat);
 	if (ctx.defaultCollectionStyle === "flow") return [`{${keys.map((k) => {
 		return `${renderPlainKey(k)}: ${stringifyLines(obj[k], ctx, depth + 1, false).join(" ")}`;
 	}).join(", ")}}`];
@@ -584,7 +607,7 @@ function stringifyScalarNodeLines(node, ctx) {
 		else lines = ["null"];
 	} else if (typeof val === "boolean") lines = [val ? "true" : "false"];
 	else if (typeof val === "number") lines = [node.raw !== void 0 ? node.raw : renderNumber(val)];
-	else if (typeof val === "string") lines = renderString(val, style, " ".repeat(ctx.indent), !!node.tag, ctx.forceDefaultStyles, node.chomp, ctx.parentPosition, ctx.quoteStyle, node.blockIndent).split("\n");
+	else if (typeof val === "string") lines = renderString(val, style, " ".repeat(ctx.indent), !!node.tag, ctx.forceDefaultStyles, node.chomp, ctx.parentPosition, ctx.quoteStyle, node.blockIndent, ctx.quoteCompat).split("\n");
 	else lines = [renderDoubleQuoted(String(val))];
 	if (node.tag) lines[0] = `${node.tag} ${lines[0]}`;
 	if (node.anchor) lines[0] = `&${node.anchor} ${lines[0]}`;
@@ -1134,4 +1157,4 @@ function stringifyDocument(doc, options) {
 }
 
 //#endregion
-export { StringifyDepthExceeded, StringifyFailure, stringifyDocument, stringifyValue, stripNodeComments };
+export { StringifyDepthExceeded, StringifyFailure, renderDoubleQuoted, renderSingleQuoted, stringifyDocument, stringifyValue, stripNodeComments };

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@effected/yaml",
-	"version": "0.10.0",
+	"version": "0.12.0",
 	"private": false,
 	"description": "Zero-dependency YAML parsing, editing, formatting and linting as Effect schemas.",
 	"keywords": [

package/tsdoc-metadata.json

@@ -5,7 +5,7 @@
   "toolPackages": [
     {
       "packageName": "@microsoft/api-extractor",
-      "packageVersion": "7.58.12"
+      "packageVersion": "7.59.0"
     }
   ]
 }