accept fsSource input in sdk

Author: charleslien

common/src/project-file-tree.ts

@@ -1,4 +1,3 @@
-import fs from 'fs'
 import path from 'path'
 
 import * as ignore from 'ignore'
@@ -7,14 +6,20 @@ import { sortBy } from 'lodash'
 import { DEFAULT_IGNORED_PATHS } from './old-constants'
 import { isValidProjectRoot } from './util/file'
 
+import type { CodebuffFileSystem } from './types/filesystem'
 import type { DirectoryNode, FileTreeNode } from './util/file'
 
 export const DEFAULT_MAX_FILES = 10_000
 
-export function getProjectFileTree(
-  projectRoot: string,
-  { maxFiles = DEFAULT_MAX_FILES }: { maxFiles?: number } = {},
-): FileTreeNode[] {
+export function getProjectFileTree(params: {
+  projectRoot: string
+  maxFiles?: number
+  fs: CodebuffFileSystem
+}): FileTreeNode[] {
+  const withDefaults = { maxFiles: DEFAULT_MAX_FILES, ...params }
+  const { projectRoot, fs } = withDefaults
+  let { maxFiles } = withDefaults
+
   const start = Date.now()
   const defaultIgnore = ignore.default()
   for (const pattern of DEFAULT_IGNORED_PATHS) {
@@ -50,7 +55,7 @@ export function getProjectFileTree(
     const mergedIgnore = ignore
       .default()
       .add(currentIgnore)
-      .add(parseGitignore(fullPath, projectRoot))
+      .add(parseGitignore({ fullDirPath: fullPath, projectRoot, fs }))
 
     try {
       const files = fs.readdirSync(fullPath)
@@ -146,10 +151,13 @@ function rebaseGitignorePattern(
   return isNegated ? `!${rebased}` : rebased
 }
 
-export function parseGitignore(
-  fullDirPath: string,
-  projectRoot: string,
-): ignore.Ignore {
+export function parseGitignore(params: {
+  fullDirPath: string
+  projectRoot: string
+  fs: CodebuffFileSystem
+}): ignore.Ignore {
+  const { fullDirPath, projectRoot, fs } = params
+
   const ig = ignore.default()
   const relativeDirPath = path.relative(projectRoot, fullDirPath)
   const ignoreFiles = [
@@ -210,7 +218,13 @@ export function getLastReadFilePaths(
     .map((node) => node.filePath)
 }
 
-export function isFileIgnored(filePath: string, projectRoot: string): boolean {
+export function isFileIgnored(params: {
+  filePath: string
+  projectRoot: string
+  fs: CodebuffFileSystem
+}): boolean {
+  const { filePath, projectRoot, fs } = params
+
   const defaultIgnore = ignore.default()
   for (const pattern of DEFAULT_IGNORED_PATHS) {
     defaultIgnore.add(pattern)
@@ -226,7 +240,9 @@ export function isFileIgnored(filePath: string, projectRoot: string): boolean {
   const mergedIgnore = ignore.default().add(defaultIgnore)
   let currentDir = dirPath
   while (currentDir.startsWith(projectRoot)) {
-    mergedIgnore.add(parseGitignore(currentDir, projectRoot))
+    mergedIgnore.add(
+      parseGitignore({ fullDirPath: currentDir, projectRoot, fs }),
+    )
     currentDir = path.dirname(currentDir)
   }
 

common/src/types/filesystem.ts

@@ -0,0 +1,15 @@
+import type fs from 'fs'
+
+/** File system used for Codebuff SDK.
+ *
+ * Compatible with the `'fs'` module
+ */
+export type CodebuffFileSystem = Pick<
+  typeof fs,
+  | 'existsSync'
+  | 'mkdirSync'
+  | 'readdirSync'
+  | 'readFileSync'
+  | 'statSync'
+  | 'writeFileSync'
+> & { promises: Pick<typeof fs.promises, 'readdir'> }

common/src/types/source.ts

@@ -0,0 +1,4 @@
+export type Source<T> =
+  | T
+  | Promise<T>
+  | (T extends (...args: unknown[]) => unknown ? never : () => T | Promise<T>)

common/src/util/file.ts

@@ -1,11 +1,12 @@
-import * as fs from 'fs'
 import * as os from 'os'
 import * as path from 'path'
 
 import { z } from 'zod/v4'
 
 import { CodebuffConfigSchema } from '../json-config/constants'
 
+import type { CodebuffFileSystem } from '../types/filesystem'
+
 export const FileTreeNodeSchema: z.ZodType<FileTreeNode> = z.object({
   name: z.string(),
   type: z.enum(['file', 'directory']),
@@ -214,7 +215,12 @@ export const ensureEndsWithNewline = (
   return contents + '\n'
 }
 
-export const ensureDirectoryExists = (baseDir: string) => {
+export const ensureDirectoryExists = (params: {
+  baseDir: string
+  fs: CodebuffFileSystem
+}) => {
+  const { baseDir, fs } = params
+
   if (!fs.existsSync(baseDir)) {
     fs.mkdirSync(baseDir, { recursive: true })
   }
@@ -243,9 +249,14 @@ export function isValidFilePath(path: string) {
   return true
 }
 
-export function isDir(p: string): boolean {
+export function isDir(params: {
+  path: string
+  fs: CodebuffFileSystem
+}): boolean {
+  const { path, fs } = params
+
   try {
-    return fs.statSync(p).isDirectory()
+    return fs.statSync(path).isDirectory()
   } catch {
     return false
   }

common/src/util/git.ts

@@ -1,8 +1,8 @@
 import { execSync } from 'child_process'
-import * as fs from 'fs'
 import * as path from 'path'
 
 import type { FileChanges } from '../actions'
+import type { CodebuffFileSystem } from '../types/filesystem'
 
 const maxBuffer = 50 * 1024 * 1024 // 50 MB
 
@@ -38,7 +38,13 @@ export function stageAllChanges(): boolean {
   }
 }
 
-export function stagePatches(dir: string, changes: FileChanges): boolean {
+export function stagePatches(params: {
+  dir: string
+  changes: FileChanges
+  fs: CodebuffFileSystem
+}): boolean {
+  const { dir, changes, fs } = params
+
   try {
     const fileNames = changes.map((change) => change.path)
     const existingFileNames = fileNames.filter((filePath) =>

evals/scaffolding.ts

@@ -137,7 +137,7 @@ export function createFileReadingMock(projectRoot: string) {
 export async function getProjectFileContext(
   projectPath: string,
 ): Promise<ProjectFileContext> {
-  const fileTree = getProjectFileTree(projectPath)
+  const fileTree = getProjectFileTree({ projectRoot: projectPath, fs })
   const allFilePaths = getAllFilePaths(fileTree)
   const knowledgeFilePaths = allFilePaths.filter((filePath) =>
     filePath.endsWith('knowledge.md'),

npm-app/src/browser-runner.ts

@@ -504,7 +504,7 @@ export class BrowserRunner {
       try {
         const chatDir = getCurrentChatDir()
         const screenshotsDir = path.join(chatDir, 'screenshots')
-        ensureDirectoryExists(screenshotsDir)
+        ensureDirectoryExists({ baseDir: screenshotsDir, fs })
 
         const timestamp = new Date().toISOString().replace(/[:.]/g, '-')
         const filename = `screenshot-${timestamp}.jpg`

npm-app/src/cli.ts

@@ -608,7 +608,10 @@ export class CLI {
         .filter((file) => file.startsWith(partial))
         .map(
           (file) =>
-            file + (isDir(path.join(baseDir, file)) ? directorySuffix : ''),
+            file +
+            (isDir({ path: path.join(baseDir, file), fs })
+              ? directorySuffix
+              : ''),
         )
       return [fsMatches, partial]
     } catch {

npm-app/src/credentials.ts

@@ -2,9 +2,7 @@ import type { User } from '@codebuff/common/util/credentials'
 
 import { z } from 'zod/v4'
 
-import { logger } from './utils/logger'
-
-import { existsSync, readFileSync } from 'fs'
+import fs from 'fs'
 import path from 'node:path'
 import os from 'os'
 
@@ -40,6 +38,8 @@ export const userFromJson = (
 
 import { ensureDirectoryExists } from '@codebuff/common/util/file'
 
+import { logger } from './utils/logger'
+
 export const CONFIG_DIR = path.join(
   os.homedir(),
   '.config',
@@ -52,7 +52,7 @@ export const CONFIG_DIR = path.join(
 )
 
 // Ensure config directory exists
-ensureDirectoryExists(CONFIG_DIR)
+ensureDirectoryExists({ baseDir: CONFIG_DIR, fs })
 export const CREDENTIALS_PATH = path.join(CONFIG_DIR, 'credentials.json')
 
 /**
@@ -61,12 +61,12 @@ export const CREDENTIALS_PATH = path.join(CONFIG_DIR, 'credentials.json')
  */
 export const getUserCredentials = (): User | null => {
   // Read user credentials directly from file
-  if (!existsSync(CREDENTIALS_PATH)) {
+  if (!fs.existsSync(CREDENTIALS_PATH)) {
     return null
   }
 
   try {
-    const credentialsFile = readFileSync(CREDENTIALS_PATH, 'utf8')
+    const credentialsFile = fs.readFileSync(CREDENTIALS_PATH, 'utf8')
     const user = userFromJson(credentialsFile)
     return user || null
   } catch (error) {

npm-app/src/project-files.ts

@@ -86,7 +86,7 @@ export function getProjectDataDir(): string {
 export function getCurrentChatDir(): string {
   const chatId = getCurrentChatId()
   const dir = path.join(getProjectDataDir(), 'chats', chatId)
-  ensureDirectoryExists(dir)
+  ensureDirectoryExists({ baseDir: dir, fs })
   return dir
 }
 
@@ -262,7 +262,7 @@ export const getProjectFileContext = async (
     !cachedProjectFileContext ||
     cachedProjectFileContext.projectRoot !== projectRoot
   ) {
-    const fileTree = getProjectFileTree(projectRoot)
+    const fileTree = getProjectFileTree({ projectRoot, fs })
     const flattenedNodes = flattenTree(fileTree)
     const allFilePaths = flattenedNodes
       .filter((node) => node.type === 'file')
@@ -457,7 +457,7 @@ export function getChangesSinceLastFileVersion(
 export function getFiles(filePaths: string[]) {
   const result: Record<string, string | null> = {}
   const MAX_FILE_SIZE = 1024 * 1024 // 1MB in bytes
-  const ig = parseGitignore(projectRoot, projectRoot)
+  const ig = parseGitignore({ fullDirPath: projectRoot, projectRoot, fs })
 
   for (const filePath of filePaths) {
     if (!filePath) {