Class RealFileSystemAdapter

Real file system adapter - implements both FileSystemAdapter and ts-morph's FileSystemHost. This is the production implementation used in the CLI.

Implements

FileSystemAdapter

Constructors

constructor

new RealFileSystemAdapter(): RealFileSystemAdapter
Returns RealFileSystemAdapter

Methods

copy

copy(srcPath: string, destPath: string): Promise<void>
Copies a file or directory recursively.
Parameters
- srcPath: string
- destPath: string
Returns Promise<void>

copySync

copySync(srcPath: string, destPath: string): void
Copies a file or directory recursively and synchronously.
Parameters
- srcPath: string
- destPath: string
Returns void

createDirectory

createDirectory(path: string): Promise<void>
Create a directory (and parent directories if needed).
Parameters
- path: string
  Directory path to create
Returns Promise<void>
Throws
Error if directory cannot be created

Implementation of FileSystemAdapter.createDirectory

delete

delete(path: string): Promise<void>
Alias of RealFileSystemAdapter.deleteFile.
Parameters
- path: string
Returns Promise<void>

deleteFile

deleteFile(path: string): Promise<void>
Delete a file.
Parameters
- path: string
  Path to the file to delete
Returns Promise<void>
Throws
Error if file doesn't exist or cannot be deleted

Implementation of FileSystemAdapter.deleteFile

deleteSync

deleteSync(path: string): void
Deletes a file synchronously.
Parameters
- path: string
Returns void
Throws
Error if the file cannot be deleted

directoryExists

directoryExists(dirPath: string): Promise<boolean>
Check if a path points to a directory.
Parameters
- dirPath: string
  Path to check
Returns Promise<boolean>
Promise resolving to true if path is a directory, false otherwise

Implementation of FileSystemAdapter.directoryExists

directoryExistsSync

directoryExistsSync(dirPath: string): boolean
Returns true when the path exists and is a directory.
Parameters
- dirPath: string
Returns boolean

exists

exists(path: string): Promise<boolean>
Check if a file or directory exists.
Parameters
- path: string
  Path to check
Returns Promise<boolean>
Promise resolving to true if exists, false otherwise

Implementation of FileSystemAdapter.exists

fileExists

fileExists(filePath: string): Promise<boolean>
Check if a path points to a file (not a directory).
Parameters
- filePath: string
  Path to check
Returns Promise<boolean>
Promise resolving to true if path is a file, false otherwise

Implementation of FileSystemAdapter.fileExists

fileExistsSync

fileExistsSync(filePath: string): boolean
Returns true when the path exists and is a file.
Parameters
- filePath: string
Returns boolean

getCurrentDirectory

getCurrentDirectory(): string
Returns process.cwd().

Returns string

getFileStats

getFileStats(path: string): Promise<{ mtime: number; size: number }>
Get file statistics.
Parameters
- path: string
  File path
Returns Promise<{ mtime: number; size: number }>
Promise resolving to file stats with mtime and size

Throws
Error if file doesn't exist

Implementation of FileSystemAdapter.getFileStats

glob

glob(_patterns: readonly string[]): Promise<string[]>
Not implemented: always resolves to an empty array.
Parameters
- _patterns: readonly string[]
Returns Promise<string[]>

globSync

globSync(_patterns: readonly string[]): string[]
Not implemented: always returns an empty array.
Parameters
- _patterns: readonly string[]
Returns string[]

isCaseSensitive

isCaseSensitive(): boolean
Returns false on Windows and macOS, true on other platforms.

Returns boolean

mkdir

mkdir(dirPath: string): Promise<void>
Alias of RealFileSystemAdapter.createDirectory.
Parameters
- dirPath: string
Returns Promise<void>

mkdirSync

mkdirSync(dirPath: string): void
Creates a directory and its parents synchronously.
Parameters
- dirPath: string
Returns void

move

move(srcPath: string, destPath: string): Promise<void>
Renames or moves a file or directory.
Parameters
- srcPath: string
- destPath: string
Returns Promise<void>

moveSync

moveSync(srcPath: string, destPath: string): void
Renames or moves a file or directory synchronously.
Parameters
- srcPath: string
- destPath: string
Returns void

readDirectory

readDirectory(path: string): Promise<string[]>
List all files in a directory (non-recursive).
Parameters
- path: string
  Directory path
Returns Promise<string[]>
Promise resolving to array of file/directory names

Throws
Error if directory doesn't exist or cannot be read

Implementation of FileSystemAdapter.readDirectory

readDirSync

readDirSync(dirPath: string): RuntimeDirEntry[]
Lists the direct entries of a directory synchronously.
Parameters
- dirPath: string
Returns RuntimeDirEntry[]
Entries with full paths as name

readFile

readFile(path: string): Promise<string>
Read a file's contents as a UTF-8 string.
Parameters
- path: string
  Absolute or relative path to the file
Returns Promise<string>
Promise resolving to file contents

Throws
Error if file doesn't exist or cannot be read

Implementation of FileSystemAdapter.readFile

readFileSync

readFileSync(filePath: string, encoding?: string): string
Reads a file synchronously.
Parameters
- filePath: string
- Optionalencoding: string
  Encoding, defaults to utf-8
Returns string

realpathSync

realpathSync(path: string): string
Resolves symbolic links and returns the canonical path.
Parameters
- path: string
Returns string

writeFile

writeFile(path: string, content: string): Promise<void>
Write content to a file, creating directories if needed.
Parameters
- path: string
  Absolute or relative path to the file
- content: string
  String content to write
Returns Promise<void>
Throws
Error if write operation fails

Implementation of FileSystemAdapter.writeFile

writeFileSync

writeFileSync(filePath: string, fileText: string): void
Writes a file synchronously, creating the parent directory if missing.
Parameters
- filePath: string
- fileText: string
Returns void