refactor to use fs ops pattern more

Author: ryanatkn

.changeset/rare-pumas-switch.md

@@ -0,0 +1,5 @@
+---
+'@fuzdev/fuz_gitops': minor
+---
+
+refactor to use fs ops pattern more

src/lib/changeset_generator.ts

@@ -7,13 +7,13 @@
  * @module
  */
 
-import {writeFile, mkdir} from 'node:fs/promises';
 import {join} from 'node:path';
-import {existsSync} from 'node:fs';
 import type {Logger} from '@fuzdev/fuz_util/log.js';
 import type {LocalRepo} from './local_repo.js';
 import type {PublishedVersion} from './multi_repo_publisher.js';
 import {strip_version_prefix} from './version_utils.js';
+import type {FsOperations} from './operations.js';
+import {default_fs_operations} from './operations_defaults.js';
 
 export interface DependencyVersionChange {
 	package_name: string;
@@ -30,14 +30,17 @@ export interface DependencyVersionChange {
 export const create_changeset_for_dependency_updates = async (
 	repo: LocalRepo,
 	updates: Array<DependencyVersionChange>,
-	options: {log?: Logger} = {},
+	options: {log?: Logger; fs_ops?: FsOperations} = {},
 ): Promise<string> => {
-	const {log} = options;
+	const {log, fs_ops = default_fs_operations} = options;
 	const changesets_dir = join(repo.repo_dir, '.changeset');
 
 	// Ensure .changeset directory exists
-	if (!existsSync(changesets_dir)) {
-		await mkdir(changesets_dir, {recursive: true});
+	if (!fs_ops.exists({path: changesets_dir})) {
+		const mkdir_result = await fs_ops.mkdir({path: changesets_dir, recursive: true});
+		if (!mkdir_result.ok) {
+			throw new Error(`Failed to create .changeset directory: ${mkdir_result.message}`);
+		}
 	}
 
 	// Generate a unique filename
@@ -53,7 +56,10 @@ export const create_changeset_for_dependency_updates = async (
 	const content = generate_changeset_content(repo.library.name, updates, required_bump);
 
 	// Write the changeset file
-	await writeFile(filepath, content, 'utf8');
+	const write_result = await fs_ops.writeFile({path: filepath, content});
+	if (!write_result.ok) {
+		throw new Error(`Failed to write changeset file: ${write_result.message}`);
+	}
 
 	log?.info(`  Created changeset: ${filename}`);
 

src/lib/dependency_updater.ts

@@ -145,7 +145,7 @@ export const update_package_json = async (
 			const changeset_path = await create_changeset_for_dependency_updates(
 				repo,
 				dependency_updates,
-				{log},
+				{log, fs_ops},
 			);
 
 			// Add changeset to git

src/lib/operations.ts

@@ -319,6 +319,19 @@ export interface FsOperations {
 		path: string;
 		content: string;
 	}) => Promise<Result<object, {message: string}>>;
+
+	/**
+	 * Creates a directory, optionally with recursive creation.
+	 */
+	mkdir: (options: {
+		path: string;
+		recursive?: boolean;
+	}) => Promise<Result<object, {message: string}>>;
+
+	/**
+	 * Checks if a path exists on the file system.
+	 */
+	exists: (options: {path: string}) => boolean;
 }
 
 /**

src/lib/operations_defaults.ts

@@ -8,7 +8,8 @@
  */
 
 import {spawn, spawn_out} from '@fuzdev/fuz_util/process.js';
-import {readFile, writeFile} from 'node:fs/promises';
+import {readFile, writeFile, mkdir} from 'node:fs/promises';
+import {existsSync} from 'node:fs';
 import {git_checkout, type GitBranch, type GitOrigin} from '@fuzdev/fuz_util/git.js';
 import {EMPTY_OBJECT} from '@fuzdev/fuz_util/object.js';
 
@@ -300,6 +301,15 @@ export const default_fs_operations: FsOperations = {
 		const {path, content} = options;
 		return wrap_void(() => writeFile(path, content));
 	},
+
+	mkdir: async (options) => {
+		const {path, recursive} = options;
+		return wrap_void(() => mkdir(path, {recursive}));
+	},
+
+	exists: (options) => {
+		return existsSync(options.path);
+	},
 };
 
 export const default_build_operations: BuildOperations = {

src/routes/library.json

@@ -159,7 +159,7 @@
 						"kind": "function",
 						"doc_comment": "Creates a changeset file for dependency updates.\nReturns the path to the created changeset file.",
 						"source_line": 30,
-						"type_signature": "(repo: LocalRepo, updates: DependencyVersionChange[], options?: { log?: Logger | undefined; }): Promise<string>",
+						"type_signature": "(repo: LocalRepo, updates: DependencyVersionChange[], options?: { log?: Logger | undefined; fs_ops?: FsOperations | undefined; }): Promise<...>",
 						"return_type": "Promise<string>",
 						"parameters": [
 							{
@@ -172,7 +172,7 @@
 							},
 							{
 								"name": "options",
-								"type": "{ log?: Logger | undefined; }",
+								"type": "{ log?: Logger | undefined; fs_ops?: FsOperations | undefined; }",
 								"default_value": "{}"
 							}
 						]
@@ -181,7 +181,7 @@
 						"name": "generate_changeset_content",
 						"kind": "function",
 						"doc_comment": "Generates markdown changeset content for dependency updates.\n\nCreates properly formatted changeset with YAML frontmatter, summary,\nand categorized list of breaking vs regular updates. Output format\nmatches changesets CLI for consistency.",
-						"source_line": 97,
+						"source_line": 103,
 						"type_signature": "(package_name: string, updates: DependencyVersionChange[], bump_type: \"major\" | \"minor\" | \"patch\"): string",
 						"return_type": "string",
 						"return_description": "markdown content ready to write to .changeset/*.md file",
@@ -206,7 +206,7 @@
 					{
 						"name": "create_dependency_updates",
 						"kind": "function",
-						"source_line": 141,
+						"source_line": 147,
 						"type_signature": "(dependencies: Map<string, string>, published_versions: Map<string, PublishedVersion>): DependencyVersionChange[]",
 						"return_type": "DependencyVersionChange[]",
 						"parameters": [
@@ -222,7 +222,7 @@
 					}
 				],
 				"module_comment": "Auto-generation of changesets for dependency updates during publishing.\n\nCreates changesets when packages need to republish due to updated dependencies.\nFor parsing existing changesets, see `changeset_reader.ts`.",
-				"dependencies": ["version_utils.ts"],
+				"dependencies": ["operations_defaults.ts", "version_utils.ts"],
 				"dependents": ["dependency_updater.ts"]
 			},
 			{
@@ -2591,50 +2591,50 @@
 					{
 						"name": "default_changeset_operations",
 						"kind": "variable",
-						"source_line": 70,
+						"source_line": 71,
 						"type_signature": "ChangesetOperations"
 					},
 					{
 						"name": "default_git_operations",
 						"kind": "variable",
-						"source_line": 95,
+						"source_line": 96,
 						"type_signature": "GitOperations"
 					},
 					{
 						"name": "default_process_operations",
 						"kind": "variable",
-						"source_line": 192,
+						"source_line": 193,
 						"type_signature": "ProcessOperations"
 					},
 					{
 						"name": "default_npm_operations",
 						"kind": "variable",
-						"source_line": 216,
+						"source_line": 217,
 						"type_signature": "NpmOperations"
 					},
 					{
 						"name": "default_preflight_operations",
 						"kind": "variable",
-						"source_line": 287,
+						"source_line": 288,
 						"type_signature": "PreflightOperations"
 					},
 					{
 						"name": "default_fs_operations",
 						"kind": "variable",
-						"source_line": 293,
+						"source_line": 294,
 						"type_signature": "FsOperations"
 					},
 					{
 						"name": "default_build_operations",
 						"kind": "variable",
-						"source_line": 305,
+						"source_line": 315,
 						"type_signature": "BuildOperations"
 					},
 					{
 						"name": "default_gitops_operations",
 						"kind": "variable",
 						"doc_comment": "Combined default operations for all gitops functionality.",
-						"source_line": 329,
+						"source_line": 339,
 						"type_signature": "GitopsOperations"
 					}
 				],
@@ -2646,6 +2646,7 @@
 					"preflight_checks.ts"
 				],
 				"dependents": [
+					"changeset_generator.ts",
 					"dependency_updater.ts",
 					"local_repo.ts",
 					"multi_repo_publisher.ts",
@@ -2902,14 +2903,26 @@
 								"kind": "variable",
 								"type_signature": "(options: {\n\t\tpath: string;\n\t\tcontent: string;\n\t}) => Promise<Result<object, {message: string}>>",
 								"doc_comment": "Writes a file to the file system."
+							},
+							{
+								"name": "mkdir",
+								"kind": "variable",
+								"type_signature": "(options: {\n\t\tpath: string;\n\t\trecursive?: boolean;\n\t}) => Promise<Result<object, {message: string}>>",
+								"doc_comment": "Creates a directory, optionally with recursive creation."
+							},
+							{
+								"name": "exists",
+								"kind": "variable",
+								"type_signature": "(options: {path: string}) => boolean",
+								"doc_comment": "Checks if a path exists on the file system."
 							}
 						]
 					},
 					{
 						"name": "GitopsOperations",
 						"kind": "type",
 						"doc_comment": "Combined operations interface grouping all gitops functionality.\nThis is the main interface injected into publishing and validation workflows.",
-						"source_line": 328,
+						"source_line": 341,
 						"type_signature": "GitopsOperations",
 						"properties": [
 							{

src/test/fixtures/mock_operations.ts

@@ -154,6 +154,10 @@ export const create_mock_fs_ops = (fixture: RepoFixtureSet): FsOperations => {
 		},
 
 		writeFile: async () => ({ok: true}),
+
+		mkdir: async () => ({ok: true}),
+
+		exists: () => true,
 	};
 };
 

src/test/test_helpers.ts

@@ -129,6 +129,8 @@ export const create_mock_gitops_ops = (
 	fs: {
 		readFile: async () => ({ok: true, value: '{}'}),
 		writeFile: async () => ({ok: true}),
+		mkdir: async () => ({ok: true}),
+		exists: () => true,
 		...overrides.fs,
 	},
 	build: create_mock_build_ops(overrides.build),
@@ -280,6 +282,7 @@ export const create_mock_fs_ops = (): FsOperations & {
 	set: (path: string, content: string) => void;
 } => {
 	const files: Map<string, string> = new Map();
+	const dirs: Set<string> = new Set();
 
 	return {
 		readFile: async (options) => {
@@ -293,6 +296,13 @@ export const create_mock_fs_ops = (): FsOperations & {
 			files.set(options.path, options.content);
 			return {ok: true};
 		},
+		mkdir: async (options) => {
+			dirs.add(options.path);
+			return {ok: true};
+		},
+		exists: (options) => {
+			return files.has(options.path) || dirs.has(options.path);
+		},
 		get: (path: string): string | undefined => files.get(path),
 		set: (path: string, content: string): void => {
 			files.set(path, content);