@ -57,7 +57,7 @@ GitLens is powerful, feature rich, and also [highly customizable](#gitlens-setti
While GitLens is generously offered to everyone free of charge, if you find it useful please consider supporting it.
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 time<sup><atitle="nights and weekends, i.e. trading sleep for time">1</a></sup> for almost 2 years now.
I've been building GitLens in my spare time<sup><atitle="nights and weekends, i.e. trading sleep for time">1</a></sup> for over 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.
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.
While I enjoy giving my free time and attention to GitLens' development and growth, I would like to do even more.
@ -95,7 +95,7 @@ For more advanced customizations, refer to the [settings documentation](#gitlens
- Adds a _Search Commits_ command (`gitlens.showCommitSearch`) with a shortcut of `alt+/` to search for commits by message, author, file(s), commit id, or code changes
- Adds a _Search Commits_ command (`gitlens.showCommitSearch`) with a shortcut of `alt+/` to search for commits by message, author, file(s), commit id, or code changes
- Use `<message>` to search for commits with messages that match `<message>`— See [Git docs](https://git-scm.com/docs/git-log#git-log---grepltpatterngt 'Open Git docs')
- Use `<message>` to search for commits with messages that match `<message>`— See [Git docs](https://git-scm.com/docs/git-log#git-log---grepltpatterngt 'Open Git docs')
@ -276,7 +276,7 @@ The compare view provides the following features,
@ -660,7 +660,7 @@ GitLens is highly customizable and provides many configuration settings to allow
| `gitlens.settings.mode` | Specifies the display mode of the interactive settings editor<br/><br/>`simple` - only displays common settings<br/>`advanced` - displays all settings |
| `gitlens.settings.mode` | Specifies the display mode of the interactive settings editor<br/><br/>`simple` - only displays common settings<br/>`advanced` - displays all settings |
| `gitlens.showWhatsNewAfterUpgrades` | Specifies whether to show What's New after upgrading to new feature releases |
| `gitlens.showWhatsNewAfterUpgrades` | Specifies whether to show What's New after upgrading to new feature releases |
See also [View Settings](#view-settings 'Jump to the View settings')
See also [View Settings](#view-settings 'Jump to the View settings')
@ -677,7 +677,7 @@ See also [View Settings](#view-settings 'Jump to the View settings')
| `gitlens.views.repositories.location` | Specifies where to show the _Repositories_ view<br/><br/>`gitlens` - adds to the GitLens side bar<br/>`explorer` - adds to the Explorer side bar<br/>`scm` - adds to the Source Control side bar |
| `gitlens.views.repositories.location` | Specifies where to show the _Repositories_ view<br/><br/>`gitlens` - adds to the GitLens side bar<br/>`explorer` - adds to the Explorer side bar<br/>`scm` - adds to the Source Control side bar |
| `gitlens.views.repositories.showTrackingBranch` | Specifies whether to show the tracking branch when displaying local branches in the _Repositories_ view |
| `gitlens.views.repositories.showTrackingBranch` | Specifies whether to show the tracking branch when displaying local branches in the _Repositories_ view |
### File History View Settings [#](#file-history-view-settings 'File History View Settings')
### File History View Settings [#](#file-history-view-settings- 'File History View Settings')
See also [View Settings](#view-settings 'Jump to the View settings')
See also [View Settings](#view-settings 'Jump to the View settings')
@ -687,7 +687,7 @@ See also [View Settings](#view-settings 'Jump to the View settings')
| `gitlens.views.fileHistory.enabled` | Specifies whether to show 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_ view<br/><br/>`gitlens` - adds to the GitLens side bar<br/>`explorer` - adds to the Explorer side bar<br/>`scm` - adds to the Source Control side bar |
| `gitlens.views.fileHistory.location` | Specifies where to show the _File History_ view<br/><br/>`gitlens` - adds to the GitLens side bar<br/>`explorer` - adds to the Explorer side bar<br/>`scm` - adds to the Source Control side bar |
### Line History View Settings [#](#line-history-view-settings 'Line History View Settings')
### Line History View Settings [#](#line-history-view-settings= 'Line History View Settings')
See also [View Settings](#view-settings 'Jump to the View settings')
See also [View Settings](#view-settings 'Jump to the View settings')
@ -697,7 +697,7 @@ See also [View Settings](#view-settings 'Jump to the View settings')
| `gitlens.views.lineHistory.enabled` | Specifies whether to show 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_ view<br/><br/>`gitlens` - adds to the GitLens side bar<br/>`explorer` - adds to the Explorer side bar<br/>`scm` - adds to the Source Control side bar |
| `gitlens.views.lineHistory.location` | Specifies where to show the _Line History_ view<br/><br/>`gitlens` - adds to the GitLens side bar<br/>`explorer` - adds to the Explorer side bar<br/>`scm` - adds to the Source Control side bar |
See also [View Settings](#view-settings 'Jump to the View settings')
See also [View Settings](#view-settings 'Jump to the View settings')
@ -709,7 +709,7 @@ See also [View Settings](#view-settings 'Jump to the View settings')
| `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.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_ view<br/><br/>`gitlens` - adds to the GitLens side bar<br/>`explorer` - adds to the Explorer side bar<br/>`scm` - adds to the Source Control side bar |
| `gitlens.views.compare.location` | Specifies where to show the _Compare_ view<br/><br/>`gitlens` - adds to the GitLens side bar<br/>`explorer` - adds to the Explorer side bar<br/>`scm` - adds to the Source Control side bar |
See also [View Settings](#view-settings 'Jump to the View settings')
See also [View Settings](#view-settings 'Jump to the View settings')
@ -721,7 +721,7 @@ See also [View Settings](#view-settings 'Jump to the View settings')
| `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_ view<br/>Only applies when `gitlens.views.compare.files.layout` is set to `auto` |
| `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_ view<br/>Only applies when `gitlens.views.compare.files.layout` is set to `auto` |
| `gitlens.views.search.location` | Specifies where to show the _Search Commits_ view<br/>`gitlens` - adds to the GitLens side bar<br/>`explorer` - adds to the Explorer side bar<br/>`scm` - adds to the Source Control side bar |
| `gitlens.views.search.location` | Specifies where to show the _Search Commits_ view<br/>`gitlens` - adds to the GitLens side bar<br/>`explorer` - adds to the Explorer side bar<br/>`scm` - adds to the Source Control side bar |
@ -733,7 +733,7 @@ See also [View Settings](#view-settings 'Jump to the View settings')
| `gitlens.views.stashFormat` | Specifies the format of stashed changes in the views. See the [GitLens docs](https://github.com/eamodio/vscode-gitlens/wiki/Advanced-Formatting) for advanced formatting<br/><br/>Available tokens<br/>`${id}` — commit id<br/>`${author}` — commit author<br/>`${message}` — commit message<br/>`${ago}` — relative commit date (e.g. 1 day ago)<br/>`${date}`— formatted commit date (format specified by `gitlens.statusBar.dateFormat`)<br/>`${agoOrDate}` — commit date specified by `gitlens.defaultDateStyle`<br/>`${authorAgo}` — commit author, relative commit date<br/>`${authorAgoOrDate}` — commit author, commit date specified by `gitlens.defaultDateStyle` |
| `gitlens.views.stashFormat` | Specifies the format of stashed changes in the views. See the [GitLens docs](https://github.com/eamodio/vscode-gitlens/wiki/Advanced-Formatting) for advanced formatting<br/><br/>Available tokens<br/>`${id}` — commit id<br/>`${author}` — commit author<br/>`${message}` — commit message<br/>`${ago}` — relative commit date (e.g. 1 day ago)<br/>`${date}`— formatted commit date (format specified by `gitlens.statusBar.dateFormat`)<br/>`${agoOrDate}` — commit date specified by `gitlens.defaultDateStyle`<br/>`${authorAgo}` — commit author, relative commit date<br/>`${authorAgoOrDate}` — commit author, commit date specified by `gitlens.defaultDateStyle` |
| `gitlens.views.statusFileFormat` | Specifies the format of the status of a working or committed file in the views<br/><br/>Available tokens<br/>`${directory}` — directory name<br/>`${file}` — file name<br/>`${filePath}` — formatted file name and path<br/>`${path}` — full file path<br/>`${working}` — optional indicator if the file is uncommitted |
| `gitlens.views.statusFileFormat` | Specifies the format of the status of a working or committed file in the views<br/><br/>Available tokens<br/>`${directory}` — directory name<br/>`${file}` — file name<br/>`${filePath}` — formatted file name and path<br/>`${path}` — full file path<br/>`${working}` — optional indicator if the file is uncommitted |
@ -747,7 +747,7 @@ See also [View Settings](#view-settings 'Jump to the View settings')
| `gitlens.codeLens.scopesByLanguage` | Specifies where Git code lens will be shown in the document for the specified languages |
| `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`](https://code.visualstudio.com/docs/extensionAPI/vscode-api#_a-namesymbolkindaspan-classcodeitem-id660symbolkindspan) |
| `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`](https://code.visualstudio.com/docs/extensionAPI/vscode-api#_a-namesymbolkindaspan-classcodeitem-id660symbolkindspan) |
#### Current Line Blame Settings [#](#current-line-blame-settings 'Current Line Blame Settings')
#### Current Line Blame Settings [#](#current-line-blame-settings- 'Current Line Blame Settings')
@ -756,7 +756,7 @@ See also [View Settings](#view-settings 'Jump to the View settings')
| `gitlens.currentLine.format` | Specifies the format of the current line blame annotation. See the [GitLens docs](https://github.com/eamodio/vscode-gitlens/wiki/Advanced-Formatting) for advanced formatting<br/><br/>Available tokens<br/>`${id}` — commit id<br/>`${author}` — commit author<br/>`${message}` — commit message<br/>`${ago}` — relative commit date (e.g. 1 day ago)<br/>`${date}` — formatted commit date (format specified by `gitlens.currentLine.dateFormat`)<br/>`${agoOrDate}` — commit date specified by `gitlens.defaultDateStyle`<br/>`${authorAgo}` — commit author, relative commit date<br/>`${authorAgoOrDate}` — commit author, commit date specified by `gitlens.defaultDateStyle` |
| `gitlens.currentLine.format` | Specifies the format of the current line blame annotation. See the [GitLens docs](https://github.com/eamodio/vscode-gitlens/wiki/Advanced-Formatting) for advanced formatting<br/><br/>Available tokens<br/>`${id}` — commit id<br/>`${author}` — commit author<br/>`${message}` — commit message<br/>`${ago}` — relative commit date (e.g. 1 day ago)<br/>`${date}` — formatted commit date (format specified by `gitlens.currentLine.dateFormat`)<br/>`${agoOrDate}` — commit date specified by `gitlens.defaultDateStyle`<br/>`${authorAgo}` — commit author, relative commit date<br/>`${authorAgoOrDate}` — commit author, commit date specified by `gitlens.defaultDateStyle` |
| `gitlens.currentLine.scrollable` | Specifies whether the current line blame annotation can be scrolled into view when it is outside the viewport |
| `gitlens.currentLine.scrollable` | Specifies whether the current line blame annotation can be scrolled into view when it is outside the viewport |
@ -772,7 +772,7 @@ See also [View Settings](#view-settings 'Jump to the View settings')
| `gitlens.blame.separateLines` | Specifies whether gutter blame annotations will have line separators |
| `gitlens.blame.separateLines` | Specifies whether gutter blame annotations will have line separators |
| `gitlens.blame.toggleMode` | Specifies how the gutter blame annotations will be toggled<br/><br/>`file` - toggles each file individually<br/>`window` - toggles the window, i.e. all files at once |
| `gitlens.blame.toggleMode` | Specifies how the gutter blame annotations will be toggled<br/><br/>`file` - toggles each file individually<br/>`window` - toggles the window, i.e. all files at once |
@ -781,7 +781,7 @@ See also [View Settings](#view-settings 'Jump to the View settings')
| `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.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 toggled<br/><br/>`file` - toggles each file individually<br/>`window` - toggles the window, i.e. all files at once |
| `gitlens.heatmap.toggleMode` | Specifies how the gutter heatmap annotations will be toggled<br/><br/>`file` - toggles each file individually<br/>`window` - toggles the window, i.e. all files at once |
@ -796,7 +796,7 @@ See also [View Settings](#view-settings 'Jump to the View settings')
| `gitlens.hovers.currentLine.over` | Specifies when to trigger hovers for the current line<br/><br/>`annotation` - only shown when hovering over the line annotation<br/>`line` - shown when hovering anywhere over the line |
| `gitlens.hovers.currentLine.over` | Specifies when to trigger hovers for the current line<br/><br/>`annotation` - only shown when hovering over the line annotation<br/>`line` - shown when hovering anywhere over the line |
| `gitlens.hovers.enabled` | Specifies whether to provide any hovers |
| `gitlens.hovers.enabled` | Specifies whether to provide any hovers |
@ -805,14 +805,14 @@ See also [View Settings](#view-settings 'Jump to the View settings')
| `gitlens.mode.statusBar.alignment` | Specifies the active GitLens mode alignment in the status bar<br/><br/>`left` - aligns to the left<br/>`right` - aligns to the right |
| `gitlens.mode.statusBar.alignment` | Specifies the active GitLens mode alignment in the status bar<br/><br/>`left` - aligns to the left<br/>`right` - aligns to the right |
| `gitlens.modes` | Specifies the user-defined GitLens modes |
| `gitlens.modes` | Specifies the user-defined GitLens modes |
| `gitlens.recentChanges.highlight.locations` | Specifies where the highlights of the recently changed lines will be shown<br/><br/>`gutter` - adds a gutter glyph<br/>`line` - adds a full-line highlight background color<br/>`overview` - adds a decoration to the overview ruler (scroll bar) |
| `gitlens.recentChanges.highlight.locations` | Specifies where the highlights of the recently changed lines will be shown<br/><br/>`gutter` - adds a gutter glyph<br/>`line` - adds a full-line highlight background color<br/>`overview` - adds a decoration to the overview ruler (scroll bar) |
| `gitlens.recentChanges.toggleMode` | Specifies how the recently changed lines annotations will be toggled<br/><br/>`file` - toggles each file individually<br/>`window` - toggles the window, i.e. all files at once |
| `gitlens.recentChanges.toggleMode` | Specifies how the recently changed lines annotations will be toggled<br/><br/>`file` - toggles each file individually<br/>`window` - toggles the window, i.e. all files at once |
### Status Bar Settings [#](#status-bar-settings 'Status Bar Settings')
### Status Bar Settings [#](#status-bar-settings- 'Status Bar Settings')
@ -823,7 +823,7 @@ See also [View Settings](#view-settings 'Jump to the View settings')
| `gitlens.statusBar.format` | Specifies the format of the blame information in the status bar. See the [GitLens docs](https://github.com/eamodio/vscode-gitlens/wiki/Advanced-Formatting) for advanced formatting<br/><br/>Available tokens<br/>`${id}` — commit id<br/>`${author}` — commit author<br/>`${message}` — commit message<br/>`${ago}` — relative commit date (e.g. 1 day ago)<br/>`${date}` — formatted commit date (format specified by `gitlens.statusBar.dateFormat`)<br/>`${agoOrDate}` — commit date specified by `gitlens.defaultDateStyle`<br/>`${authorAgo}` — commit author, relative commit date<br/>`${authorAgoOrDate}` — commit author, commit date specified by `gitlens.defaultDateStyle` |
| `gitlens.statusBar.format` | Specifies the format of the blame information in the status bar. See the [GitLens docs](https://github.com/eamodio/vscode-gitlens/wiki/Advanced-Formatting) for advanced formatting<br/><br/>Available tokens<br/>`${id}` — commit id<br/>`${author}` — commit author<br/>`${message}` — commit message<br/>`${ago}` — relative commit date (e.g. 1 day ago)<br/>`${date}` — formatted commit date (format specified by `gitlens.statusBar.dateFormat`)<br/>`${agoOrDate}` — commit date specified by `gitlens.defaultDateStyle`<br/>`${authorAgo}` — commit author, relative commit date<br/>`${authorAgoOrDate}` — commit author, commit date specified by `gitlens.defaultDateStyle` |
| `gitlens.statusBar.reduceFlicker` | Specifies whether to avoid clearing the previous blame information when changing lines to reduce status bar "flashing" |
| `gitlens.statusBar.reduceFlicker` | Specifies whether to avoid clearing the previous blame information when changing lines to reduce status bar "flashing" |
Eric Amodio
6 years ago