Class GitIntegration

Git integration for backup and rollback using git stash.

Index

Constructors

Methods

applyStash createSnapshot createStash dropStash getChangedFiles getGitRoot isGitRepository isWorkingDirectoryClean listStashes readFileAtCommit

Constructors

constructor

new GitIntegration(projectRoot?: string): GitIntegration
Parameters
- OptionalprojectRoot: string
Returns GitIntegration

Methods

applyStash

applyStash(stashRef?: string): Promise<GitOperationResult>
Apply a git stash (restore from backup).
Parameters
- OptionalstashRef: string
Returns Promise<GitOperationResult>

createSnapshot

createSnapshot(): Promise<string | undefined>
Record the working tree state of tracked files without touching the working tree, the index or the stash list (git stash create). With no local changes the snapshot is HEAD. Returns the commit, or undefined outside a git repository or without any commit.

Returns Promise<string | undefined>

createStash

createStash(message: string, files?: string[]): Promise<GitOperationResult>
Create a git stash as backup.
Parameters
- message: string
- Optionalfiles: string[]
Returns Promise<GitOperationResult>

dropStash

dropStash(stashRef?: string): Promise<GitOperationResult>
Drop a git stash.
Parameters
- OptionalstashRef: string
Returns Promise<GitOperationResult>

getChangedFiles

getChangedFiles(): Promise<string[]>
Get changes in working directory.

Returns Promise<string[]>

getGitRoot

getGitRoot(): Promise<string | null>
Get git root directory.

Returns Promise<string | null>

isGitRepository

isGitRepository(): Promise<boolean>
Check if current directory is a git repository.

Returns Promise<boolean>

isWorkingDirectoryClean

isWorkingDirectoryClean(): Promise<boolean>
Check if working directory is clean.

Returns Promise<boolean>

listStashes

listStashes(): Promise<GitStashMetadata[]>
List all stashes.

Returns Promise<GitStashMetadata[]>

readFileAtCommit

readFileAtCommit(commit: string, filePath: string): Promise<GitOperationResult>
Content of a file as recorded in a snapshot commit. Fails when the file lies outside the repository root or was not tracked at snapshot time.
Parameters
- commit: string
- filePath: string
Returns Promise<GitOperationResult>