@effected/yaml 0.1.0 → 0.2.0

package/README.md

@@ -39,6 +39,8 @@ pnpm add @effected/yaml effect
 
 Requires Node.js >=24.11.0. `effect` v4 is a peer dependency; the package itself adds no other runtime dependencies.
 
+All `@effected/*` packages are ESM-only: the exports maps publish only `import` conditions, so `require()` — including tools that resolve in CJS mode — fails with Node's `ERR_PACKAGE_PATH_NOT_EXPORTED` rather than loading a CJS build that does not exist. Import from an ES module.
+
 ## Quick start
 
 Compose your schema with `Yaml.schema` to decode YAML straight into a validated domain value:

package/Yaml.js

@@ -13,6 +13,18 @@ import { Effect, Option, Schema, SchemaIssue, SchemaTransformation } from "effec
 * denial-of-service guard) and `uniqueKeys` `true` (duplicate mapping keys
 * are errors).
 *
+* Construct with the validated `YamlParseOptions.make({ ... })` static — the
+* kit convention (never `new`). Call sites that take a `YamlParseOptions`
+* also accept a structurally-matching plain literal.
+*
+* @example
+* ```ts
+* import { Yaml, YamlParseOptions } from "@effected/yaml";
+*
+* const options = YamlParseOptions.make({ maxAliasCount: 50 });
+* const parsed = Yaml.parse("a: 1", options);
+* ```
+*
 * @public
 */
 var YamlParseOptions = class extends Schema.Class("YamlParseOptions")({
@@ -24,7 +36,29 @@ var YamlParseOptions = class extends Schema.Class("YamlParseOptions")({
 * Options controlling stringify behavior. All fields are omissible; absent
 * fields resolve to `indent` `2`, `lineWidth` `80`, `defaultScalarStyle`
 * `"plain"`, `defaultCollectionStyle` `"block"`, `sortKeys` `false`,
-* `finalNewline` `true` and `forceDefaultStyles` `false`.
+* `indentSequences` `false`, `finalNewline` `true` and `forceDefaultStyles`
+* `false`.
+*
+* `indentSequences` controls the presentation of block sequences nested under
+* a mapping key: `false` (the default) emits them at the key's column — the
+* kit's byte-compatible legacy form — while `true` indents them one level,
+* matching the `yaml` npm package's default output. Top-level sequences stay
+* at column zero in both modes.
+*
+* Construct with the validated `YamlStringifyOptions.make({ ... })` static —
+* the kit convention (never `new`). Call sites that take a
+* `YamlStringifyOptions` also accept a structurally-matching plain literal.
+*
+* @example
+* ```ts
+* import { Yaml, YamlStringifyOptions } from "@effected/yaml";
+*
+* const options = YamlStringifyOptions.make({ indentSequences: true });
+* const yaml = Yaml.stringify({ key: ["a", "b"] }, options);
+* // key:
+* //   - a
+* //   - b
+* ```
 *
 * @public
 */
@@ -34,6 +68,7 @@ var YamlStringifyOptions = class extends Schema.Class("YamlStringifyOptions")({
 	defaultScalarStyle: Schema.optionalKey(ScalarStyle),
 	defaultCollectionStyle: Schema.optionalKey(CollectionStyle),
 	sortKeys: Schema.optionalKey(Schema.Boolean),
+	indentSequences: Schema.optionalKey(Schema.Boolean),
 	finalNewline: Schema.optionalKey(Schema.Boolean),
 	forceDefaultStyles: Schema.optionalKey(Schema.Boolean)
 }) {};
@@ -82,6 +117,7 @@ const toStringifyInput = (options) => options === void 0 ? {} : {
 	defaultScalarStyle: options.defaultScalarStyle,
 	defaultCollectionStyle: options.defaultCollectionStyle,
 	sortKeys: options.sortKeys,
+	indentSequences: options.indentSequences,
 	finalNewline: options.finalNewline,
 	forceDefaultStyles: options.forceDefaultStyles
 };

package/YamlDocument.js

@@ -144,6 +144,7 @@ const toStringifyInput = (options) => options === void 0 ? {} : {
 	defaultScalarStyle: options.defaultScalarStyle,
 	defaultCollectionStyle: options.defaultCollectionStyle,
 	sortKeys: options.sortKeys,
+	indentSequences: options.indentSequences,
 	finalNewline: options.finalNewline,
 	forceDefaultStyles: options.forceDefaultStyles
 };

package/YamlFormat.js

@@ -11,9 +11,25 @@ import { Effect, Schema } from "effect";
 //#region src/YamlFormat.ts
 /**
 * Options controlling formatting behavior: every {@link YamlStringifyOptions}
-* field (derived, not hand-duplicated) plus `preserveComments` (default
-* `true`) and `range` (restrict edits to a region; see the module-level
-* remarks on the `range` parameter vs. this field).
+* field (derived, not hand-duplicated — including `indentSequences`) plus
+* `preserveComments` (default `true`) and `range` (restrict edits to a
+* region; see the module-level remarks on the `range` parameter vs. this
+* field).
+*
+* Construct with the validated `YamlFormattingOptions.make({ ... })` static —
+* the kit convention (never `new`). Call sites that take a
+* `YamlFormattingOptions` also accept a structurally-matching plain literal.
+*
+* @example
+* ```ts
+* import { YamlFormat, YamlFormattingOptions } from "@effected/yaml";
+*
+* const options = YamlFormattingOptions.make({ indentSequences: true });
+* const formatted = YamlFormat.formatToString("key:\n- a\n- b\n", undefined, options);
+* // key:
+* //   - a
+* //   - b
+* ```
 *
 * @public
 */
@@ -61,6 +77,7 @@ const toStringifyInput = (options) => options === void 0 ? {} : {
 	defaultScalarStyle: options.defaultScalarStyle,
 	defaultCollectionStyle: options.defaultCollectionStyle,
 	sortKeys: options.sortKeys,
+	indentSequences: options.indentSequences,
 	finalNewline: options.finalNewline,
 	forceDefaultStyles: options.forceDefaultStyles
 };

package/index.d.ts

@@ -128,6 +128,18 @@ declare const YamlParseOptions_base: Schema.Class<YamlParseOptions, Schema.Struc
  * denial-of-service guard) and `uniqueKeys` `true` (duplicate mapping keys
  * are errors).
  *
+ * Construct with the validated `YamlParseOptions.make({ ... })` static — the
+ * kit convention (never `new`). Call sites that take a `YamlParseOptions`
+ * also accept a structurally-matching plain literal.
+ *
+ * @example
+ * ```ts
+ * import { Yaml, YamlParseOptions } from "@effected/yaml";
+ *
+ * const options = YamlParseOptions.make({ maxAliasCount: 50 });
+ * const parsed = Yaml.parse("a: 1", options);
+ * ```
+ *
  * @public
  */
 declare class YamlParseOptions extends YamlParseOptions_base {}
@@ -137,6 +149,7 @@ declare const YamlStringifyOptions_base: Schema.Class<YamlStringifyOptions, Sche
   readonly defaultScalarStyle: Schema.optionalKey<Schema.Literals<readonly ["plain", "single-quoted", "double-quoted", "block-literal", "block-folded"]>>;
   readonly defaultCollectionStyle: Schema.optionalKey<Schema.Literals<readonly ["block", "flow"]>>;
   readonly sortKeys: Schema.optionalKey<Schema.Boolean>;
+  readonly indentSequences: Schema.optionalKey<Schema.Boolean>;
   readonly finalNewline: Schema.optionalKey<Schema.Boolean>;
   readonly forceDefaultStyles: Schema.optionalKey<Schema.Boolean>;
 }>, {}>;
@@ -144,7 +157,29 @@ declare const YamlStringifyOptions_base: Schema.Class<YamlStringifyOptions, Sche
  * Options controlling stringify behavior. All fields are omissible; absent
  * fields resolve to `indent` `2`, `lineWidth` `80`, `defaultScalarStyle`
  * `"plain"`, `defaultCollectionStyle` `"block"`, `sortKeys` `false`,
- * `finalNewline` `true` and `forceDefaultStyles` `false`.
+ * `indentSequences` `false`, `finalNewline` `true` and `forceDefaultStyles`
+ * `false`.
+ *
+ * `indentSequences` controls the presentation of block sequences nested under
+ * a mapping key: `false` (the default) emits them at the key's column — the
+ * kit's byte-compatible legacy form — while `true` indents them one level,
+ * matching the `yaml` npm package's default output. Top-level sequences stay
+ * at column zero in both modes.
+ *
+ * Construct with the validated `YamlStringifyOptions.make({ ... })` static —
+ * the kit convention (never `new`). Call sites that take a
+ * `YamlStringifyOptions` also accept a structurally-matching plain literal.
+ *
+ * @example
+ * ```ts
+ * import { Yaml, YamlStringifyOptions } from "@effected/yaml";
+ *
+ * const options = YamlStringifyOptions.make({ indentSequences: true });
+ * const yaml = Yaml.stringify({ key: ["a", "b"] }, options);
+ * // key:
+ * //   - a
+ * //   - b
+ * ```
  *
  * @public
  */
@@ -648,6 +683,7 @@ declare const YamlFormattingOptions_base: Schema.Class<YamlFormattingOptions, Sc
   readonly defaultScalarStyle: Schema.optionalKey<Schema.Literals<readonly ["plain", "single-quoted", "double-quoted", "block-literal", "block-folded"]>>;
   readonly defaultCollectionStyle: Schema.optionalKey<Schema.Literals<readonly ["block", "flow"]>>;
   readonly sortKeys: Schema.optionalKey<Schema.Boolean>;
+  readonly indentSequences: Schema.optionalKey<Schema.Boolean>;
   readonly finalNewline: Schema.optionalKey<Schema.Boolean>;
   readonly forceDefaultStyles: Schema.optionalKey<Schema.Boolean>;
   readonly preserveComments: Schema.optionalKey<Schema.Boolean>;
@@ -655,9 +691,25 @@ declare const YamlFormattingOptions_base: Schema.Class<YamlFormattingOptions, Sc
 }>, {}>;
 /**
  * Options controlling formatting behavior: every {@link YamlStringifyOptions}
- * field (derived, not hand-duplicated) plus `preserveComments` (default
- * `true`) and `range` (restrict edits to a region; see the module-level
- * remarks on the `range` parameter vs. this field).
+ * field (derived, not hand-duplicated — including `indentSequences`) plus
+ * `preserveComments` (default `true`) and `range` (restrict edits to a
+ * region; see the module-level remarks on the `range` parameter vs. this
+ * field).
+ *
+ * Construct with the validated `YamlFormattingOptions.make({ ... })` static —
+ * the kit convention (never `new`). Call sites that take a
+ * `YamlFormattingOptions` also accept a structurally-matching plain literal.
+ *
+ * @example
+ * ```ts
+ * import { YamlFormat, YamlFormattingOptions } from "@effected/yaml";
+ *
+ * const options = YamlFormattingOptions.make({ indentSequences: true });
+ * const formatted = YamlFormat.formatToString("key:\n- a\n- b\n", undefined, options);
+ * // key:
+ * //   - a
+ * //   - b
+ * ```
  *
  * @public
  */

package/internal/stringifier.js

@@ -256,6 +256,7 @@ function createContext(options) {
 		defaultScalarStyle: options?.defaultScalarStyle ?? "plain",
 		defaultCollectionStyle: options?.defaultCollectionStyle ?? "block",
 		sortKeys: options?.sortKeys ?? false,
+		indentSequences: options?.indentSequences ?? false,
 		forceDefaultStyles: options?.forceDefaultStyles ?? false,
 		seen: /* @__PURE__ */ new Set()
 	};
@@ -354,7 +355,7 @@ function stringifyObjectLines(obj, ctx, depth) {
 				for (let i = 1; i < valLines.length; i++) lines.push(valLines[i]);
 			} else if (Array.isArray(val) && val.length > 0) {
 				lines.push(`${keyStr}:`);
-				for (const vl of valLines) lines.push(vl);
+				for (const vl of valLines) lines.push(ctx.indentSequences && vl !== "" ? `${pad}${vl}` : vl);
 			} else {
 				lines.push(`${keyStr}:`);
 				for (const vl of valLines) lines.push(`${pad}${vl}`);
@@ -619,7 +620,10 @@ function stringifyMapNodeLines(node, ctx, depth) {
 			const seqMeta = buildMetadataPrefix(valNode.tag, valNode.anchor);
 			const startIdx = seqMeta ? 1 : 0;
 			lines.push(seqMeta ? `${keyStr}${sep} ${seqMeta}` : `${keyStr}${sep}`);
-			for (let i = startIdx; i < valLines.length; i++) lines.push(valLines[i]);
+			for (let i = startIdx; i < valLines.length; i++) {
+				const vl = valLines[i];
+				lines.push(ctx.indentSequences && vl !== "" ? `${pad}${vl}` : vl);
+			}
 		} else if (valNode instanceof YamlMap && valNode.items.length > 0 && (ctx.forceDefaultStyles ? ctx.defaultCollectionStyle : valNode.style ?? ctx.defaultCollectionStyle) === "block") {
 			const mapMeta = buildMetadataPrefix(valNode.tag, valNode.anchor);
 			const startIdx = mapMeta ? 1 : 0;

package/package.json

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

package/tsdoc-metadata.json

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