@savvy-web/silk-effects 5.6.0 → 5.7.1

package/index.d.ts

@@ -4,6 +4,7 @@ import { ChildProcessSpawner } from "effect/unstable/process";
 import { PackageManagerDetector, PublishConfig, PublishTarget, PublishabilityDetector, VersioningStrategy, WorkspaceDiscovery, WorkspaceDiscoveryFailure, WorkspacePackage, WorkspaceSnapshotAtFailure, WorkspaceSnapshotWorktreeFailure, WorkspaceSnapshots, WorkspaceStateSnapshot, WorkspacesOptions } from "@effected/workspaces";
 import { Git } from "@effected/git";
 import { GlobExpansionError } from "@effected/walker";
+import { YamlFormattingOptions } from "@effected/yaml";
 import { Section, SectionId } from "@effected/templates";
 import { ToolDiscovery } from "@effected/commands";
 //#endregion
@@ -289,7 +290,7 @@ declare class Categories {
   static isValidHeading(heading: string): boolean;
 }
 //#endregion
-//#region ../../node_modules/.pnpm/@changesets+types@7.0.0-next.9/node_modules/@changesets/types/dist/index.d.mts
+//#region ../../node_modules/.pnpm/@changesets+types@7.0.0/node_modules/@changesets/types/dist/index.d.mts
 //#region src/index.d.ts
 type MaybePromise<T> = T | Promise<T>;
 type VersionType$1 = "major" | "minor" | "patch" | "none";
@@ -6778,9 +6779,14 @@ interface ShellScriptsOptions extends BaseHandlerOptions {
  */
 interface YamlOptions extends BaseHandlerOptions {
   /**
-   * Path to yaml-lint config file (.yaml-lint.json).
+   * Formatting options passed through to `@effected/yaml`.
+   *
+   * @remarks
+   * Defaults to the handler's own `defaultFormatOptions`. There is no
+   * config-file discovery: `@effected/yaml` is a pure tier that loads nothing
+   * from disk, and a consumer's `.prettierrc` is NOT consulted.
    */
-  config?: string;
+  format?: YamlFormattingOptions;
   /**
    * Skip YAML formatting.
    * @defaultValue false
@@ -7431,14 +7437,15 @@ declare class TypeScript {
 /**
  * Handler for YAML files.
  *
- * Formats with Prettier and validates with yaml-lint, both as bundled dependencies.
+ * Formats and validates with `@effected/yaml`, a bundled dependency.
  *
  * @remarks
  * Excludes pnpm-lock.yaml and pnpm-workspace.yaml by default.
  * pnpm-workspace.yaml has its own dedicated handler.
  *
- * Uses Prettier for formatting and yaml-lint for validation.
- * Both are bundled dependencies (no CLI spawning required).
+ * Formatting preserves comments and blank lines, and formats every document of
+ * a multi-document stream. Validation covers the WHOLE stream: a file whose
+ * second document is invalid fails, which a single-document parse would miss.
  *
  * @example
  * ```typescript
@@ -7462,50 +7469,71 @@ declare class Yaml {
    * @defaultValue `['pnpm-lock.yaml', 'pnpm-workspace.yaml', '__test__/fixtures']`
    */
   static readonly defaultExcludes: readonly ["pnpm-lock.yaml", "pnpm-workspace.yaml", "__test__/fixtures"];
+  /**
+   * The formatting options applied when a caller supplies none.
+   *
+   * @remarks
+   * `indentSequences` matches the block-sequence indentation an ex-Prettier
+   * repository already has on disk; without it, formatting rewrites every
+   * sequence in the tree. `quoteStyle` only governs scalars the stringifier
+   * creates — it never re-quotes scalars already present in the source — so it
+   * is set for consistency with `PnpmWorkspace`, not to change existing files.
+   */
+  static readonly defaultFormatOptions: YamlFormattingOptions;
   /**
    * Pre-configured handler with default options.
    */
   static readonly handler: LintStagedHandler;
   /**
-   * Find the yaml-lint config file.
+   * Check if the YAML engine is available.
    *
-   * Paths are anchored to the workspace root (via {@link getWorkspaceRoot}),
-   * falling back to `process.cwd()` when not inside a workspace.
-   *
-   * Searches in order:
-   * 1. `{workspaceRoot}/lib/configs/.yaml-lint.json`
-   * 2. `{workspaceRoot}/.yaml-lint.json`
-   *
-   * @returns The config file path, or undefined if not found
+   * @returns Always `true` since `@effected/yaml` is a bundled dependency
    */
-  static findConfig(): string | undefined;
+  static isAvailable(): boolean;
   /**
-   * Load the yaml-lint schema from a config file.
+   * Format a YAML file in-place.
    *
-   * @param filepath - Path to the yaml-lint config file
-   * @returns The schema string, or undefined if not found
+   * @remarks
+   * Synchronous by contract: the engine is a pure, IO-free tier, so the only
+   * IO here is this function's own file read and write.
+   *
+   * @param filepath - Path to the YAML file
+   * @param options - Formatting options; defaults to {@link Yaml.defaultFormatOptions}
    */
-  static loadConfig(filepath: string): string | undefined;
+  static formatFile(filepath: string, options?: YamlFormattingOptions): void;
   /**
-   * Check if yaml-lint is available.
+   * Validate a YAML file.
    *
-   * @returns Always `true` since yaml-lint is a bundled dependency
+   * @remarks
+   * Validates every document of the stream, so a multi-document file whose
+   * later documents are invalid is rejected rather than silently accepted.
+   *
+   * @param filepath - Path to the YAML file
+   * @throws Error if the YAML is invalid
    */
-  static isAvailable(): boolean;
+  static validateFile(filepath: string): void;
   /**
-   * Format a YAML file in-place using Prettier.
+   * Serialize formatting options for the `savvy lint fmt yaml --format` flag.
    *
-   * @param filepath - Path to the YAML file
+   * @remarks
+   * The CLI subcommand runs in a separate process, so options set on
+   * {@link fmtCommand} have to cross a shell boundary to reach
+   * {@link formatFile}. Without that hop the two entry points format the same
+   * file differently — the drift this package's shared-static rule exists to
+   * prevent. {@link parseFormatOptions} is the inverse.
+   *
+   * @param options - Formatting options to encode
+   * @returns The options as a JSON string
    */
-  static formatFile(filepath: string): Promise<void>;
+  static encodeFormatOptions(options: YamlFormattingOptions): string;
   /**
-   * Validate a YAML file using yaml-lint.
+   * Parse formatting options serialized by {@link encodeFormatOptions}.
    *
-   * @param filepath - Path to the YAML file
-   * @param schema - The YAML schema to validate against
-   * @throws Error if the YAML is invalid
+   * @param encoded - JSON produced by {@link encodeFormatOptions}
+   * @returns The decoded options
+   * @throws Error if the JSON is malformed or fails schema validation
    */
-  static validateFile(filepath: string, schema?: string): Promise<void>;
+  static parseFormatOptions(encoded: string): YamlFormattingOptions;
   /**
    * Create a handler that returns a CLI command to format YAML files.
    *
@@ -7515,6 +7543,9 @@ declare class Yaml {
    * can detect the modification and auto-stage it.
    * Use this in lint-staged array syntax for sequential execution.
    *
+   * `options.format` is forwarded to the subcommand as `--format`, so this
+   * path and {@link create} produce identical bytes for the same options.
+   *
    * @param options - Configuration options
    * @returns A lint-staged compatible handler function
    */

package/lint/handlers/Yaml.js

@@ -1,28 +1,26 @@
 import { Command } from "../utils/Command.js";
 import { Filter } from "../utils/Filter.js";
-import { getWorkspaceRoot } from "../utils/Workspace.js";
-import { existsSync, readFileSync, writeFileSync } from "node:fs";
-import { join } from "node:path";
-import { format, resolveConfig } from "prettier";
-import { lint } from "yaml-lint";
+import { readFileSync, writeFileSync } from "node:fs";
+import { Yaml, YamlFormat, YamlFormattingOptions } from "@effected/yaml";
 
 //#region src/lint/handlers/Yaml.ts
 /**
 * Handler for YAML files.
 *
-* Formats with Prettier and validates with yaml-lint, both as bundled dependencies.
+* Formats and validates with `@effected/yaml`, a bundled dependency.
 */
 /**
 * Handler for YAML files.
 *
-* Formats with Prettier and validates with yaml-lint, both as bundled dependencies.
+* Formats and validates with `@effected/yaml`, a bundled dependency.
 *
 * @remarks
 * Excludes pnpm-lock.yaml and pnpm-workspace.yaml by default.
 * pnpm-workspace.yaml has its own dedicated handler.
 *
-* Uses Prettier for formatting and yaml-lint for validation.
-* Both are bundled dependencies (no CLI spawning required).
+* Formatting preserves comments and blank lines, and formats every document of
+* a multi-document stream. Validation covers the WHOLE stream: a file whose
+* second document is invalid fails, which a single-document parse would miss.
 *
 * @example
 * ```typescript
@@ -35,7 +33,7 @@ import { lint } from "yaml-lint";
 * };
 * ```
 */
-var Yaml = class Yaml {
+var Yaml$1 = class Yaml$1 {
 	/**
 	* Glob pattern for matching YAML files.
 	* @defaultValue `'**\/*.{yml,yaml}'`
@@ -51,75 +49,86 @@ var Yaml = class Yaml {
 		"__test__/fixtures"
 	];
 	/**
-	* Pre-configured handler with default options.
-	*/
-	static handler = Yaml.create();
-	/**
-	* Find the yaml-lint config file.
-	*
-	* Paths are anchored to the workspace root (via {@link getWorkspaceRoot}),
-	* falling back to `process.cwd()` when not inside a workspace.
+	* The formatting options applied when a caller supplies none.
 	*
-	* Searches in order:
-	* 1. `{workspaceRoot}/lib/configs/.yaml-lint.json`
-	* 2. `{workspaceRoot}/.yaml-lint.json`
-	*
-	* @returns The config file path, or undefined if not found
+	* @remarks
+	* `indentSequences` matches the block-sequence indentation an ex-Prettier
+	* repository already has on disk; without it, formatting rewrites every
+	* sequence in the tree. `quoteStyle` only governs scalars the stringifier
+	* creates — it never re-quotes scalars already present in the source — so it
+	* is set for consistency with `PnpmWorkspace`, not to change existing files.
 	*/
-	static findConfig() {
-		const root = getWorkspaceRoot() ?? process.cwd();
-		const libPath = join(root, "lib/configs/.yaml-lint.json");
-		if (existsSync(libPath)) return libPath;
-		const rootPath = join(root, ".yaml-lint.json");
-		if (existsSync(rootPath)) return rootPath;
-	}
+	static defaultFormatOptions = YamlFormattingOptions.make({
+		quoteStyle: "double",
+		indentSequences: true
+	});
 	/**
-	* Load the yaml-lint schema from a config file.
-	*
-	* @param filepath - Path to the yaml-lint config file
-	* @returns The schema string, or undefined if not found
+	* Pre-configured handler with default options.
 	*/
-	static loadConfig(filepath) {
-		try {
-			const content = readFileSync(filepath, "utf-8");
-			return JSON.parse(content).schema;
-		} catch {
-			return;
-		}
-	}
+	static handler = Yaml$1.create();
 	/**
-	* Check if yaml-lint is available.
+	* Check if the YAML engine is available.
 	*
-	* @returns Always `true` since yaml-lint is a bundled dependency
+	* @returns Always `true` since `@effected/yaml` is a bundled dependency
 	*/
 	static isAvailable() {
 		return true;
 	}
 	/**
-	* Format a YAML file in-place using Prettier.
+	* Format a YAML file in-place.
+	*
+	* @remarks
+	* Synchronous by contract: the engine is a pure, IO-free tier, so the only
+	* IO here is this function's own file read and write.
 	*
 	* @param filepath - Path to the YAML file
+	* @param options - Formatting options; defaults to {@link Yaml.defaultFormatOptions}
 	*/
-	static async formatFile(filepath) {
+	static formatFile(filepath, options = Yaml$1.defaultFormatOptions) {
 		const content = readFileSync(filepath, "utf-8");
-		const prettierConfig = await resolveConfig(filepath);
-		const formatted = await format(content, {
-			...prettierConfig,
-			filepath,
-			parser: "yaml"
-		});
-		writeFileSync(filepath, formatted, "utf-8");
+		const formatted = YamlFormat.formatToString(content, void 0, options);
+		if (formatted !== content) writeFileSync(filepath, formatted, "utf-8");
 	}
 	/**
-	* Validate a YAML file using yaml-lint.
+	* Validate a YAML file.
+	*
+	* @remarks
+	* Validates every document of the stream, so a multi-document file whose
+	* later documents are invalid is rejected rather than silently accepted.
 	*
 	* @param filepath - Path to the YAML file
-	* @param schema - The YAML schema to validate against
 	* @throws Error if the YAML is invalid
 	*/
-	static async validateFile(filepath, schema) {
+	static validateFile(filepath) {
 		const content = readFileSync(filepath, "utf-8");
-		await lint(content, schema ? { schema } : void 0);
+		const result = Yaml.parseAllResult(content);
+		if (!("success" in result)) throw new Error(String(result.failure));
+	}
+	/**
+	* Serialize formatting options for the `savvy lint fmt yaml --format` flag.
+	*
+	* @remarks
+	* The CLI subcommand runs in a separate process, so options set on
+	* {@link fmtCommand} have to cross a shell boundary to reach
+	* {@link formatFile}. Without that hop the two entry points format the same
+	* file differently — the drift this package's shared-static rule exists to
+	* prevent. {@link parseFormatOptions} is the inverse.
+	*
+	* @param options - Formatting options to encode
+	* @returns The options as a JSON string
+	*/
+	static encodeFormatOptions(options) {
+		return JSON.stringify(options);
+	}
+	/**
+	* Parse formatting options serialized by {@link encodeFormatOptions}.
+	*
+	* @param encoded - JSON produced by {@link encodeFormatOptions}
+	* @returns The decoded options
+	* @throws Error if the JSON is malformed or fails schema validation
+	*/
+	static parseFormatOptions(encoded) {
+		return YamlFormattingOptions.make(JSON.parse(encoded));
 	}
 	/**
 	* Create a handler that returns a CLI command to format YAML files.
@@ -130,15 +139,19 @@ var Yaml = class Yaml {
 	* can detect the modification and auto-stage it.
 	* Use this in lint-staged array syntax for sequential execution.
 	*
+	* `options.format` is forwarded to the subcommand as `--format`, so this
+	* path and {@link create} produce identical bytes for the same options.
+	*
 	* @param options - Configuration options
 	* @returns A lint-staged compatible handler function
 	*/
 	static fmtCommand(options = {}) {
-		const excludes = options.exclude ?? [...Yaml.defaultExcludes];
+		const excludes = options.exclude ?? [...Yaml$1.defaultExcludes];
+		const formatOptions = options.format;
 		return (filenames) => {
 			const filtered = Filter.exclude(filenames, excludes);
 			if (filtered.length === 0) return [];
-			return `${Command.findSavvyLint()} fmt yaml ${Filter.shellEscape(filtered)}`;
+			return `${Command.findSavvyLint()} fmt yaml${formatOptions ? ` --format ${Filter.shellEscape([Yaml$1.encodeFormatOptions(formatOptions)])}` : ""} ${Filter.shellEscape(filtered)}`;
 		};
 	}
 	/**
@@ -148,17 +161,16 @@ var Yaml = class Yaml {
 	* @returns A lint-staged compatible handler function
 	*/
 	static create(options = {}) {
-		const excludes = options.exclude ?? [...Yaml.defaultExcludes];
+		const excludes = options.exclude ?? [...Yaml$1.defaultExcludes];
 		const skipFormat = options.skipFormat ?? false;
 		const skipValidate = options.skipValidate ?? false;
-		const configPath = options.config ?? Yaml.findConfig();
-		const schema = configPath ? Yaml.loadConfig(configPath) : void 0;
-		return async (filenames) => {
+		const formatOptions = options.format ?? Yaml$1.defaultFormatOptions;
+		return (filenames) => {
 			const filtered = Filter.exclude(filenames, excludes);
 			if (filtered.length === 0) return [];
-			if (!skipFormat) for (const filepath of filtered) await Yaml.formatFile(filepath);
+			if (!skipFormat) for (const filepath of filtered) Yaml$1.formatFile(filepath, formatOptions);
 			if (!skipValidate) for (const filepath of filtered) try {
-				await Yaml.validateFile(filepath, schema);
+				Yaml$1.validateFile(filepath);
 			} catch (error) {
 				throw new Error(`Invalid YAML in ${filepath}: ${error instanceof Error ? error.message : String(error)}`);
 			}
@@ -168,4 +180,4 @@ var Yaml = class Yaml {
 };
 
 //#endregion
-export { Yaml };
+export { Yaml$1 as Yaml };

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@savvy-web/silk-effects",
-	"version": "5.6.0",
+	"version": "5.7.1",
 	"private": false,
 	"description": "Shared Effect library for Silk Suite conventions",
 	"homepage": "https://github.com/savvy-web/systems/tree/main/packages/silk-effects",
@@ -31,7 +31,7 @@
 	"dependencies": {
 		"@changesets/apply-release-plan": "^8.0.0-next.9",
 		"@changesets/config": "^4.0.0-next.6",
-		"@changesets/get-github-info": "^1.0.0-next.4",
+		"@changesets/get-github-info": "^1.0.0",
 		"@changesets/get-release-plan": "^5.0.0-next.9",
 		"@effected/commands": "^0.4.0",
 		"@effected/git": "^0.7.0",
@@ -40,20 +40,18 @@
 		"@effected/package-json": "^0.8.0",
 		"@effected/templates": "^0.2.0",
 		"@effected/walker": "^0.4.0",
-		"@effected/workspaces": "^0.11.1",
-		"@effected/yaml": "^0.7.0",
+		"@effected/workspaces": "^0.12.0",
+		"@effected/yaml": "^0.8.0",
 		"@manypkg/get-packages": "^3.1.0",
 		"mdast-util-heading-range": "^4.0.0",
 		"mdast-util-to-string": "^4.0.0",
-		"prettier": "^3.9.6",
 		"remark-gfm": "^4.0.1",
 		"remark-parse": "^11.0.0",
 		"remark-stringify": "^11.0.0",
 		"shell-quote": "^1.10.0",
 		"unified": "^11.0.5",
 		"unified-lint-rule": "^3.0.1",
-		"unist-util-visit": "^5.1.0",
-		"yaml-lint": "^1.7.0"
+		"unist-util-visit": "^5.1.0"
 	},
 	"peerDependencies": {
 		"effect": "4.0.0-beta.107"