move some functions into common/util/file

Author: charleslien

common/src/project-file-tree.ts

@@ -1,26 +1,25 @@
 import fs from 'fs'
-import os from 'os'
 import path from 'path'
 
 import * as ignore from 'ignore'
 import { sortBy } from 'lodash'
 
 import { DEFAULT_IGNORED_PATHS } from './constants'
-import { DirectoryNode, FileTreeNode } from './util/file'
+import { DirectoryNode, FileTreeNode, isValidProjectRoot } from './util/file'
 
 export const DEFAULT_MAX_FILES = 10_000
 
 export function getProjectFileTree(
   projectRoot: string,
   { maxFiles = DEFAULT_MAX_FILES }: { maxFiles?: number } = {}
 ): FileTreeNode[] {
+  const start = Date.now()
   const defaultIgnore = ignore.default()
   for (const pattern of DEFAULT_IGNORED_PATHS) {
     defaultIgnore.add(pattern)
   }
 
-  const isHomeDir = projectRoot === os.homedir()
-  if (isHomeDir) {
+  if (!isValidProjectRoot(projectRoot)) {
     defaultIgnore.add('.*')
     maxFiles = 0
   }

common/src/util/file.ts

@@ -1,4 +1,6 @@
 import * as fs from 'fs'
+import * as os from 'os'
+import * as path from 'path'
 import { z } from 'zod'
 
 export const FileTreeNodeSchema: z.ZodType<FileTreeNode> = z.object({
@@ -201,3 +203,33 @@ export function isValidFilePath(path: string) {
 
   return true
 }
+
+export function isDir(p: string): boolean {
+  try {
+    return fs.statSync(p).isDirectory()
+  } catch {
+    return false
+  }
+}
+
+/**
+ * Returns true if the `toPath` is a subdirectory of `fromPath`.
+ */
+export function isSubdir(fromPath: string, toPath: string) {
+  const resolvedFrom = path.resolve(fromPath)
+  const resolvedTo = path.resolve(toPath)
+
+  if (process.platform === 'win32') {
+    const fromDrive = path.parse(resolvedFrom).root.toLowerCase()
+    const toDrive = path.parse(resolvedTo).root.toLowerCase()
+    if (fromDrive !== toDrive) {
+      return false
+    }
+  }
+
+  return !path.relative(resolvedFrom, resolvedTo).startsWith('..')
+}
+
+export function isValidProjectRoot(dir: string): boolean {
+  return !isSubdir(dir, os.homedir())
+}

npm-app/src/cli.ts

@@ -7,7 +7,7 @@ import * as readline from 'readline'
 import { type ApiKeyType } from 'common/api-keys/constants'
 import type { CostMode } from 'common/constants'
 import { AnalyticsEvent } from 'common/constants/analytics-events'
-import { ProjectFileContext } from 'common/util/file'
+import { isDir, ProjectFileContext } from 'common/util/file'
 import { pluralize } from 'common/util/string'
 import {
   blueBright,
@@ -51,7 +51,6 @@ import {
   getProjectRoot,
   getWorkingDirectory,
   initProjectFileContextWithWorker,
-  isDir,
 } from './project-files'
 import {
   clearScreen,

npm-app/src/menu.ts

@@ -17,8 +17,9 @@ import {
 } from 'picocolors'
 
 import { codebuffConfigFile } from 'common/json-config/constants'
+import { isValidProjectRoot } from 'common/util/file'
 import { Formatter } from 'picocolors/types'
-import { getProjectRoot, isValidProjectRoot } from './project-files'
+import { getProjectRoot } from './project-files'
 
 export interface CommandInfo {
   commandText: string // e.g., 'type "login"', 'type "diff" or "d"', 'hit ESC key or Ctrl-C'

npm-app/src/project-files.ts

@@ -44,14 +44,6 @@ export function startNewChat() {
   return currentChatId
 }
 
-export function isDir(p: string): boolean {
-  try {
-    return statSync(p).isDirectory()
-  } catch {
-    return false
-  }
-}
-
 // Get the project-specific data directory
 export function getProjectDataDir(): string {
   const root = getProjectRoot()
@@ -73,10 +65,6 @@ export function getCurrentChatDir(): string {
   return dir
 }
 
-export function isValidProjectRoot(dir: string): boolean {
-  return !isSubdir(dir, os.homedir())
-}
-
 const execAsync = promisify(exec)
 
 let projectRoot: string
@@ -159,24 +147,6 @@ export function toAbsolutePath(filepath: string, projectRoot: string): string {
   return path.normalize(path.resolve(projectRoot, filepath))
 }
 
-/**
- * Returns true if the `toPath` is a subdirectory of `fromPath`.
- */
-export function isSubdir(fromPath: string, toPath: string) {
-  const resolvedFrom = path.resolve(fromPath)
-  const resolvedTo = path.resolve(toPath)
-
-  if (process.platform === 'win32') {
-    const fromDrive = path.parse(resolvedFrom).root.toLowerCase()
-    const toDrive = path.parse(resolvedTo).root.toLowerCase()
-    if (fromDrive !== toDrive) {
-      return false
-    }
-  }
-
-  return !path.relative(resolvedFrom, resolvedTo).startsWith('..')
-}
-
 let cachedProjectFileContext: ProjectFileContext | undefined
 
 export function initProjectFileContextWithWorker(
@@ -229,7 +199,7 @@ export function initProjectFileContextWithWorker(
 export const getProjectFileContext = async (
   projectRoot: string,
   lastFileVersion: Record<string, string>
-) => {
+): Promise<ProjectFileContext> => {
   const gitChanges = await getGitChanges()
   const changesSinceLastChat = getChangesSinceLastFileVersion(lastFileVersion)
 

npm-app/src/terminal/base.ts

@@ -12,10 +12,10 @@ import {
 } from 'common/util/string'
 import { green } from 'picocolors'
 
+import { isSubdir } from 'common/util/file'
 import {
   getProjectRoot,
   getWorkingDirectory,
-  isSubdir,
   setWorkingDirectory,
 } from '../project-files'
 import { trackEvent } from '../utils/analytics'

npm-app/src/utils/git.ts

@@ -1,9 +1,10 @@
 import { execFileSync } from 'child_process'
+import { isValidProjectRoot } from 'common/util/file'
 import fs, { existsSync, statSync } from 'fs'
 import gitUrlParse from 'git-url-parse'
 import { getConfig, listFiles, log, ReadCommitResult } from 'isomorphic-git'
 import path from 'path'
-import { getWorkingDirectory, isValidProjectRoot } from '../project-files'
+import { getWorkingDirectory } from '../project-files'
 import { logger } from './logger'
 
 /**