types
MS Code Extension API / features/git/types
features/git/types
Interfaces
BranchSlice
Defined in: features/git/types.ts:170
Properties
branches
branches:
GitBranch[]
Defined in: features/git/types.ts:172
checkout
checkout: (
branch) =>Promise<void>
Defined in: features/git/types.ts:174
Parameters
branch
string
Returns
Promise<void>
checkoutViaPalette
checkoutViaPalette: () =>
Promise<void>
Defined in: features/git/types.ts:176
Returns
Promise<void>
createBranch
createBranch: () =>
Promise<void>
Defined in: features/git/types.ts:180
Returns
Promise<void>
createBranchFrom
createBranchFrom: () =>
Promise<void>
Defined in: features/git/types.ts:181
Returns
Promise<void>
currentBranch
currentBranch:
string
Defined in: features/git/types.ts:171
deleteBranch
deleteBranch: () =>
Promise<void>
Defined in: features/git/types.ts:183
Returns
Promise<void>
deleteRemoteBranch
deleteRemoteBranch: () =>
Promise<void>
Defined in: features/git/types.ts:184
Returns
Promise<void>
mergeBranch
mergeBranch: () =>
Promise<void>
Defined in: features/git/types.ts:178
Returns
Promise<void>
openBranchPalette
openBranchPalette: () =>
Promise<void>
Defined in: features/git/types.ts:175
Returns
Promise<void>
rebaseBranch
rebaseBranch: () =>
Promise<void>
Defined in: features/git/types.ts:179
Returns
Promise<void>
renameBranch
renameBranch: () =>
Promise<void>
Defined in: features/git/types.ts:182
Returns
Promise<void>
CommitSlice
Defined in: features/git/types.ts:187
Properties
_executePostCommit
_executePostCommit: () =>
Promise<void>
Defined in: features/git/types.ts:190
Returns
Promise<void>
_validateUserConfig
_validateUserConfig: (
cwd) =>Promise<boolean>
Defined in: features/git/types.ts:191
Parameters
cwd
string
Returns
Promise<boolean>
abortRebase
abortRebase: () =>
Promise<void>
Defined in: features/git/types.ts:200
Returns
Promise<void>
commit
commit: (
opts?) =>Promise<void>
Defined in: features/git/types.ts:193
Parameters
opts?
all?
boolean
signoff?
boolean
Returns
Promise<void>
commitAmend
commitAmend: (
opts?) =>Promise<void>
Defined in: features/git/types.ts:194
Parameters
opts?
all?
boolean
signoff?
boolean
Returns
Promise<void>
commitAndPush
commitAndPush: () =>
Promise<void>
Defined in: features/git/types.ts:196
Returns
Promise<void>
commitAndSync
commitAndSync: () =>
Promise<void>
Defined in: features/git/types.ts:197
Returns
Promise<void>
recentCommits
recentCommits:
GitCommit[]
Defined in: features/git/types.ts:188
undoLastCommit
undoLastCommit: () =>
Promise<void>
Defined in: features/git/types.ts:198
Returns
Promise<void>
GitBranch
Defined in: features/git/types.ts:33
Represents metadata payload for a specific Git branch instance.
Properties
ahead
ahead:
number
Defined in: features/git/types.ts:43
Count of localized commits waiting to be pushed upstream.
behind
behind:
number
Defined in: features/git/types.ts:45
Count of remote server commits waiting to be synchronized locally.
isCurrent
isCurrent:
boolean
Defined in: features/git/types.ts:39
True if this is the active checked-out branch in the current HEAD reference.
isRemote
isRemote:
boolean
Defined in: features/git/types.ts:37
Sentinel flag confirming if the branch resides exclusively on the upstream server.
name
name:
string
Defined in: features/git/types.ts:35
Plain-text name designation of the branch tracking pointer.
upstream?
optionalupstream?:string
Defined in: features/git/types.ts:41
Named tracking target identifier assigned to this branch on remote clusters.
GitChangedFile
Defined in: features/git/types.ts:19
Interface contract tracking metadata for individual changed files in a repository.
Properties
name
name:
string
Defined in: features/git/types.ts:23
Individual baseline filename including its file extension.
oldPath?
optionaloldPath?:string
Defined in: features/git/types.ts:27
Populated only during rename states to track historical layout targets.
path
path:
string
Defined in: features/git/types.ts:21
Workspace relative canonical path to the file.
status
status:
GitFileStatus
Defined in: features/git/types.ts:25
Current active Git modification tree state mapping.
GitCommit
Defined in: features/git/types.ts:51
Interface mapping individual revision details in the Git log registry sequence.
Properties
author
author:
string
Defined in: features/git/types.ts:59
Named metadata context identifying the commit owner.
date
date:
string
Defined in: features/git/types.ts:61
Fully formatted ISO timestamp marking the exact completion pass window.
hash
hash:
string
Defined in: features/git/types.ts:53
Complete 40-character hexadecimal representation string of the commit hash.
message
message:
string
Defined in: features/git/types.ts:57
Plain text explanation description written by the committer.
shortHash
shortHash:
string
Defined in: features/git/types.ts:55
Condensed short hash identifier representation (typically first 7 characters).
GitRepository
Defined in: features/git/types.ts:77
Tracks root metadata profiles for active submodules or multi-root Git repository targets.
Properties
ahead
ahead:
number
Defined in: features/git/types.ts:87
Outgoing local tracking node offset index metric.
behind
behind:
number
Defined in: features/git/types.ts:89
Incoming remote server revision synchronization lag evaluation matrix.
branch
branch:
string
Defined in: features/git/types.ts:85
Text pointer showing the current checking branch state on the layout.
id
id:
string
Defined in: features/git/types.ts:79
Absolute hash token or internal routing signature key.
name
name:
string
Defined in: features/git/types.ts:81
Individual readable workspace naming context assigned to the target folder.
path
path:
string
Defined in: features/git/types.ts:83
Absolute operating system physical folder pathway routing target.
GitStash
Defined in: features/git/types.ts:67
Profile model encapsulating stashed modifications saved inside the local cache stack.
Properties
description
description:
string
Defined in: features/git/types.ts:71
Plain descriptive label tracking user annotations or branch references on stash actions.
index
index:
number
Defined in: features/git/types.ts:69
Sequential placement index locator evaluating the stack trace coordinate.
GitStatusMetadata
Defined in: features/git/types.ts:98
Structural definition schema for the visual decorations mapping specific Git modification states.
Properties
badge
badge:
string
Defined in: features/git/types.ts:100
Singular alphanumeric character representing the modification type shorthand (e.g. 'M', 'A').
color
color:
string
Defined in: features/git/types.ts:102
Hexadecimal or variable-bound CSS design token color code for typographic painting.
decoration
decoration:
"normal"|"line-through"
Defined in: features/git/types.ts:106
Standard CSS text-decoration parameters applied onto the rendering view line frames.
label
label:
string
Defined in: features/git/types.ts:104
Human-readable text string naming the precise modification state.
style
style:
"normal"|"italic"
Defined in: features/git/types.ts:108
Typographic rendering styles applied dynamically onto font layout rendering pipelines.
RemoteSlice
Defined in: features/git/types.ts:203
Properties
addRemote
addRemote: () =>
Promise<void>
Defined in: features/git/types.ts:213
Returns
Promise<void>
fetch
fetch: () =>
Promise<void>
Defined in: features/git/types.ts:204
Returns
Promise<void>
fetchAll
fetchAll: () =>
Promise<void>
Defined in: features/git/types.ts:206
Returns
Promise<void>
fetchPrune
fetchPrune: () =>
Promise<void>
Defined in: features/git/types.ts:205
Returns
Promise<void>
pull
pull: () =>
Promise<void>
Defined in: features/git/types.ts:207
Returns
Promise<void>
pullFrom
pullFrom: () =>
Promise<void>
Defined in: features/git/types.ts:209
Returns
Promise<void>
pullRebase
pullRebase: () =>
Promise<void>
Defined in: features/git/types.ts:208
Returns
Promise<void>
push
push: () =>
Promise<void>
Defined in: features/git/types.ts:210
Returns
Promise<void>
pushTo
pushTo: () =>
Promise<void>
Defined in: features/git/types.ts:211
Returns
Promise<void>
removeRemote
removeRemote: () =>
Promise<void>
Defined in: features/git/types.ts:214
Returns
Promise<void>
sync
sync: () =>
Promise<void>
Defined in: features/git/types.ts:212
Returns
Promise<void>
RepoSlice
Defined in: features/git/types.ts:217
Properties
cloneRepo
cloneRepo: () =>
Promise<void>
Defined in: features/git/types.ts:219
Returns
Promise<void>
createTag
createTag: () =>
Promise<void>
Defined in: features/git/types.ts:222
Returns
Promise<void>
deleteTag
deleteTag: () =>
Promise<void>
Defined in: features/git/types.ts:223
Returns
Promise<void>
initRepo
initRepo: () =>
Promise<void>
Defined in: features/git/types.ts:218
Returns
Promise<void>
publishBranch
publishBranch: () =>
Promise<void>
Defined in: features/git/types.ts:220
Returns
Promise<void>
pushTags
pushTags: () =>
Promise<void>
Defined in: features/git/types.ts:224
Returns
Promise<void>
StatusSlice
Defined in: features/git/types.ts:140
Properties
applyStash
applyStash: (
latest?) =>Promise<void>
Defined in: features/git/types.ts:163
Parameters
latest?
boolean
Returns
Promise<void>
discardAll
discardAll: () =>
Promise<void>
Defined in: features/git/types.ts:160
Returns
Promise<void>
discardFile
discardFile: (
path) =>Promise<void>
Defined in: features/git/types.ts:159
Parameters
path
string
Returns
Promise<void>
dropAllStashes
dropAllStashes: () =>
Promise<void>
Defined in: features/git/types.ts:166
Returns
Promise<void>
dropStash
dropStash: () =>
Promise<void>
Defined in: features/git/types.ts:165
Returns
Promise<void>
error
error:
string|null
Defined in: features/git/types.ts:144
hasUpstream
hasUpstream:
boolean
Defined in: features/git/types.ts:147
isGitRepo
isGitRepo:
boolean
Defined in: features/git/types.ts:141
isLoading
isLoading:
boolean
Defined in: features/git/types.ts:142
isRebasing
isRebasing:
boolean
Defined in: features/git/types.ts:143
popStash
popStash: (
latest?) =>Promise<void>
Defined in: features/git/types.ts:164
Parameters
latest?
boolean
Returns
Promise<void>
refresh
refresh: () =>
Promise<void>
Defined in: features/git/types.ts:153
Returns
Promise<void>
repositories
repositories:
GitRepository[]
Defined in: features/git/types.ts:148
showPartiallyStaged
showPartiallyStaged:
boolean
Defined in: features/git/types.ts:151
stageAll
stageAll: () =>
Promise<void>
Defined in: features/git/types.ts:157
Returns
Promise<void>
stagedFiles
stagedFiles:
GitChangedFile[]
Defined in: features/git/types.ts:145
stageFile
stageFile: (
path) =>Promise<void>
Defined in: features/git/types.ts:155
Parameters
path
string
Returns
Promise<void>
stash
stash: (
opts?) =>Promise<void>
Defined in: features/git/types.ts:162
Parameters
opts?
includeUntracked?
boolean
staged?
boolean
Returns
Promise<void>
stashes
stashes:
GitStash[]
Defined in: features/git/types.ts:149
tags
tags:
string[]
Defined in: features/git/types.ts:150
unstageAll
unstageAll: () =>
Promise<void>
Defined in: features/git/types.ts:158
Returns
Promise<void>
unstagedFiles
unstagedFiles:
GitChangedFile[]
Defined in: features/git/types.ts:146
unstageFile
unstageFile: (
path) =>Promise<void>
Defined in: features/git/types.ts:156
Parameters
path
string
Returns
Promise<void>
viewStash
viewStash: (
index?) =>Promise<void>
Defined in: features/git/types.ts:167
Parameters
index?
number
Returns
Promise<void>
UISlice
Defined in: features/git/types.ts:128
Properties
commitMessage
commitMessage:
string
Defined in: features/git/types.ts:129
setCommitMessage
setCommitMessage: (
msg) =>void
Defined in: features/git/types.ts:134
Parameters
msg
string
Returns
void
setSortMode
setSortMode: (
mode) =>void
Defined in: features/git/types.ts:137
Parameters
mode
Returns
void
showChanges
showChanges:
boolean
Defined in: features/git/types.ts:131
showRepositories
showRepositories:
boolean
Defined in: features/git/types.ts:130
sortMode
sortMode:
GitSortMode
Defined in: features/git/types.ts:132
toggleChanges
toggleChanges: () =>
void
Defined in: features/git/types.ts:136
Returns
void
toggleRepositories
toggleRepositories: () =>
void
Defined in: features/git/types.ts:135
Returns
void
Type Aliases
GitFileStatus
GitFileStatus =
"modified"|"untracked"|"added"|"deleted"|"renamed"|"conflicted"
Defined in: features/git/types.ts:8
Represents the standard Git status classifications for tracked and untracked files within the workspace subsystem.
GitSortMode
GitSortMode =
"discovery"|"name"|"path"
Defined in: features/git/types.ts:93
Specifies available rendering sorting criteria paradigms inside the Changes panel views.
GitState
GitState =
UISlice&StatusSlice&BranchSlice&CommitSlice&RemoteSlice&RepoSlice
Defined in: features/git/types.ts:228
Combined macro-type pipeline packaging all functional sub-slices cleanly inside a singular state object map.
Variables
GIT_STATUS_META
constGIT_STATUS_META:Record<GitFileStatus,GitStatusMetadata>
Defined in: features/git/types.ts:117
Global Metadata Dictionary map binding Git status metrics safely with responsive CSS design tokens. Used consistently across file explorer graphs, tabs, and staging lists to render uniform code contexts.