Eric Amodio 846bc6e127 | 4 år sedan | ||
---|---|---|---|
.github | 删除 | 4 år sedan | |
.vscode | 删除 | 4 år sedan | |
images | 删除 | 4 år sedan | |
scripts | 删除 | 4 år sedan | |
src | 删除 | 4 år sedan | |
test | 删除 | 4 år sedan | |
.eslintignore | 4 år sedan | ||
.eslintrc.json | 4 år sedan | ||
.gitattributes | 5 år sedan | ||
.gitignore | 4 år sedan | ||
.gitignore-revs | 4 år sedan | ||
.mailmap | 5 år sedan | ||
.prettierignore | 6 år sedan | ||
.prettierrc | 4 år sedan | ||
.vscodeignore | 4 år sedan | ||
.yarnrc | 4 år sedan | ||
BACKERS.md | 4 år sedan | ||
CHANGELOG.md | 4 år sedan | ||
CODE_OF_CONDUCT.md | 6 år sedan | ||
CONTRIBUTING.md | 4 år sedan | ||
LICENSE | 4 år sedan | ||
README.insiders.md | 4 år sedan | ||
README.md | 4 år sedan | ||
icons.fig | 4 år sedan | ||
package.json | 4 år sedan | ||
tsconfig.json | 4 år sedan | ||
webpack.config.js | 4 år sedan | ||
yarn.lock | 4 år sedan |
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
If you find GitLens useful, please consider sponsoring it. And if you use GitLens for work, please encourage your employer to sponsor it. Also please write a review, star it on GitHub, and follow me on Twitter
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.
GitLens is powerful, feature rich, and highly customizable to meet your needs. Do you find code lens intrusive or the current line blame annotation distracting — no problem, quickly turn them off or change how they behave via the interactive GitLens Settings editor. For advanced customizations, refer to the GitLens docs and edit your user settings.
Here are just some of the features that GitLens provides,
ctrl+click
on autolinks in the integrated terminal to quickly jump to more details for commits, branches, tags, and more
gitlens.diffWithPrevious
) to compare the current file or revision with the previous commit revisiongitlens.diffWithNext
) to compare the current file or revision with the next commit revisiongitlens.diffLineWithPrevious
) to compare the current file or revision with the previous line commit revisiongitlens.diffWithWorking
) to compare the current revision or most recent commit revision of the current file with the working treegitlens.diffLineWithWorking
) to compare the commit revision of the current line with the working treegitlens.diffWithRevisionFrom
) to compare the current file or revision with another revision of the same file on the selected referencegitlens.diffWithRevision
) to compare the current file or revision with another revision of the same file
gitlens.toggleLineBlame
) to toggle the blame annotation on and off
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
Adds a customizable Git blame annotation showing the commit and author who last modified 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
gitlens.toggleFileBlame
) with a shortcut of alt+b
to toggle the blame annotations on and offEscape
to turn off the annotations
gitlens.toggleFileChanges
) to toggle the changes annotations on and offEscape
to turn off the annotations
gitlens.toggleFileHeatmap
) to toggle the heatmap on and offEscape
to turn off the annotations
A customizable view to visualize, explore, and manage Git commits
The Commits view lists all of the commits on the current branch, and additionally provides,
A customizable view to visualize, navigate, and explore the revision history of the current file or just the selected lines of the current file
The file history view lists all of the commits that changed the current file on the current branch, and additionally provides,
A customizable view to visualize, explore, and manage Git branches
The Branches view lists all of the local branches, and additionally provides,
A customizable view to visualize, explore, and manage Git remotes and remote branches
The Remotes view lists all of the remotes and their remote branches, and additionally provides,
A customizable view to visualize, explore, and manage Git stashes
The Stashes view lists all of the stashes, and additionally provides,
A customizable view to visualize, explore, and manage Git tags
The Tags view lists all of the tags, and additionally provides,
A customizable, but hidden by default, view to visualize, navigate, and explore contributors
The Contributors view lists all of the contributors, and additionally provides,
A customizable, hidden by default, view to search and explore commit histories by message, author, files, id, etc, or visualize comparisons between branches, tags, commits, and more
The Search & Compare view lists pinnable (saved) results for searching commit histories or for comparison operations, and additionally provides,
gitlens.showCommitSearch
) can search
<message>
to find commits with messages that match <message>
— See Git docs@<pattern>
to find commits with authors that match <pattern>
— See Git docs#<sha>
to find a commit with id of <sha>
— See Git docs:<path/glob>
to find commits with file names that match <path/glob>
— See Git docs~<pattern>
to find commits with differences whose patch text contains added/removed lines that match <pattern>
— See Git docsgitlens.showQuickFileHistory
)gitlens.showQuickCommitDetails
)gitlens.views.compareWithUpstream
)gitlens.views.compareWithWorking
)gitlens.views.compareWithHead
)gitlens.views.compareWithSelected
)gitlens.views.compareAncestryWithWorking
)
A customizable, hidden by default as it has been superseded by the new views, view to visualize, navigate, and explore Git repositories
The Repositories view lists opened Git repositories, and additionally provides,
Adds a customizable Git Command Palette command (gitlens.gitCommands
) to provide guided (step-by-step) access to many common Git commands, as well as quick access to commit history and search, stashes, and more
gitlens.showQuickBranchHistory
) to show a quick pick menu to explore the commit history of the selected branchgitlens.showQuickRepoHistory
) to show a quick pick menu to explore the commit history of the current branch
gitlens.showQuickFileHistory
) to show quick pick menu to explore the commit history of the current file
gitlens.showCommitSearch
) to show quick pick menu to search for commits
<message>
to find commits with messages that match <message>
— See Git docs@<pattern>
to find commits with authors that match <pattern>
— See Git docs#<sha>
to find a commit with id of <sha>
— See Git docs:<path/glob>
to find commits with file names that match <path/glob>
— See Git docs~<pattern>
to find commits with differences whose patch text contains added/removed lines that match <pattern>
— See Git docs
gitlens.showQuickCommitDetails
) to show a quick pick menu to explore a commit and take action upon it
gitlens.showQuickCommitFileDetails
) to show a quick pick menu to explore a file of a commit and take action upon it
gitlens.showQuickStashList
) to show a quick pick menu to explore your stashes
gitlens.showQuickRepoStatus
) to show a quick pick menu to for visualizing the current repository status
GitLens provides rich integrations with many remote providers, including GitHub, GitHub Enterprise, GitLab, Bitbucket, Bitbucket Server, Azure DevOps. You can also define custom remote providers or remote providers with custom domains as well.
Basic integrations provide issue and pull request auto-linking, while richer integrations (e.g. GitHub) can provide rich hover information provided for auto-linked issues and pull requests, associate pull requests with branches and commits, and provide avatars.
Additionally, these integrations provide commands to copy the url of or open, files, commits, branches, and the repository on the remote provider.
gitlens.openFileFromRemote
) — opens the local file from a url of a file on a remote providergitlens.openFileOnRemote
) — opens a file or revision on the remote providergitlens.copyRemoteFileUrlToClipboard
) — copies the url of a file or revision on the remote providergitlens.openCommitOnRemote
) — opens a commit on the remote providergitlens.copyRemoteCommitUrl
) — copies the url of a commit on the remote providergitlens.openBranchOnRemote
) — opens the branch on the remote providergitlens.copyRemoteBranchUrl
) — copies the url of a branch on the remote providergitlens.openBranchesOnRemote
) — opens the branches on the remote providergitlens.copyRemoteBranchesUrl
) — copies the url of the branches on the remote providergitlens.openComparisonOnRemote
) — opens the comparison on the remote providergitlens.copyRemoteComparisonUrl
) — copies the url of the comparison on the remote providergitlens.openPullRequestOnRemote
) — opens the pull request on the remote providergitlens.copyRemotePullRequestUrl
) — copies the url of the pull request on the remote providergitlens.openRepoOnRemote
) — opens the repository on the remote providergitlens.copyRemoteRepositoryUrl
) — copies the url of the repository on the remote providerAdds an Add Co-authors command (gitlens.addAuthors
) to add a co-author to the commit message input box
Adds a Copy SHA 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 Message 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 Switch to Another Branch (gitlens.views.switchToAnotherBranch
) command — to quickly switch the current branch
Adds a Compare References... command (gitlens.compareWith
) to compare two selected references
Adds a Compare HEAD with... command (gitlens.compareHeadWith
) to compare the index (HEAD) with the selected reference
Adds a Compare Working Tree with... command (gitlens.compareWorkingWith
) to compare the working tree with the selected reference
Adds an Open Changes (difftool) command (gitlens.externalDiff
) to open the changes of a file or set of files with the configured git difftool
Adds an Open All Changes (difftool) command (gitlens.externalDiffAll
) to open all working changes with the configured git difftool
Adds an Open Directory Compare (difftool) command (gitlens.diffDirectoryWithHead
) to compare the working tree with HEAD with the configured Git difftool
Adds an Open Directory Compare (difftool) with... command (gitlens.diffDirectory
) to compare the working tree with the selected reference with the configured Git difftool
Adds an Open 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 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.switchMode
) to quickly switch the active modegitlens.toggleZenMode
) to toggle Zen modegitlens.toggleReviewMode
) to toggle Review mode
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 GitLens: Open Settings (gitlens.showSettingsPage
) command from the Command Palette.
For more advanced customizations, refer to the settings documentation below.
GitLens is highly customizable and provides many configuration settings to allow the personalization of almost all features.
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.pullRequests.enabled |
Specifies whether to provide information about the Pull Request (if any) that introduced the commit in the current line blame annotation. Requires a connection to a supported remote service (e.g. GitHub) |
gitlens.currentLine.scrollable |
Specifies whether the current line blame annotation can be scrolled into view when it is outside the viewport |
Name | Description |
---|---|
gitlens.codeLens.authors.command |
Specifies the command to be executed when an authors code lens is clicked, set to (gitlens.toggleFileBlame ) by default. Can be set to false to disable click actions on the code lens.gitlens.toggleFileBlame - toggles file blame annotationsgitlens.diffWithPrevious - opens changes with the previous revisiongitlens.revealCommitInView - reveals the commit in the Side Bargitlens.showCommitsInView - searches for commits within the rangegitlens.showQuickCommitDetails - shows details of the commitgitlens.showQuickCommitFileDetails - show file details of the commitgitlens.showQuickFileHistory - shows the current file historygitlens.showQuickRepoHistory - shows the current branch history |
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 clicked, set to (gitlens.showQuickCommitFileDetails ) by default. Can be set to false to disable click actions on the code lens.gitlens.toggleFileBlame - toggles file blame annotationsgitlens.diffWithPrevious - opens changes with the previous revisiongitlens.revealCommitInView - reveals the commit in the Side Bargitlens.showCommitsInView - searches for the commitgitlens.showQuickCommitDetails - shows details of the commitgitlens.showQuickCommitFileDetails - show file details of the commitgitlens.showQuickFileHistory - shows the current file historygitlens.showQuickRepoHistory - shows the current branch history |
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 |
Deprecated. Use per-language gitlens.codeLens.scopes and gitlens.codeLens.symbolScopes settings instead |
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.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 - opens line changes with the previous revisiongitlens.diffWithWorking - opens line changes with the working filegitlens.revealCommitInView - reveals the commit in the Side Bargitlens.showCommitsInView - searches for the commitgitlens.toggleCodeLens - toggles the Git code lensgitlens.showQuickCommitDetails - shows details of the commitgitlens.showQuickCommitFileDetails - show file details of the commitgitlens.showQuickFileHistory - shows the current file historygitlens.showQuickRepoHistory - shows the current branch history |
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.pullRequests.enabled |
Specifies whether to provide information about the Pull Request (if any) that introduced the commit in the status bar. Requires a connection to a supported remote service (e.g. GitHub) |
gitlens.statusBar.reduceFlicker |
Specifies whether to avoid clearing the previous blame information when changing lines to reduce status bar "flashing" |
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.avatarSize |
Specifies the size of the 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.detailsMarkdownFormat |
Specifies the format (in markdown) of the commit details hover. See Commit Tokens in the GitLens docs |
gitlens.hovers.enabled |
Specifies whether to provide any hovers |
gitlens.hovers.autolinks.enabled |
Specifies whether to automatically link external resources in commit messages |
gitlens.hovers.autolinks.enhanced |
Specifies whether to lookup additional details about automatically link external resources in commit messages. Requires a connection to a supported remote service (e.g. GitHub) |
gitlens.hovers.pullRequests.enabled |
Specifies whether to provide information about the Pull Request (if any) that introduced the commit in the hovers. Requires a connection to a supported remote service (e.g. GitHub) |
Name | Description |
---|---|
gitlens.views.defaultItemLimit |
Specifies the default number of items to show in a view list. Use 0 to specify no limit |
gitlens.views.formats.commits.label |
Specifies the format of commits in the views. See Commit Tokens in the GitLens docs |
gitlens.views.formats.commits.description |
Specifies the description format of commits in the views. See Commit Tokens in the GitLens docs |
gitlens.views.formats.files.label |
Specifies the format of a file in the views. See File Tokens in the GitLens docs |
gitlens.views.formats.files.description |
Specifies the description format of a file in the views. See File Tokens in the GitLens docs |
gitlens.views.formats.stashes.label |
Specifies the format of stashes in the views. See Commit Tokens in the GitLens docs |
gitlens.views.formats.stashes.description |
Specifies the description format of stashes in the views. See Commit Tokens in the GitLens docs |
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 |
See also View Settings
Name | Description |
---|---|
gitlens.views.commits.avatars |
Specifies whether to show avatar images instead of commit (or status) icons in the Commits view |
gitlens.views.commits.files.compact |
Specifies whether to compact (flatten) unnecessary file nesting in the Commits view. Only applies when gitlens.views.commits.files.layout is set to tree or auto |
gitlens.views.commits.files.layout |
Specifies how the Commits view will display filesauto - automatically switches between displaying files as a tree or list based on the gitlens.views.commits.files.threshold value and the number of files at each nesting levellist - displays files as a listtree - displays files as a tree |
gitlens.views.commits.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 Commits viewOnly applies when gitlens.views.commits.files.layout is set to auto |
gitlens.views.commits.pullRequests.enabled |
Specifies whether to query for pull requests associated with the current branch and commits in the Commits view. Requires a connection to a supported remote service (e.g. GitHub) |
gitlens.views.commits.pullRequests.showForBranches |
Specifies whether to query for pull requests associated with the current branch and commits in the Commits view. Requires a connection to a supported remote service (e.g. GitHub) |
gitlens.views.commits.pullRequests.showForCommits |
Specifies whether to show pull requests (if any) associated with the current branch in the Commits view. Requires a connection to a supported remote service (e.g. GitHub) |
gitlens.views.commits.showBranchComparison |
Specifies whether to show a comparison of the current branch or the working tree with a user-selected reference (branch, tag. etc) in the Commits viewfalse - hides the branch comparisonbranch - compares the current branch with a user-selected referenceworking - compares the working tree with a user-selected reference |
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 |
See also View Settings
Name | Description |
---|---|
gitlens.views.branches.avatars |
Specifies whether to show avatar images instead of commit (or status) icons in the Branches view |
gitlens.views.branches.branches.layout |
Specifies how the Branches view will display brancheslist - displays branches as a listtree - displays branches as a tree |
gitlens.views.branches.files.compact |
Specifies whether to compact (flatten) unnecessary file nesting in the Branches view. Only applies when gitlens.views.commits.files.layout is set to tree or auto |
gitlens.views.branches.files.layout |
Specifies how the Branches view will display filesauto - automatically switches between displaying files as a tree or list based on the gitlens.views.commits.files.threshold value and the number of files at each nesting levellist - displays files as a listtree - displays files as a tree |
gitlens.views.branches.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 Branches viewOnly applies when gitlens.views.commits.files.layout is set to auto |
gitlens.views.branches.pullRequests.enabled |
Specifies whether to query for pull requests associated with the current branch and commits in the Branches view. Requires a connection to a supported remote service (e.g. GitHub) |
gitlens.views.branches.pullRequests.showForBranches |
Specifies whether to query for pull requests associated with the current branch and commits in the Branches view. Requires a connection to a supported remote service (e.g. GitHub) |
gitlens.views.branches.pullRequests.showForCommits |
Specifies whether to show pull requests (if any) associated with the current branch in the Branches view. Requires a connection to a supported remote service (e.g. GitHub) |
gitlens.views.branches.showBranchComparison |
Specifies whether to show a comparison of the branch with a user-selected reference (branch, tag. etc) in the Branches viewfalse - hides the branch comparisonbranch - compares the current branch with a user-selected reference |
See also View Settings
Name | Description |
---|---|
gitlens.views.remotes.avatars |
Specifies whether to show avatar images instead of commit (or status) icons in the Remotes view |
gitlens.views.remotes.branches.layout |
Specifies how the Remotes view will display brancheslist - displays branches as a listtree - displays branches as a tree |
gitlens.views.remotes.files.compact |
Specifies whether to compact (flatten) unnecessary file nesting in the Remotes view. Only applies when gitlens.views.commits.files.layout is set to tree or auto |
gitlens.views.remotes.files.layout |
Specifies how the Remotes view will display filesauto - automatically switches between displaying files as a tree or list based on the gitlens.views.commits.files.threshold value and the number of files at each nesting levellist - displays files as a listtree - displays files as a tree |
gitlens.views.remotes.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 Remotes viewOnly applies when gitlens.views.commits.files.layout is set to auto |
gitlens.views.remotes.pullRequests.enabled |
Specifies whether to query for pull requests associated with the current branch and commits in the Remotes view. Requires a connection to a supported remote service (e.g. GitHub) |
gitlens.views.remotes.pullRequests.showForBranches |
Specifies whether to query for pull requests associated with the current branch and commits in the Remotes view. Requires a connection to a supported remote service (e.g. GitHub) |
gitlens.views.remotes.pullRequests.showForCommits |
Specifies whether to show pull requests (if any) associated with the current branch in the Remotes view. Requires a connection to a supported remote service (e.g. GitHub) |
gitlens.views.remotes.showBranchComparison |
Specifies whether to show a comparison of the branch with a user-selected reference (branch, tag. etc) in the Remotes viewfalse - hides the branch comparisonbranch - compares the current branch with a user-selected reference |
See also View Settings
Name | Description |
---|---|
gitlens.views.stashes.files.compact |
Specifies whether to compact (flatten) unnecessary file nesting in the Stashes view. Only applies when gitlens.views.commits.files.layout is set to tree or auto |
gitlens.views.stashes.files.layout |
Specifies how the Stashes view will display filesauto - automatically switches between displaying files as a tree or list based on the gitlens.views.commits.files.threshold value and the number of files at each nesting levellist - displays files as a listtree - displays files as a tree |
gitlens.views.stashes.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 Stashes viewOnly applies when gitlens.views.commits.files.layout is set to auto |
See also View Settings
Name | Description |
---|---|
gitlens.views.tags.avatars |
Specifies whether to show avatar images instead of commit (or status) icons in the Tags view |
gitlens.views.tags.branches.layout |
Specifies how the Tags view will display tagslist - displays tags as a listtree - displays tags as a tree |
gitlens.views.tags.files.compact |
Specifies whether to compact (flatten) unnecessary file nesting in the Tags view. Only applies when gitlens.views.commits.files.layout is set to tree or auto |
gitlens.views.tags.files.layout |
Specifies how the Tags view will display filesauto - automatically switches between displaying files as a tree or list based on the gitlens.views.commits.files.threshold value and the number of files at each nesting levellist - displays files as a listtree - displays files as a tree |
gitlens.views.tags.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 Tags viewOnly applies when gitlens.views.commits.files.layout is set to auto |
See also View Settings
Name | Description |
---|---|
gitlens.views.contributors.avatars |
Specifies whether to show avatar images instead of commit (or status) icons in the Contributors view |
gitlens.views.contributors.files.compact |
Specifies whether to compact (flatten) unnecessary file nesting in the Contributors view. Only applies when gitlens.views.commits.files.layout is set to tree or auto |
gitlens.views.contributors.files.layout |
Specifies how the Contributors view will display filesauto - automatically switches between displaying files as a tree or list based on the gitlens.views.commits.files.threshold value and the number of files at each nesting levellist - displays files as a listtree - displays files as a tree |
gitlens.views.contributors.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 Contributors viewOnly applies when gitlens.views.commits.files.layout is set to auto |
gitlens.views.contributors.pullRequests.enabled |
Specifies whether to query for pull requests associated with the current branch and commits in the Contributors view. Requires a connection to a supported remote service (e.g. GitHub) |
gitlens.views.contributors.pullRequests.showForCommits |
Specifies whether to show pull requests (if any) associated with the current branch in the Contributors view. Requires a connection to a supported remote service (e.g. GitHub) |
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.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 |
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.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 |
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.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 |
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 indicatorline - 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.changes.locations |
Specifies where the indicators of the gutter changes annotations will be showngutter - adds a gutter indicatoroverview - adds a decoration to the overview ruler (scroll bar) |
gitlens.changes.toggleMode |
Specifies how the gutter changes annotations will be toggledfile - toggles each file individuallywindow - toggles the window, i.e. all files at once |
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.gitCommands.closeOnFocusOut |
Specifies whether to dismiss the Git Commands Palette when focus is lost (if not, press ESC to dismiss) |
gitlens.gitCommands.search.matchAll |
Specifies whether to match all or any commit message search patterns |
gitlens.gitCommands.search.matchCase |
Specifies whether to match commit search patterns with or without regard to casing |
gitlens.gitCommands.search.matchRegex |
Specifies whether to match commit search patterns using regular expressions |
gitlens.gitCommands.search.showResultsInSideBar |
Specifies whether to show the commit search results directly in the quick pick menu, in the Side Bar, or will be based on the context |
gitlens.gitCommands.skipConfirmations |
Specifies which (and when) Git commands will skip the confirmation step, using the format: git-command-name:(menu/command) |
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 |
Name | Description |
---|---|
gitlens.menus |
Specifies which commands will be added to which menus |
Name | Description |
---|---|
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 |
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.autolinks |
Specifies autolinks to external resources in commit messages. Use <num> as the variable for the reference numberExample to autolink Jira issues: (e.g. JIRA-123 ⟶ https://jira.company.com/issue?query=123 )"gitlens.autolinks": [{ "prefix": "JIRA-", "url": "https://jira.company.com/issue?query=<num>" }] |
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.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.liveshare.allowGuestAccess |
Specifies whether to allow guest access to GitLens features when using Visual Studio Live Share |
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 |
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.fileHistoryShowAllBranches |
Specifies whether file histories will show commits from all branches |
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 dismiss quick pick menus when focus is lost (if not, press ESC to dismiss) |
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.useSymmetricDifferenceNotation |
Specifies whether to use the symmetric difference (three-dot) notation or the range (two-dot) notation for comparisons. See the Git docs |
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.colorCustomizations
.
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!