refactor: extract virtual-fs into utils

Author: hanna-skryl

packages/create-cli/src/lib/setup/ci.unit.test.ts

@@ -1,9 +1,9 @@
 import { select } from '@inquirer/prompts';
 import { vol } from 'memfs';
 import { MEMFS_VOLUME } from '@code-pushup/test-utils';
+import { createTree } from '@code-pushup/utils';
 import { promptCiProvider, resolveCi } from './ci.js';
 import type { ConfigContext } from './types.js';
-import { createTree } from './virtual-fs.js';
 
 vi.mock('@inquirer/prompts', () => ({
   select: vi.fn(),

packages/create-cli/src/lib/setup/gitignore.unit.test.ts

@@ -1,8 +1,8 @@
 import { vol } from 'memfs';
 import { readFile } from 'node:fs/promises';
 import { MEMFS_VOLUME } from '@code-pushup/test-utils';
+import { createTree } from '@code-pushup/utils';
 import { resolveGitignore } from './gitignore.js';
-import { createTree } from './virtual-fs.js';
 
 describe('resolveGitignore', () => {
   it('should create .gitignore with comment when it does not exist', async () => {

packages/create-cli/src/lib/setup/monorepo.unit.test.ts

@@ -1,10 +1,9 @@
 import { select } from '@inquirer/prompts';
 import { vol } from 'memfs';
 import { MEMFS_VOLUME } from '@code-pushup/test-utils';
-import { logger } from '@code-pushup/utils';
+import { createTree, logger } from '@code-pushup/utils';
 import { addCodePushUpCommand, promptSetupMode } from './monorepo.js';
 import type { WizardProject } from './types.js';
-import { createTree } from './virtual-fs.js';
 
 vi.mock('@inquirer/prompts', () => ({
   select: vi.fn(),

packages/create-cli/src/lib/setup/types.ts

@@ -1,5 +1,5 @@
 import type { PluginCodegenResult } from '@code-pushup/models';
-import type { MonorepoTool } from '@code-pushup/utils';
+import type { MonorepoTool, Tree } from '@code-pushup/utils';
 
 export type {
   CategoryCodegenConfig,
@@ -12,6 +12,8 @@ export type {
   PluginSetupTree,
 } from '@code-pushup/models';
 
+export type { FileChange, FileSystemAdapter, Tree } from '@code-pushup/utils';
+
 export const CI_PROVIDERS = ['github', 'gitlab', 'none'] as const;
 export type CiProvider = (typeof CI_PROVIDERS)[number];
 
@@ -59,31 +61,3 @@ export type WriteContext = {
   configFilename: string;
   isEsm: boolean;
 };
-
-/** A single file operation recorded by the virtual tree. */
-export type FileChange = {
-  path: string;
-  type: 'CREATE' | 'UPDATE';
-  content: string;
-};
-
-/** Virtual file system that buffers writes in memory until flushed to disk. */
-export type Tree = {
-  root: string;
-  exists: (filePath: string) => Promise<boolean>;
-  read: (filePath: string) => Promise<string | null>;
-  write: (filePath: string, content: string) => Promise<void>;
-  listChanges: () => FileChange[];
-  flush: () => Promise<void>;
-};
-
-/** Abstraction over `node:fs` used by the virtual tree for disk I/O. */
-export type FileSystemAdapter = {
-  readFile: (path: string, encoding: 'utf8') => Promise<string>;
-  writeFile: (path: string, content: string) => Promise<void>;
-  exists: (path: string) => Promise<boolean>;
-  mkdir: (
-    path: string,
-    options: { recursive: true },
-  ) => Promise<string | undefined>;
-};

packages/create-cli/src/lib/setup/virtual-fs.ts

@@ -3,6 +3,7 @@ import path from 'node:path';
 import {
   type MonorepoTool,
   asyncSequential,
+  createTree,
   formatAsciiTable,
   getGitRoot,
   logger,
@@ -35,7 +36,6 @@ import type {
   Tree,
   WriteContext,
 } from './types.js';
-import { createTree } from './virtual-fs.js';
 
 /**
  * Runs the interactive setup wizard that generates a Code PushUp config file.

packages/create-cli/src/lib/setup/virtual-fs.unit.test.ts

@@ -204,6 +204,12 @@ export {
   answerNonEmptyArray,
   answerString,
 } from './lib/plugin-answers.js';
+export {
+  createTree,
+  type FileChange,
+  type FileSystemAdapter,
+  type Tree,
+} from './lib/wizard/index.js';
 export {
   hasCodePushUpDependency,
   hasDependency,

packages/create-cli/src/lib/setup/wizard.ts

@@ -0,0 +1,2 @@
+export type { FileChange, FileSystemAdapter, Tree } from './types.js';
+export { createTree } from './virtual-fs.js';