Eric Amodio 04f7cd6b40 | 6 years ago | ||
---|---|---|---|
.github/ISSUE_TEMPLATE | 删除 | 6 years ago | |
.vscode | 删除 | 6 years ago | |
emoji | 删除 | 6 years ago | |
images | 删除 | 6 years ago | |
src | 删除 | 6 years ago | |
test | 删除 | 6 years ago | |
.gitignore | 6 years ago | ||
.prettierignore | 6 years ago | ||
.prettierrc | 6 years ago | ||
.vscodeignore | 6 years ago | ||
BACKERS.md | 6 years ago | ||
CHANGELOG.md | 6 years ago | ||
CODE_OF_CONDUCT.md | 6 years ago | ||
LICENSE | 7 years ago | ||
README.md | 6 years ago | ||
package-lock.json | 6 years ago | ||
package.json | 6 years ago | ||
tsconfig.json | 6 years ago | ||
tslint.json | 6 years ago | ||
ui.tsconfig.json | 6 years ago | ||
webpack.config.js | 6 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.
cd90faa526/images/cl-heatmap-cold.png
See the release notes for the full set of changes
GitLens is an open-source extension for Visual Studio Code created by Eric Amodio. While GitLens is generously offered to everyone free of charge, if you find it useful please consider supporting it.
GitLens simply helps you understand code better. 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. Explore the history and evolution of a codebase.
Here are just some of the features that GitLens provides,
GitLens is powerful, feature rich, and 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.
While GitLens is generously offered to everyone free of charge, if you find it useful please consider supporting it.
I've been building GitLens in my spare time1 for almost 2 years now. From its very humble beginnings, GitLens has grown wildly beyond my expectations — in both its reach as well as its demands on my time and attention. While I enjoy giving my free time and attention to GitLens' development and growth, I would like to do even more.
To my incredible backers — thank you so much for your contributions. I am truly humbled by your generosity and support. Please know that your support plays a important role in helping me realize GitLens' potential in making developer's lives easier.
If you'd like to join them in supporting GitLens, please consider the following — feel free to choose more than one. 😉
None yet — could be you!
None yet — could be you!
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.
A customizable explorer to visualize, navigate, and explore Git repositories.
The repositories explorer provides the following features,
Repository Status
Branches — lists the local branches
Remotes — lists the remotes
Stashes — lists the stashed changes
Tags — lists the tags
A customizable explorer to visualize, navigate, and explore the revision history of the current file.
The file history explorer provides the following features,
A customizable explorer to visualize, navigate, and explore the revision history of the selected lines of current file.
The line history explorer provides the following features,
An on-demand, customizable explorer to navigate and explore commits, histories, and searches, or visualize comparisons between branches, tags, commits, and more
The results explorer provides the following features,
gitlens.showCommitSearch
)gitlens.showQuickFileHistory
)gitlens.showQuickCommitDetails
)Provides a semi-persistent results view for comparison operations
Accessible via the following commands
gitlens.explorers.compareWithRemote
)gitlens.explorers.compareWithHead
)gitlens.explorers.compareWithWorking
)gitlens.explorers.compareWithSelected
)gitlens.explorers.compareAncestryWithWorking
)An inline toolbar provides Swap Comparision, and Clear Results commands
A context menu provides Clear Results, Swap Comparision, Open Directory Compare, and Refresh commands
Commits — lists the commits between the compared revisions (branches or commits)
Changed Files — lists the files changed between the compared revisions (branches or commits)
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.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
gitlens.toggleFileHeatmap
) to toggle the heatmap on and offEscape
to turn off the annotations
gitlens.switchMode
) to quickly switch the active modegitlens.toggleZenMode
) to toggle Zen modegitlens.toggleReviewMode
) to toggle Review mode
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
gitlens.showCommitSearch
) with a shortcut of alt+/
to search for commits by message, author, file(s), commit id, or code changes
<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:<pattern>
to search for commits with file names that match <pattern>
— See Git docs#<sha>
to search for a commit with id of <sha>
— See Git docs~<pattern>
to search for commits with differences whose patch text contains added/removed lines that match <pattern>
— See Git docs=<string>
to search for commits with differences that change the number of occurrences of the specified string (i.e. addition/deletion) in a file — See Git docsAdds 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 in the supported remote services, Bitbucket, GitHub, GitLab, and Visual Studio Team Services or a user-defined remote services — only available if a Git upstream service is configured in the repository
gitlens.openBranchesInRemote
) — opens the branches in the supported remote servicegitlens.openBranchInRemote
) — opens the current branch commits in the supported remote servicegitlens.openCommitInRemote
) — opens the commit revision of the current line in the supported remote servicegitlens.openFileInRemote
) — opens the current file/revision in the supported remote servicegitlens.openRepoInRemote
) — opens the repository in 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 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 a 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 branch or tag
Adds a Compare HEAD with Branch or Tag... command (gitlens.diffHeadWithBranch
) to compare the index (HEAD) with the selected branch or tag
Adds a Compare Working Tree with Branch or Tag... command (gitlens.diffWorkingWithBranch
) to compare the working tree with the selected branch or tag
Adds a Open Changes with Branch or Tag... command (gitlens.diffWithBranch
) to compare the current file with the same file on the selected branch or tag
Adds a 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 a 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 a 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 a Open Changes with Revision... command (gitlens.diffWithRevision
) to compare the current file with the selected revision of the same file
Adds a 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 a 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 File Url to Clipboard command (gitlens.copyRemoteFileUrlToClipboard
) to copy the remote url of the current file and line to the clipboard
Adds a Open Working File" command (gitlens.openWorkingFile
) to open the working file for the current file revision
Adds a Open Revision... command (gitlens.openFileRevision
) to open the selected revision for the current file
Adds a 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 a Open All Changes (with difftool) command (gitlens.externalDiffAll
) to open all working changes with the configured git difftool
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 https://momentjs.com/docs/#/displaying/format/ for valid formats |
gitlens.defaultDateStyle |
Specifies how dates will be displayed by default |
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.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.settings.mode |
Specifies the display mode of the interactive settings editorsimple - only displays common settingsadvanced - displays all settings |
gitlens.showWhatsNewAfterUpgrades |
Specifies whether to show What's New after upgrading to new feature releases |
See also Explorer Settings
Name | Description |
---|---|
gitlens.repositoriesExplorer.autoRefresh |
Specifies whether to automatically refresh the Repositories explorer when the repository or the file system changes |
gitlens.repositoriesExplorer.autoReveal |
Specifies whether to automatically reveal repositories in the Repositories explorer when opening files |
gitlens.repositoriesExplorer.branches.layout |
Specifies how the Repositories explorer will display brancheslist - displays branches as a listtree - displays branches as a tree when branch names contain slashes / |
gitlens.repositoriesExplorer.enabled |
Specifies whether to show the Repositories explorer |
gitlens.repositoriesExplorer.files.compact |
Specifies whether to compact (flatten) unnecessary file nesting in the Repositories explorer Only applies when gitlens.repositoriesExplorer.files.layout is set to tree or auto |
gitlens.repositoriesExplorer.files.layout |
Specifies how the Repositories explorer will display filesauto - automatically switches between displaying files as a tree or list based on the gitlens.repositoriesExplorer.files.threshold value and the number of files at each nesting levellist - displays files as a listtree - displays files as a tree |
gitlens.repositoriesExplorer.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 explorerOnly applies when gitlens.repositoriesExplorer.files.layout is set to auto |
gitlens.repositoriesExplorer.includeWorkingTree |
Specifies whether to include working tree files inside the Repository Status node of the Repositories explorer |
gitlens.repositoriesExplorer.location |
Specifies where to show the Repositories explorergitlens - adds to the GitLens viewexplorer - adds to the Explorer viewscm - adds to the Source Control view |
gitlens.repositoriesExplorer.showTrackingBranch |
Specifies whether to show the tracking branch when displaying local branches in the Repositories explorer |
See also Explorer Settings
Name | Description |
---|---|
gitlens.fileHistoryExplorer.avatars |
Specifies whether to show avatar images instead of status icons in the File History explorer |
gitlens.fileHistoryExplorer.enabled |
Specifies whether to show the File History explorer |
gitlens.fileHistoryExplorer.location |
Specifies where to show the File History explorergitlens - adds to the GitLens viewexplorer - adds to the Explorer viewscm - adds to the Source Control view |
See also Explorer Settings
Name | Description |
---|---|
gitlens.lineHistoryExplorer.avatars |
Specifies whether to show avatar images instead of status icons in the Line History explorer |
gitlens.lineHistoryExplorer.enabled |
Specifies whether to show the Line History explorer |
gitlens.lineHistoryExplorer.location |
Specifies where to show the Line History explorergitlens - adds to the GitLens viewexplorer - adds to the Explorer viewscm - adds to the Source Control view |
See also Explorer Settings
Name | Description |
---|---|
gitlens.resultsExplorer.files.compact |
Specifies whether to compact (flatten) unnecessary file nesting in the Results explorer Only applies when gitlens.resultsExplorer.files.layout is set to tree or auto |
gitlens.resultsExplorer.files.layout |
Specifies how the Results explorer will display filesauto - automatically switches between displaying files as a tree or list based on the gitlens.resultsExplorer.files.threshold value and the number of files at each nesting levellist - displays files as a listtree - displays files as a tree |
gitlens.resultsExplorer.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 Results explorerOnly applies when gitlens.resultsExplorer.files.layout is set to auto |
gitlens.resultsExplorer.location |
Specifies where to show the Results explorergitlens - adds to the GitLens viewexplorer - adds to the Explorer viewscm - adds to the Source Control view |
Name | Description |
---|---|
gitlens.explorers.avatars |
Specifies whether to show avatar images instead of commit (or status) icons in the Repositories and Results explorers |
gitlens.explorers.commitFileFormat |
Specifies the format of a committed file in the Repositories and Results explorers Available tokens ${directory} - directory name ${file} - file name ${filePath} - formatted file name and path ${path} - full file path |
gitlens.explorers.commitFormat |
Specifies the format of committed changes in the Repositories and Results explorers Available tokens ${id} - commit id ${author} - commit author ${message} - commit message ${ago} - relative commit date (e.g. 1 day ago) ${date} - formatted commit date (format specified by gitlens.statusBar.dateFormat )${agoOrDate} - commit date specified by gitlens.defaultDateStyle ${authorAgo} - commit author, relative commit date ${authorAgoOrDate} - commit author, commit date specified by gitlens.defaultDateStyle See https://github.com/eamodio/vscode-gitlens/wiki/Advanced-Formatting for advanced formatting |
gitlens.explorers.defaultItemLimit |
Specifies the default number of items to show in an explorer list. Use 0 to specify no limit |
gitlens.explorers.stashFileFormat |
Specifies the format of a stashed file in the Repositories and Results explorers Available tokens ${directory} - directory name ${file} - file name ${filePath} - formatted file name and path ${path} - full file path |
gitlens.explorers.stashFormat |
Specifies the format of stashed changes in the Repositories and Results explorers Available tokens ${id} - commit id ${author} - commit author ${message} - commit message ${ago} - relative commit date (e.g. 1 day ago) ${date} - formatted commit date (format specified by gitlens.statusBar.dateFormat )${agoOrDate} - commit date specified by gitlens.defaultDateStyle ${authorAgo} - commit author, relative commit date ${authorAgoOrDate} - commit author, commit date specified by gitlens.defaultDateStyle See https://github.com/eamodio/vscode-gitlens/wiki/Advanced-Formatting for advanced formatting |
gitlens.explorers.statusFileFormat |
Specifies the format of the status of a working or committed file in the Repositories explorer Available tokens ${directory} - directory name ${file} - file name ${filePath} - formatted file name and path ${path} - full file path ${working} - optional indicator if the file is uncommitted |
Name | Description |
---|---|
gitlens.codeLens.authors.command |
Specifies the command to be executed when the 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 show 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.recentChange.command |
Specifies the command to be executed when the 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 show 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 not show Git code lens for the symbolMust be a member of SymbolKind |
Name | Description |
---|---|
gitlens.currentLine.dateFormat |
Specifies how to format absolute dates (using the ${date} token) for the current line blame annotationsSee https://momentjs.com/docs/#/displaying/format/ 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 Available tokens ${id} - commit id${author} - commit author${message} - commit message${ago} - relative commit date (e.g. 1 day ago)${date} - formatted commit date (format specified by gitlens.currentLine.dateFormat )${agoOrDate} - commit date specified by gitlens.defaultDateStyle ${authorAgo} - commit author, relative commit date${authorAgoOrDate} - commit author, commit date specified by gitlens.defaultDateStyle See https://github.com/eamodio/vscode-gitlens/wiki/Advanced-Formatting for advanced formatting |
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 (using the ${date} token) in gutter blame annotationsSee https://momentjs.com/docs/#/displaying/format/ for valid formats |
gitlens.blame.format |
Specifies the format of the gutter blame annotations Available tokens ${id} - commit id${author} - commit author${message} - commit message${ago} - relative commit date (e.g. 1 day ago)${date} - formatted commit date (format specified by gitlens.blame.dateFormat )${agoOrDate} - commit date specified by gitlens.defaultDateStyle ${authorAgo} - commit author, relative commit date${authorAgoOrDate} - commit author, commit date specified by gitlens.defaultDateStyle See https://github.com/eamodio/vscode-gitlens/wiki/Advanced-Formatting for advanced formatting |
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.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.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.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 |
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 |
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 the date format of absolute dates shown in the blame information in the status bar See https://momentjs.com/docs/#/displaying/format/ 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 Available tokens ${id} - commit id${author} - commit author${message} - commit message${ago} - relative commit date (e.g. 1 day ago)${date} - formatted commit date (format specified by gitlens.statusBar.dateFormat )${agoOrDate} - commit date specified by gitlens.defaultDateStyle ${authorAgo} - commit author, relative commit date${authorAgoOrDate} - commit author, commit date specified by gitlens.defaultDateStyle See https://github.com/eamodio/vscode-gitlens/wiki/Advanced-Formatting for advanced formatting |
gitlens.statusBar.reduceFlicker |
Specifies whether to avoid clearing the previous blame information when changing lines to reduce status bar "flashing" |
Name | Description |
---|---|
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.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.telemetry.enabled |
Specifies whether to enable GitLens telemetry (even if enabled still abides by the overall telemetry.enableTelemetry setting |
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!