Eric Amodio a2bea09f58 | 5 years ago | ||
---|---|---|---|
.github | 删除 | 5 years ago | |
.vscode | 删除 | 5 years ago | |
images | 删除 | 5 years ago | |
src | 删除 | 5 years ago | |
test | 删除 | 6 years ago | |
.eslintignore | 5 years ago | ||
.eslintrc.json | 5 years ago | ||
.gitattributes | 5 years ago | ||
.gitignore | 5 years ago | ||
.mailmap | 5 years ago | ||
.prettierignore | 6 years ago | ||
.prettierrc | 6 years ago | ||
.vscodeignore | 5 years ago | ||
BACKERS.md | 5 years ago | ||
CHANGELOG.md | 5 years ago | ||
CODE_OF_CONDUCT.md | 6 years ago | ||
CONTRIBUTING.md | 5 years ago | ||
LICENSE | 6 years ago | ||
README.md | 5 years ago | ||
generateEmojiShortcodeMap.js | 5 years ago | ||
package.json | 5 years ago | ||
tsconfig.json | 5 years ago | ||
webpack.config.js | 5 years ago | ||
webviews.tsconfig.json | 5 years ago | ||
yarn.lock | 5 years ago |
GitLens supercharges the Git capabilities built into Visual Studio Code. It helps you to visualize code authorship at a glance via Git blame annotations and code lens, seamlessly navigate and explore Git repositories, gain valuable insights via powerful comparison commands, and so much more.
Sponsored by | |
---|---|
|
While GitLens is generously offered to everyone free of charge, if you find it useful, please consider supporting it.
Also please write a review, star me on GitHub, and follow me on Twitter
See the release notes for the full set of changes
GitLens is an open-source extension for Visual Studio Code created by Eric Amodio.
GitLens simply helps you better understand code. Quickly glimpse into whom, why, and when a line or code block was changed. Jump back through history to gain further insights as to how and why the code evolved. Effortlessly explore the history and evolution of a codebase.
While GitLens is powerful and feature rich, it is also highly customizable to meet your specific needs — find code lens intrusive or the current line blame annotation distracting — no problem, it is quick and easy to turn them off or change how they behave via the built-in GitLens Settings editor, an interactive editor covering many of GitLens' powerful settings. While for more advanced customizations, refer to the GitLens settings docs and edit your vscode user settings.
Here are just some of the features that GitLens provides,
GitLens has a built-in interactive settings editor which provides an easy-to-use interface to configure many of GitLens' powerful features. It can be accessed via the Open Settings (gitlens.showSettingsPage
) command from the Command Palette.
For more advanced customizations, refer to the settings documentation below.
gitlens.toggleLineBlame
) to toggle the blame annotation on and off
gitlens.toggleFileBlame
) with a shortcut of alt+b
to toggle the blame annotations on and offEscape
to turn off the annotations
Adds Git authorship code lens to the top of the file and on code blocks (optional, on by default)
Recent Change — author and date of the most recent commit for the file or code block
Authors — number of authors of the file or code block and the most prominent author (if there is more than one)
Provides customizable click behavior for each code lens — choose between one of the following
Adds a Toggle Git Code Lens command (gitlens.toggleCodeLens
) with a shortcut of shift+alt+b
to toggle the code lens on and off
gitlens.toggleFileHeatmap
) to toggle the heatmap on and offEscape
to turn off the annotations
gitlens.toggleFileRecentChanges
) to toggle the recent changes annotations on and offEscape
to turn off the annotations
Adds a customizable Git blame annotation about the current line to the status bar (optional, on by default)
Contains the commit author and date (by default)
Click the status bar item to show a commit details quick pick menu with commands for comparing, navigating and exploring commits, and more (by default)
Provides customizable click behavior — choose between one of the following
A customizable view to visualize, navigate, and explore Git repositories
The repositories view provides the following features,
Repositories — lists the opened repositories
alt-click
for Push (force)), Pull, and Fetch commandsalt-click
for Push (force)) commandalt-click
for Copy Commit Message to Clipboard), and Open File on Remote (if available) commandsBranches — lists the local branches in the repository
alt-click
for Compare with Working Tree), and Open Branch on Remote (if available) commandsalt-click
for Compare with Working Tree), Copy Commit ID to Clipboard (alt-click
for Copy Commit Message to Clipboard), and Open Commit on Remote (if available) commandsalt-click
for Copy Commit Message to Clipboard), and Open File on Remote (if available) commandsContributors — lists the contributors in the repository, sorted by contributed commits
alt-click
for Compare with Working Tree), Copy Commit ID to Clipboard (alt-click
for Copy Commit Message to Clipboard), and Open Commit on Remote (if available) commandsalt-click
for Copy Commit Message to Clipboard), and Open File on Remote (if available) commandsIncoming Activity — lists the recent incoming activity (merges and pulls) to your local repository (experimental, enabled via "gitlens.insiders": true
)
alt-click
for Compare with Working Tree), Copy Commit ID to Clipboard (alt-click
for Copy Commit Message to Clipboard), and Open Commit on Remote (if available) commandsalt-click
for Copy Commit Message to Clipboard), and Open File on Remote (if available) commandsRemotes — lists the remotes in the repository
Stashes — lists the stashed changes in the repository
alt-click
for Compare with Working Tree), Apply Stashed Changes, and Delete Stashed Changes commandsTags — lists the tags in the repository
alt-click
for Compare with Working Tree) commandsalt-click
for Compare with Working Tree), Copy Commit ID to Clipboard (alt-click
for Copy Commit Message to Clipboard), and Open Commit on Remote (if available) commandsalt-click
for Copy Commit Message to Clipboard), and Open File on Remote (if available) commands
A customizable view to visualize, navigate, and explore the revision history of the current file
The file history view provides the following features,
alt-click
for Compare with Working Tree), Copy Commit ID to Clipboard (alt-click
for Copy Commit Message to Clipboard), and Open Commit on Remote (if available) commandsalt-click
for Copy Commit Message to Clipboard), and Open File on Remote (if available) commands
A customizable view to visualize, navigate, and explore the revision history of the selected lines of current file
The line history view provides the following features,
alt-click
for Compare with Working Tree), Copy Commit ID to Clipboard (alt-click
for Copy Commit Message to Clipboard), and Open Commit on Remote (if available) commandsalt-click
for Copy Commit Message to Clipboard), and Open File on Remote (if available) commands
A customizable view to search and explore commit histories by message, author, files, id, etc
gitlens.showCommitSearch
) with a shortcut of alt+/
to search for commits
<message>
to search for commits with messages that match <message>
— See Git docs@<pattern>
to search for commits with authors that match <pattern>
— See Git docs#<sha>
to search for a commit with id of <sha>
— See Git docs:<path/glob>
to search for commits with file names that match <path/glob>
— See Git docs~<pattern>
to search for commits with differences whose patch text contains added/removed lines that match <pattern>
— See Git docsThe search commits view provides the following features,
alt-click
for Compare with Working Tree), Copy Commit ID to Clipboard (alt-click
for Copy Commit Message to Clipboard), and Open Commit on Remote (if available) commandsalt-click
for Copy Commit Message to Clipboard), and Open File on Remote (if available) commandsgitlens.showCommitSearch
)gitlens.showQuickFileHistory
)gitlens.showQuickCommitDetails
)
A customizable view to visualize comparisons between branches, tags, commits, and more
The compare view provides the following features,
alt-click
for Copy Commit Message to Clipboard), and Open File on Remote (if available) commandsgitlens.views.compareWithRemote
)gitlens.views.compareWithHead
)gitlens.views.compareWithWorking
)gitlens.views.compareWithSelected
)gitlens.views.compareAncestryWithWorking
)gitlens.switchMode
) to quickly switch the active modegitlens.toggleZenMode
) to toggle Zen modegitlens.toggleReviewMode
) to toggle Review modeAdds a Show Last Opened Quick Pick command (gitlens.showLastQuickPick
) with a shortcut of alt+-
to quickly get back to where you were when the last GitLens quick pick menu closed
Adds commands to Open files, commits, branches, and the repository on the supported remote services, Bitbucket, GitHub, GitLab, and Azure DevOps or a user-defined remote services — only available if a Git upstream service is configured in the repository
gitlens.openBranchesInRemote
) — opens the branches on the supported remote servicegitlens.openBranchInRemote
) — opens the current branch commits on the supported remote servicegitlens.openCommitInRemote
) — opens the commit revision of the current line on the supported remote servicegitlens.openFileInRemote
) — opens the current file/revision on the supported remote servicegitlens.openRepoInRemote
) — opens the repository on the supported remote service
Adds a Show Current Branch History command (gitlens.showQuickRepoHistory
) with a shortcut of shift+alt+h
to show a paged branch history quick pick menu of the current branch for exploring its commit history
alt+left arrow
, if availablealt+,
and alt+.
to go backward and forward respectivelyAdds a Show Branch History command (gitlens.showQuickBranchHistory
) to show a paged branch history quick pick menu of the selected branch for exploring its commit history
gitlens.showQuickFileHistory
) to show a paged file history quick pick menu of the current file for exploring its commit history
alt+left arrow
, if availablealt+,
and alt+.
to go backward and forward respectively
gitlens.showQuickCommitDetails
) to show a commit details quick pick menu of the most recent commit of the current file
alt+left arrow
, if availablealt+right arrow
shortcut on an entry to execute it without closing the quick pick menu, if possible — commands that open windows outside of VS Code will still close the quick pick menu unless "gitlens.advanced.quickPick.closeOnFocusOut": false
is setalt+right arrow
shortcut on a file entry in the Changed Files
section to preview the comparison of the current revision with the previous one
gitlens.showQuickCommitFileDetails
) with a shortcut of alt+c
to show a file commit details quick pick menu of the most recent commit of the current file
alt+left arrow
, if availablealt+right arrow
shortcut on an entry to execute it without closing the quick pick menu, if possible — commands that open windows outside of VS Code will still close the quick pick menu unless "gitlens.advanced.quickPick.closeOnFocusOut": false
is set
gitlens.showQuickRepoStatus
) with a shortcut of alt+s
to show a repository status quick pick menu for visualizing the current repository status
alt+right arrow
shortcut on an entry to execute it without closing the quick pick menu, if possible — commands that open windows outside of VS Code will still close the quick pick menu unless "gitlens.advanced.quickPick.closeOnFocusOut": false
is setalt+right arrow
shortcut on a file entry in the Staged Files
or Unstaged Files
sections to preview the comparison of the working file with the previous revision
Adds a Show Stashed Changes command (gitlens.showQuickStashList
) to show a stashed changes quick pick menu for exploring your repository stash history
alt+left arrow
, if availableAdds a Stash All Changes command (gitlens.stashSave
) to save any working tree changes to the stash — can optionally provide a stash message
Stashed changes show a stash details quick pick menu which is very similar to the commit details quick pick menu above
alt+left arrow
, if availablealt+right arrow
shortcut on an entry to execute it without closing the quick pick menu, if possible — commands that open windows outside of VS Code will still close the quick pick menu unless "gitlens.advanced.quickPick.closeOnFocusOut": false
is setalt+right arrow
shortcut on a file entry in the Changed Files
section to preview the comparison of the current revision with the previous oneAdds an Apply Stashed Changes command (gitlens.stashApply
) to chose a stash entry to apply to the working tree from a quick pick menu
Effortlessly navigate between comparisons via the alt+,
and alt+.
shortcut keys to go back and forth through a file's revisions
Provides easy access to the following comparison commands via the Command Palette
as well as in context via the many provided quick pick menus
Adds a Directory Compare Working Tree with... command (gitlens.diffDirectory
) to open the configured Git difftool to compare the working tree with the selected reference
Adds a Compare HEAD with... command (gitlens.diffHeadWith
) to compare the index (HEAD) with the selected reference
Adds a Compare Working Tree with... command (gitlens.diffWorkingWith
) to compare the working tree with the selected reference
Adds an Open Changes with... command (gitlens.diffWithRef
) to compare the current file with the same file on the selected reference
Adds an Open Changes with Next Revision command (gitlens.diffWithNext
) with a shortcut of alt+.
to compare the current file/diff with the next commit revision
Adds an Open Changes with Previous Revision command (gitlens.diffWithPrevious
) with a shortcut of alt+,
to compare the current file/diff with the previous commit revision
Adds an Open Line Changes with Previous Revision command (gitlens.diffLineWithPrevious
) with a shortcut of shift+alt+,
to compare the current file/diff with the previous line commit revision
Adds an Open Changes with Revision... command (gitlens.diffWithRevision
) to compare the current file with the selected revision of the same file
Adds an Open Changes with Working File command (gitlens.diffWithWorking
) with a shortcut of shift+alt+w
to compare the most recent commit revision of the current file/diff with the working tree
Adds an Open Line Changes with Working File command (gitlens.diffLineWithWorking
) with a shortcut of alt+w
to compare the commit revision of the current line with the working tree
Adds a Copy Commit ID to Clipboard command (gitlens.copyShaToClipboard
) to copy the commit id (sha) of the current line to the clipboard or from the most recent commit to the current branch, if there is no current editor
Adds a Copy Commit Message to Clipboard command (gitlens.copyMessageToClipboard
) to copy the commit message of the current line to the clipboard or from the most recent commit to the current branch, if there is no current editor
Adds a Copy Remote Url to Clipboard command (gitlens.copyRemoteFileUrlToClipboard
) to copy the remote url of the current file and line to the clipboard
Adds an Open Working File" command (gitlens.openWorkingFile
) to open the working file for the current file revision
Adds an Open Revision... command (gitlens.openFileRevision
) to open the selected revision for the current file
Adds an Open Revision from... command (gitlens.openFileRevisionFrom
) to open the revision of the current file from the selected reference
Adds an Open Changes (with difftool) command (gitlens.externalDiff
) to the source control group and source control resource context menus to open the changes of a file or set of files with the configured git difftool
Adds an Open All Changes (with difftool) command (gitlens.externalDiffAll
) to open all working changes with the configured git difftool
Adds an Directory Compare All Changes command (gitlens.diffDirectoryWithHead
) to the source control groups to open the configured Git difftool to compare the working tree with HEAD
Adds a Open Changed Files command (gitlens.openChangedFiles
) to open any files with working tree changes
Adds a Close Unchanged Files command (gitlens.closeUnchangedFiles
) to close any files without working tree changes
GitLens is highly customizable and provides many configuration settings to allow the personalization of almost all features.
Name | Description |
---|---|
gitlens.defaultDateFormat |
Specifies how absolute dates will be formatted by default. See the Moment.js docs for valid formats |
gitlens.defaultDateShortFormat |
Specifies how short absolute dates will be formatted by default. See the Moment.js docs for valid formats |
gitlens.defaultDateStyle |
Specifies how dates will be displayed by default |
gitlens.defaultDateSource |
Specifies whether commit dates should use the authored or committed date |
gitlens.defaultGravatarsStyle |
Specifies the style of the gravatar default (fallback) imagesidenticon - a geometric patternmm - a simple, cartoon-style silhouetted outline of a person (does not vary by email hash)monsterid - a monster with different colors, faces, etcretro - 8-bit arcade-style pixelated facesrobohash - a robot with different colors, faces, etcwavatar - a face with differing features and backgrounds |
gitlens.insiders |
Specifies whether to enable experimental features |
gitlens.keymap |
Specifies the keymap to use for GitLens shortcut keysalternate - adds an alternate set of shortcut keys that start with Alt (⌥ on macOS)chorded - adds a chorded set of shortcut keys that start with Ctrl+Shift+G (⌥⌘G on macOS)none - no shortcut keys will be added |
gitlens.liveshare.allowGuestAccess |
Specifies whether to allow guest access to GitLens features when using Visual Studio Live Share |
gitlens.menus |
Specifies which commands will be added to which menus |
gitlens.outputLevel |
Specifies how much (if any) output will be sent to the GitLens output channel |
gitlens.showWhatsNewAfterUpgrades |
Specifies whether to show What's New after upgrading to new feature releases |
Name | Description |
---|---|
gitlens.currentLine.dateFormat |
Specifies how to format absolute dates (e.g. using the ${date} token) for the current line blame annotations. See the Moment.js docs for valid formats |
gitlens.currentLine.enabled |
Specifies whether to provide a blame annotation for the current line, by default. Use the Toggle Line Blame Annotations command (gitlens.toggleLineBlame ) to toggle the annotations on and off for the current window |
gitlens.currentLine.format |
Specifies the format of the current line blame annotation. See Commit Tokens in the GitLens docs. Date formatting is controlled by the gitlens.currentLine.dateFormat setting |
gitlens.currentLine.scrollable |
Specifies whether the current line blame annotation can be scrolled into view when it is outside the viewport |
Name | Description |
---|---|
gitlens.blame.avatars |
Specifies whether to show avatar images in the gutter blame annotations |
gitlens.blame.compact |
Specifies whether to compact (deduplicate) matching adjacent gutter blame annotations |
gitlens.blame.dateFormat |
Specifies how to format absolute dates (e.g. using the ${date} token) in gutter blame annotations. See the Moment.js docs for valid formats |
gitlens.blame.format |
Specifies the format of the gutter blame annotations. See Commit Tokens in the GitLens docs. Date formatting is controlled by the gitlens.blame.dateFormat setting |
gitlens.blame.heatmap.enabled |
Specifies whether to provide a heatmap indicator in the gutter blame annotations |
gitlens.blame.heatmap.location |
Specifies where the heatmap indicators will be shown in the gutter blame annotationsleft - adds a heatmap indicator on the left edge of the gutter blame annotationsright - adds a heatmap indicator on the right edge of the gutter blame annotations |
gitlens.blame.highlight.enabled |
Specifies whether to highlight lines associated with the current line |
gitlens.blame.highlight.locations |
Specifies where the associated line highlights will be showngutter - adds a gutter glyphline - adds a full-line highlight background coloroverview - adds a decoration to the overview ruler (scroll bar) |
gitlens.blame.ignoreWhitespace |
Specifies whether to ignore whitespace when comparing revisions during blame operations |
gitlens.blame.separateLines |
Specifies whether gutter blame annotations will have line separators |
gitlens.blame.toggleMode |
Specifies how the gutter blame annotations will be toggledfile - toggles each file individuallywindow - toggles the window, i.e. all files at once |
Name | Description |
---|---|
gitlens.hovers.annotations.changes |
Specifies whether to provide a changes (diff) hover for all lines when showing blame annotations |
gitlens.hovers.annotations.details |
Specifies whether to provide a commit details hover for all lines when showing blame annotations |
gitlens.hovers.annotations.enabled |
Specifies whether to provide any hovers when showing blame annotations |
gitlens.hovers.annotations.over |
Specifies when to trigger hovers when showing blame annotationsannotation - only shown when hovering over the line annotationline - shown when hovering anywhere over the line |
gitlens.hovers.avatars |
Specifies whether to show avatar images in hovers |
gitlens.hovers.changesDiff |
Specifies whether to show just the changes to the line or the set of related changes in the changes (diff) hoverline - Shows only the changes to the linehunk - Shows the set of related changes |
gitlens.hovers.currentLine.changes |
Specifies whether to provide a changes (diff) hover for the current line |
gitlens.hovers.currentLine.details |
Specifies whether to provide a commit details hover for the current line |
gitlens.hovers.currentLine.enabled |
Specifies whether to provide any hovers for the current line |
gitlens.hovers.currentLine.over |
Specifies when to trigger hovers for the current lineannotation - only shown when hovering over the line annotationline - shown when hovering anywhere over the line |
gitlens.hovers.enabled |
Specifies whether to provide any hovers |
gitlens.hovers.detailsMarkdownFormat |
Specifies the format (in markdown) of the commit details hover. See Commit Tokens in the GitLens docs |
Name | Description |
---|---|
gitlens.codeLens.authors.command |
Specifies the command to be executed when an authors code lens is clickedgitlens.toggleFileBlame - toggles file blame annotationsgitlens.diffWithPrevious - compares the current committed file with the previous commitgitlens.showQuickCommitDetails - shows a commit details quick pickgitlens.showQuickCommitFileDetails - shows a commit file details quick pickgitlens.showQuickFileHistory - shows a file history quick pickgitlens.showQuickRepoHistory - shows a branch history quick pick |
gitlens.codeLens.authors.enabled |
Specifies whether to provide an authors code lens, showing number of authors of the file or code block and the most prominent author (if there is more than one) |
gitlens.codeLens.enabled |
Specifies whether to provide any Git code lens, by default. Use the Toggle Git Code Lens command (gitlens.toggleCodeLens ) to toggle the Git code lens on and off for the current window |
gitlens.codeLens.includeSingleLineSymbols |
Specifies whether to provide any Git code lens on symbols that span only a single line |
gitlens.codeLens.recentChange.command |
Specifies the command to be executed when a recent change code lens is clickedgitlens.toggleFileBlame - toggles file blame annotationsgitlens.diffWithPrevious - compares the current committed file with the previous commitgitlens.showQuickCommitDetails - shows a commit details quick pickgitlens.showQuickCommitFileDetails - shows a commit file details quick pickgitlens.showQuickFileHistory - shows a file history quick pickgitlens.showQuickRepoHistory - shows a branch history quick pick |
gitlens.codeLens.recentChange.enabled |
Specifies whether to provide a recent change code lens, showing the author and date of the most recent commit for the file or code block |
gitlens.codeLens.scopes |
Specifies where Git code lens will be shown in the documentdocument - adds code lens at the top of the documentcontainers - adds code lens at the start of container-like symbols (modules, classes, interfaces, etc)blocks - adds code lens at the start of block-like symbols (functions, methods, etc) lines |
gitlens.codeLens.scopesByLanguage |
Specifies where Git code lens will be shown in the document for the specified languages |
gitlens.codeLens.symbolScopes |
Specifies a set of document symbols where Git code lens will or will not be shown in the document. Prefix with ! to avoid providing a Git code lens for the symbol. Must be a member of SymbolKind |
Name | Description |
---|---|
gitlens.heatmap.ageThreshold |
Specifies the age of the most recent change (in days) after which the gutter heatmap annotations will be cold rather than hot (i.e. will use gitlens.heatmap.coldColor instead of gitlens.heatmap.hotColor ) |
gitlens.heatmap.coldColor |
Specifies the base color of the gutter heatmap annotations when the most recent change is older (cold) than the gitlens.heatmap.ageThreshold value |
gitlens.heatmap.hotColor |
Specifies the base color of the gutter heatmap annotations when the most recent change is newer (hot) than the gitlens.heatmap.ageThreshold value |
gitlens.heatmap.toggleMode |
Specifies how the gutter heatmap annotations will be toggledfile - toggles each file individuallywindow - toggles the window, i.e. all files at once |
Name | Description |
---|---|
gitlens.recentChanges.highlight.locations |
Specifies where the highlights of the recently changed lines will be showngutter - adds a gutter glyphline - adds a full-line highlight background coloroverview - adds a decoration to the overview ruler (scroll bar) |
gitlens.recentChanges.toggleMode |
Specifies how the recently changed lines annotations will be toggledfile - toggles each file individuallywindow - toggles the window, i.e. all files at once |
Name | Description |
---|---|
gitlens.statusBar.alignment |
Specifies the blame alignment in the status barleft - aligns to the leftright - aligns to the right |
gitlens.statusBar.command |
Specifies the command to be executed when the blame status bar item is clickedgitlens.toggleFileBlame - toggles file blame annotationsgitlens.diffWithPrevious - compares the current line commit with the previousgitlens.diffWithWorking - compares the current line commit with the working treegitlens.toggleCodeLens - toggles Git code lensgitlens.showQuickCommitDetails - shows a commit details quick pickgitlens.showQuickCommitFileDetails - shows a commit file details quick pickgitlens.showQuickFileHistory - shows a file history quick pickgitlens.showQuickRepoHistory - shows a branch history quick pick |
gitlens.statusBar.dateFormat |
Specifies how to format absolute dates (e.g. using the ${date} token) in the blame information in the status bar. See the Moment.js docs for valid formats |
gitlens.statusBar.enabled |
Specifies whether to provide blame information in the status bar |
gitlens.statusBar.format |
Specifies the format of the blame information in the status bar. See Commit Tokens in the GitLens docs. Date formatting is controlled by the gitlens.statusBar.dateFormat setting |
gitlens.statusBar.reduceFlicker |
Specifies whether to avoid clearing the previous blame information when changing lines to reduce status bar "flashing" |
See also View Settings
Name | Description |
---|---|
gitlens.views.repositories.avatars |
Specifies whether to show avatar images instead of commit (or status) icons in the Repositories view |
gitlens.views.repositories.autoRefresh |
Specifies whether to automatically refresh the Repositories view when the repository or the file system changes |
gitlens.views.repositories.autoReveal |
Specifies whether to automatically reveal repositories in the Repositories view when opening files |
gitlens.views.repositories.branches.layout |
Specifies how the Repositories view will display brancheslist - displays branches as a listtree - displays branches as a tree when branch names contain slashes / |
gitlens.views.repositories.compact |
Specifies whether to show the Repositories view in a compact display density |
gitlens.views.repositories.enabled |
Specifies whether to show the Repositories view |
gitlens.views.repositories.files.compact |
Specifies whether to compact (flatten) unnecessary file nesting in the Repositories view. Only applies when gitlens.views.repositories.files.layout is set to tree or auto |
gitlens.views.repositories.files.layout |
Specifies how the Repositories view will display filesauto - automatically switches between displaying files as a tree or list based on the gitlens.views.repositories.files.threshold value and the number of files at each nesting levellist - displays files as a listtree - displays files as a tree |
gitlens.views.repositories.files.threshold |
Specifies when to switch between displaying files as a tree or list based on the number of files in a nesting level in the Repositories view. Only applies when gitlens.views.repositories.files.layout is set to auto |
gitlens.views.repositories.includeWorkingTree |
Specifies whether to include working tree file status for each repository in the Repositories view |
gitlens.views.repositories.location |
Specifies where to show the Repositories viewgitlens - adds to the GitLens side barexplorer - adds to the Explorer side barscm - adds to the Source Control side bar |
gitlens.views.repositories.showBranchComparison |
Specifies whether to show a comparison of a user-selected reference (branch, tag. etc) to the current branch or the working tree in the Repositories view |
gitlens.views.repositories.showTrackingBranch |
Specifies whether to show the tracking branch when displaying local branches in the Repositories view |
See also View Settings
Name | Description |
---|---|
gitlens.views.fileHistory.avatars |
Specifies whether to show avatar images instead of status icons in the File History view |
gitlens.views.fileHistory.enabled |
Specifies whether to show the File History view |
gitlens.views.fileHistory.location |
Specifies where to show the File History viewgitlens - adds to the GitLens side barexplorer - adds to the Explorer side barscm - adds to the Source Control side bar |
See also View Settings
Name | Description |
---|---|
gitlens.views.lineHistory.avatars |
Specifies whether to show avatar images instead of status icons in the Line History view |
gitlens.views.lineHistory.enabled |
Specifies whether to show the Line History view |
gitlens.views.lineHistory.location |
Specifies where to show the Line History viewgitlens - adds to the GitLens side barexplorer - adds to the Explorer side barscm - adds to the Source Control side bar |
See also View Settings
Name | Description |
---|---|
gitlens.views.search.avatars |
Specifies whether to show avatar images instead of commit (or status) icons in the Search Commits view |
gitlens.views.search.files.compact |
Specifies whether to compact (flatten) unnecessary file nesting in the Search Commits view Only applies when gitlens.views.compare.files.layout is set to tree or auto |
gitlens.views.search.enabled |
Specifies whether to show the Search Commits view |
gitlens.views.search.files.layout |
Specifies how the Search Commits view will display filesauto - automatically switches between displaying files as a tree or list based on the gitlens.views.compare.files.threshold value and the number of files at each nesting levellist - displays files as a listtree - displays files as a tree |
gitlens.views.compare.files.threshold |
Specifies when to switch between displaying files as a tree or list based on the number of files in a nesting level in the Search Commits viewOnly applies when gitlens.views.compare.files.layout is set to auto |
gitlens.views.search.location |
Specifies where to show the Search Commits viewgitlens - adds to the GitLens side barexplorer - adds to the Explorer side barscm - adds to the Source Control side bar |
See also View Settings
Name | Description |
---|---|
gitlens.views.compare.avatars |
Specifies whether to show avatar images instead of commit (or status) icons in the Compare view |
gitlens.views.compare.files.compact |
Specifies whether to compact (flatten) unnecessary file nesting in the Compare view. Only applies when gitlens.views.compare.files.layout is set to tree or auto |
gitlens.views.compare.enabled |
Specifies whether to show the Compare view |
gitlens.views.compare.files.layout |
Specifies how the Compare view will display filesauto - automatically switches between displaying files as a tree or list based on the gitlens.views.compare.files.threshold value and the number of files at each nesting levellist - displays files as a listtree - displays files as a tree |
gitlens.views.compare.files.threshold |
Specifies when to switch between displaying files as a tree or list based on the number of files in a nesting level in the Compare view. Only applies when gitlens.views.compare.files.layout is set to auto |
gitlens.views.compare.location |
Specifies where to show the Compare viewgitlens - adds to the GitLens side barexplorer - adds to the Explorer side barscm - adds to the Source Control side bar |
Name | Description |
---|---|
gitlens.views.commitFileFormat |
Specifies the format of a committed file in the views. See File Tokens in the GitLens docs |
gitlens.views.commitFileDescriptionFormat |
Specifies the description format of a committed file in the views. See File Tokens in the GitLens docs |
gitlens.views.commitFormat |
Specifies the format of committed changes in the views. See Commit Tokens in the GitLens docs |
gitlens.views.commitDescriptionFormat |
Specifies the description format of committed changes in the views. See Commit Tokens in the GitLens docs |
gitlens.views.defaultItemLimit |
Specifies the default number of items to show in a view list. Use 0 to specify no limit |
gitlens.views.pageItemLimit |
Specifies the number of items to show in a each page when paginating a view list. Use 0 to specify no limit |
gitlens.views.showRelativeDateMarkers |
Specifies whether to show relative date markers (Less than a week ago, Over a week ago, Over a month ago, etc) on revision (commit) histories in the views |
gitlens.views.stashFileFormat |
Specifies the format of a stashed file in the views. See File Tokens in the GitLens docs |
gitlens.views.stashFileDescriptionFormat |
Specifies the description format of a stashed file in the views. See File Tokens in the GitLens docs |
gitlens.views.stashFormat |
Specifies the format of stashed changes in the views. See Commit Tokens in the GitLens docs |
gitlens.views.stashDescriptionFormat |
Specifies the description format of stashed changes in the views. See Commit Tokens in the GitLens docs |
gitlens.views.statusFileFormat |
Specifies the format of the status of a working or committed file in the views. See File Tokens in the GitLens docs |
gitlens.views.statusFileDescriptionFormat |
Specifies the description format of the status of a working or committed file in the views. See File Tokens in the GitLens docs |
Name | Description |
---|---|
gitlens.mode.active |
Specifies the active GitLens mode, if any |
gitlens.mode.statusBar.enabled |
Specifies whether to provide the active GitLens mode in the status bar |
gitlens.mode.statusBar.alignment |
Specifies the active GitLens mode alignment in the status barleft - aligns to the leftright - aligns to the right |
gitlens.modes |
Specifies the user-defined GitLens modes Example — adds heatmap annotations to the built-in Reviewing mode "gitlens.modes": { "review": { "annotations": "heatmap" } } Example — adds a new Annotating mode with blame annotations "gitlens.modes": { "annotate": { "name": "Annotating", "statusBarItemName": "Annotating", "description": "for root cause analysis", "annotations": "blame", "codeLens": false, "currentLine": false, "hovers": true } } |
Name | Description |
---|---|
gitlens.advanced.abbreviatedShaLength |
Specifies the length of abbreviated commit ids (shas) |
gitlens.advanced.blame.customArguments |
Specifies additional arguments to pass to the git blame command |
gitlens.advanced.blame.delayAfterEdit |
Specifies the time (in milliseconds) to wait before re-blaming an unsaved document after an edit. Use 0 to specify an infinite wait |
gitlens.advanced.blame.sizeThresholdAfterEdit |
Specifies the maximum document size (in lines) allowed to be re-blamed after an edit while still unsaved. Use 0 to specify no maximum |
gitlens.advanced.caching.enabled |
Specifies whether git output will be cached — changing the default is not recommended |
gitlens.advanced.fileHistoryFollowsRenames |
Specifies whether file histories will follow renames -- will affect how merge commits are shown in histories |
gitlens.advanced.maxListItems |
Specifies the maximum number of items to show in a list. Use 0 to specify no maximum |
gitlens.advanced.maxSearchItems |
Specifies the maximum number of items to show in a search. Use 0 to specify no maximum |
gitlens.advanced.messages |
Specifies which messages should be suppressed |
gitlens.advanced.quickPick.closeOnFocusOut |
Specifies whether to close QuickPick menus when focus is lost |
gitlens.advanced.repositorySearchDepth |
Specifies how many folders deep to search for repositories |
gitlens.advanced.similarityThreshold |
Specifies the amount (percent) of similarity a deleted and added file pair must have to be considered a rename |
gitlens.advanced.telemetry.enabled |
Specifies whether to enable GitLens telemetry (even if enabled still abides by the overall telemetry.enableTelemetry setting |
gitlens.advanced.useSymmetricDifferenceNotation |
Specifies whether to use the symmetric difference (three-dot) notation or the range (two-dot) notation for comparisons. See the Git docs |
Name | Description |
---|---|
gitlens.remotes |
Specifies user-defined remote (code-hosting) services or custom domains for built-in remote services Example: "gitlens.remotes": [{ "domain": "git.corporate-url.com", "type": "GitHub" }] Example: "gitlens.remotes": [{ "domain": "git.corporate-url.com", "type": "Custom", "name": "My Company", "protocol": "https", "urls": { "repository": "https://git.corporate-url.com/${repo}", "branches": "https://git.corporate-url.com/${repo}/branches", "branch": "https://git.corporate-url.com/${repo}/commits/${branch}", "commit": "https://git.corporate-url.com/${repo}/commit/${id}", "file": "https://git.corporate-url.com/${repo}?path=${file}${line}", "fileInBranch": "https://git.corporate-url.com/${repo}/blob/${branch}/${file}${line}", "fileInCommit": "https://git.corporate-url.com/${repo}/blob/${id}/${file}${line}", "fileLine": "#L${line}", "fileRange": "#L${start}-L${end}" } }] Example: "gitlens.remotes": [{ "domain": "git.corporate-url.com", "type": "Custom", "name": "My Company", "protocol": "https", "urls": { "repository": "https://git.corporate-url.com/projects/${repoBase}/repos/${repoPath}", "branches": "https://git.corporate-url.com/projects/${repoBase}/repos/${repoPath}/branches", "branch": "https://git.corporate-url.com/projects/${repoBase}/repos/${repoPath}/commits/${branch}", "commit": "https://git.corporate-url.com/projects/${repoBase}/repos/${repoPath}/commit/${id}", "file": "https://git.corporate-url.com/projects/${repoBase}/repos/${repoPath}?path=${file}${line}", "fileInBranch": "https://git.corporate-url.com/projects/${repoBase}/repos/${repoPath}/blob/${branch}/${file}${line}", "fileInCommit": "https://git.corporate-url.com/projects/${repoBase}/repos/${repoPath}/blob/${id}/${file}${line}", "fileLine": "#L${line}", "fileRange": "#L${start}-L${end}" } }] |
Name | Description |
---|---|
gitlens.strings.codeLens.unsavedChanges.recentChangeAndAuthors |
Specifies the string to be shown in place of both the recent change and authors code lens when there are unsaved changes |
gitlens.strings.codeLens.unsavedChanges.recentChangeOnly |
Specifies the string to be shown in place of the recent change code lens when there are unsaved changes |
gitlens.strings.codeLens.unsavedChanges.authorsOnly |
Specifies the string to be shown in place of the authors code lens when there are unsaved changes |
GitLens defines a set of themable colors which can be provided by vscode themes or directly by the user using workbench.colorCustomization
.
Name | Description |
---|---|
gitlens.gutterBackgroundColor |
Specifies the background color of the gutter blame annotations |
gitlens.gutterForegroundColor |
Specifies the foreground color of the gutter blame annotations |
gitlens.gutterUncommittedForegroundColor |
Specifies the foreground color of an uncommitted line in the gutter blame annotations |
gitlens.trailingLineBackgroundColor |
Specifies the background color of the trailing blame annotation |
gitlens.trailingLineForegroundColor |
Specifies the foreground color of the trailing blame annotation |
gitlens.lineHighlightBackgroundColor |
Specifies the background color of the associated line highlights in blame annotations |
gitlens.lineHighlightOverviewRulerColor |
Specifies the overview ruler color of the associated line highlights in blame annotations |
Add "gitlens.insiders": true
to your settings to join the insiders channel and get early access to upcoming features. Be aware that because this provides early access expect there to be issues.
A big thanks to the people that have contributed to this project:
Also special thanks to the people that have provided support, testing, brainstorming, etc:
And of course the awesome vscode team!