diff --git a/.vscodeignore b/.vscodeignore index 3185ed0..7695c04 100644 --- a/.vscodeignore +++ b/.vscodeignore @@ -4,13 +4,8 @@ .vscode/** dist/ui/** emoji/** -!images/dark/** -!images/light/** -!images/settings/** -!images/gitlens-icon.png -!images/gitlens-activitybar.svg -!images/cl-*.png -images/** +images/docs/** +images/**/*.pdn node_modules/** src/** test/** diff --git a/CHANGELOG.md b/CHANGELOG.md index 23fac61..4e11f05 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -148,7 +148,7 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/) and this p ### Added - Adds completely revamped heatmap annotations - ![cold heatmap](https://raw.githubusercontent.com/eamodio/vscode-gitlens/master/images/cl-heatmap-cold.png) + ![cold heatmap](https://raw.githubusercontent.com/eamodio/vscode-gitlens/4ddb871459a3a1a1e132c8bdf83ac12e3b699649/images/cl-heatmap-cold.png) - The indicator's color, now customizable, will either be hot or cold based on the age of the most recent change (cold after 90 days by default) — closes [#419](https://github.com/eamodio/vscode-gitlens/issues/419) - The indicator's brightness ranges from bright (newer) to dim (older) based on the relative age, which is calculated from the median age of all the changes in the file - Adds `gitlens.heatmap.ageThreshold` setting to specify 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`) @@ -235,7 +235,7 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/) and this p - Adds user-defined modes for quickly toggling between sets of settings - ![mode switch](https://raw.githubusercontent.com/eamodio/vscode-gitlens/master/images/cl-mode-switch.png) + ![mode switch](https://raw.githubusercontent.com/eamodio/vscode-gitlens/4ddb871459a3a1a1e132c8bdf83ac12e3b699649/images/cl-mode-switch.png) - Adds _Switch Mode_ command (`gitlens.switchMode`) to quickly switch the active GitLens mode - Adds a built-in _Zen_ mode which for a zen-like experience, disables many visual features @@ -247,7 +247,7 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/) and this p - Adds `gitlens.mode.statusBar.alignment` setting to specify the active GitLens mode alignment in the status bar - Adds modes settings (`gitlens.mode.*`) to the interactive settings editor - ![modes settings](https://raw.githubusercontent.com/eamodio/vscode-gitlens/master/images/cl-modes-settings.png) + ![modes settings](https://raw.githubusercontent.com/eamodio/vscode-gitlens/4ddb871459a3a1a1e132c8bdf83ac12e3b699649/images/cl-modes-settings.png) - Adds `gitlens.mode.active` setting to specify the active GitLens mode, if any - Adds `gitlens.modes` setting to specify the user-defined GitLens modes @@ -256,11 +256,11 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/) and this p - Adds an icon for the _Compare File with Next Revision_ command (`gitlens.diffWithNext`) and moves it into the editor toolbar - Adds menu settings (`gitlens.menus.*`) to the interactive settings editor - ![menu settings](https://raw.githubusercontent.com/eamodio/vscode-gitlens/master/images/cl-menu-settings.png) + ![menu settings](https://raw.githubusercontent.com/eamodio/vscode-gitlens/4ddb871459a3a1a1e132c8bdf83ac12e3b699649/images/cl-menu-settings.png) - Adds a display mode dropdown at the top of the interactive settings editor to reduce complexity - ![settings mode](https://raw.githubusercontent.com/eamodio/vscode-gitlens/master/images/cl-settings-mode.png) + ![settings mode](https://raw.githubusercontent.com/eamodio/vscode-gitlens/4ddb871459a3a1a1e132c8bdf83ac12e3b699649/images/cl-settings-mode.png) - Adds `gitlens.settings.mode` setting to specify the display mode of the interactive settings editor @@ -346,33 +346,33 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/) and this p - Adds new stand-alone _GitLens File History_ explorer to visualize the history of the current file — undocked version of the _GitLens_ explorer history view - ![GitLens File History explorer](https://raw.githubusercontent.com/eamodio/vscode-gitlens/master/images/ss-gitlens-history-explorer.png) + ![GitLens File History explorer](https://raw.githubusercontent.com/eamodio/vscode-gitlens/4ddb871459a3a1a1e132c8bdf83ac12e3b699649/images/ss-gitlens-history-explorer.png) - Adds richer tooltips to the _GitLens_ and _GitLens Results_ explorers, and richer working tree and upstream status to the _GitLens_ explorer - ![Rich tooltips](https://raw.githubusercontent.com/eamodio/vscode-gitlens/master/images/cl-rich-tooltips.png) + ![Rich tooltips](https://raw.githubusercontent.com/eamodio/vscode-gitlens/4ddb871459a3a1a1e132c8bdf83ac12e3b699649/images/cl-rich-tooltips.png) - Adds an indicator to the _GitLens_ explorer's branch history to mark the synchronization point between the local and remote branch (if available) - ![Branch upstream indicator](https://raw.githubusercontent.com/eamodio/vscode-gitlens/master/images/cl-branch-upstream-indicator.png) + ![Branch upstream indicator](https://raw.githubusercontent.com/eamodio/vscode-gitlens/4ddb871459a3a1a1e132c8bdf83ac12e3b699649/images/cl-branch-upstream-indicator.png) - Adds ability to easily switch between relative and absolute dates via the `gitlens.defaultDateStyle` settings — closes [#312](https://github.com/eamodio/vscode-gitlens/issues/312) - Adds `${agoOrDate}` and `${authorAgoOrDate}` tokens to `gitlens.blame.format`, `gitlens.currentLine.format`, `gitlens.explorers.commitFormat`, `gitlens.explorers.stashFormat`, and `gitlens.statusBar.format` settings which will honor the `gitlens.defaultDateStyle` setting - ![General settings](https://raw.githubusercontent.com/eamodio/vscode-gitlens/master/images/cl-general-settings.png) + ![General settings](https://raw.githubusercontent.com/eamodio/vscode-gitlens/4ddb871459a3a1a1e132c8bdf83ac12e3b699649/images/cl-general-settings.png) - Adds annotation format settings (`gitlens.*.format`) to the interactive settings editor - ![Annotation format settings](https://raw.githubusercontent.com/eamodio/vscode-gitlens/master/images/cl-annotation-format.png) + ![Annotation format settings](https://raw.githubusercontent.com/eamodio/vscode-gitlens/4ddb871459a3a1a1e132c8bdf83ac12e3b699649/images/cl-annotation-format.png) - Adds new `gitlens.currentLine.scrollable` setting to specify whether the current line blame annotation can be scrolled into view when it is outside the viewport — closes [#149](https://github.com/eamodio/vscode-gitlens/issues/149), [#290](https://github.com/eamodio/vscode-gitlens/issues/290), [#265](https://github.com/eamodio/vscode-gitlens/issues/265) - ![Allow scrolling to annotation setting](https://raw.githubusercontent.com/eamodio/vscode-gitlens/master/images/cl-current-line-scrollable.png) + ![Allow scrolling to annotation setting](https://raw.githubusercontent.com/eamodio/vscode-gitlens/4ddb871459a3a1a1e132c8bdf83ac12e3b699649/images/cl-current-line-scrollable.png) - Adds `gitlens.statusBar.reduceFlicker` setting to the interactive settings editor - ![Reduce status bar flashing setting](https://raw.githubusercontent.com/eamodio/vscode-gitlens/master/images/cl-status-bar-reduce-flashing.png) + ![Reduce status bar flashing setting](https://raw.githubusercontent.com/eamodio/vscode-gitlens/4ddb871459a3a1a1e132c8bdf83ac12e3b699649/images/cl-status-bar-reduce-flashing.png) - Adds a one-time notification on startup if the `alt-based` keyboard shortcuts are in use, with options to easily switch to another set - Adds _Copy Commit ID to Clipboard_ (`gitlens.copyShaToClipboard`) command to changed file nodes in the _GitLens_ explorer and _GitLens Results_ explorer @@ -413,11 +413,11 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/) and this p - Adds automatic issue linking to Bitbucket, GitHub, GitLab, and Visual Studio Team Services for commit messages in hovers - ![Issue linking in commit messages](https://raw.githubusercontent.com/eamodio/vscode-gitlens/master/images/cl-issue-linking.png) + ![Issue linking in commit messages](https://raw.githubusercontent.com/eamodio/vscode-gitlens/4ddb871459a3a1a1e132c8bdf83ac12e3b699649/images/cl-issue-linking.png) - Adds support to toggle annotations for each file individually or for all files at once — closes [#289](https://github.com/eamodio/vscode-gitlens/issues/289) - ![Annotations toggle setting](https://raw.githubusercontent.com/eamodio/vscode-gitlens/master/images/cl-annotations-toggle.png) + ![Annotations toggle setting](https://raw.githubusercontent.com/eamodio/vscode-gitlens/4ddb871459a3a1a1e132c8bdf83ac12e3b699649/images/cl-annotations-toggle.png) - Adds new controls the interactive settings editor (_Open Settings_ from the Command Palette) to configure this new behavior - Adds `gitlens.blame.toggleMode` setting to specify how the gutter blame annotations will be toggled, per file or window @@ -476,11 +476,11 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/) and this p - Adds an all-new GitLens welcome page via the _Welcome_ (`gitlens.showWelcomePage`) command — provides a welcome / onboarding experience — closes [#51](https://github.com/eamodio/vscode-gitlens/issues/51) - ![GitLens Welcome](https://raw.githubusercontent.com/eamodio/vscode-gitlens/master/images/cl-welcome.png) + ![GitLens Welcome](https://raw.githubusercontent.com/eamodio/vscode-gitlens/4ddb871459a3a1a1e132c8bdf83ac12e3b699649/images/cl-welcome.png) - Adds an all-new GitLens Settings editor via the _Open Settings_ (`gitlens.showSettingsPage`) command — provides an easy-to-use interactive settings editor for many of GitLens' features — closes [#167](https://github.com/eamodio/vscode-gitlens/issues/167) - ![GitLens Settings](https://raw.githubusercontent.com/eamodio/vscode-gitlens/master/images/cl-settings.png) + ![GitLens Settings](https://raw.githubusercontent.com/eamodio/vscode-gitlens/4ddb871459a3a1a1e132c8bdf83ac12e3b699649/images/cl-settings.png) - Adds a tree layout option to branches in the _GitLens_ explorer — closes [#258](https://github.com/eamodio/vscode-gitlens/issues/258) thanks to [PR #260](https://github.com/eamodio/vscode-gitlens/pull/260) by Yukai Huang ([@Yukaii](https://github.com/Yukaii))! - Adds _Follow Renames_ command (`gitlens.gitExplorer.setRenameFollowingOn`) to the _GitLens_ explorer _History_ view to follow file renames in the history @@ -1047,7 +1047,7 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/) and this p - Adds a **quick-access** command bar to the bottom of the **details** hover annotations - ![Details Blame Annotation (hover)](https://raw.githubusercontent.com/eamodio/vscode-gitlens/master/images/ss-hovers-current-line-details.png) + ![Details Blame Annotation (hover)](https://raw.githubusercontent.com/eamodio/vscode-gitlens/4ddb871459a3a1a1e132c8bdf83ac12e3b699649/images/ss-hovers-current-line-details.png) - Provides _Open Changes_, _Blame Previous Revision_, _Open in Remote_, and _Show More Actions_ command buttons @@ -1167,7 +1167,7 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/) and this p - **Repository View** - provides a full repository explorer - ![GitLens Repository view](https://raw.githubusercontent.com/eamodio/vscode-gitlens/master/images/ss-gitlens-explorer-repository.png) + ![GitLens Repository view](https://raw.githubusercontent.com/eamodio/vscode-gitlens/4ddb871459a3a1a1e132c8bdf83ac12e3b699649/images/ss-gitlens-explorer-repository.png) - **Repository Status** node — provides the status of the repository @@ -1209,7 +1209,7 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/) and this p - **File History View** - provides the revision history of the active file - ![GitLens File History view](https://raw.githubusercontent.com/eamodio/vscode-gitlens/master/images/ss-gitlens-explorer-history.png) + ![GitLens File History view](https://raw.githubusercontent.com/eamodio/vscode-gitlens/4ddb871459a3a1a1e132c8bdf83ac12e3b699649/images/ss-gitlens-explorer-history.png) - Automatically updates to track the active editor - Provides a context menu with _Open File_, _Open File in Remote_, and _Refresh_ commands @@ -1220,7 +1220,7 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/) and this p - Adds all-new interactivity to the hover annotations - ![Hover Annotations](https://raw.githubusercontent.com/eamodio/vscode-gitlens/master/images/ss-hovers-annotations.png) + ![Hover Annotations](https://raw.githubusercontent.com/eamodio/vscode-gitlens/4ddb871459a3a1a1e132c8bdf83ac12e3b699649/images/ss-hovers-annotations.png) - Adds the following command-links to the **details** hover annotation - Clicking the commit id will run the _Show Commit Details_ command diff --git a/README.md b/README.md index 0c584af..e5230ff 100644 --- a/README.md +++ b/README.md @@ -5,67 +5,16 @@
> 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.
-
+
- +
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_](https://code.visualstudio.com/docs/getstarted/userinterface#_command-palette). @@ -145,22 +95,22 @@ For more advanced customizations, refer to the [settings documentation](#gitlens ## Features -### GitLens Explorer +### Repositories Explorer- +
-A [customizable](#gitlens-explorer-settings 'Jump to the GitLens Explorer settings') explorer to navigate and explore repositories. +A [customizable](#repositories-explorer-settings 'Jump to the Repositories explorer settings') explorer to visualize, navigate, and explore Git repositories. - A toolbar provides _Search Commits_, and _Refresh_ commands - A context menu provides _Automatic Layout_, _List Layout_, _Tree Layout_, and _Enable Automatic Refresh_ or _Disable Automatic Refresh_ commands -The explorer provides a full Git repository explorer, which has the following features, +The repositories explorer provides the following features, - **Repository Status** - - Provides the name of the current branch, [optionally](#gitlens-explorer-settings 'Jump to the GitLens explorer settings') its working tree status, and its upstream tracking branch and status (if available) + - Provides the name of the current branch, [optionally](#repositories-explorer-settings 'Jump to the Repositories explorer settings') its working tree status, and its upstream tracking branch and status (if available) - Provides indicator dots on the repository icon which denote the following: - _None_ — up-to-date with the upstream - _Green_ — ahead of the upstream @@ -171,13 +121,13 @@ The explorer provides a full Git repository explorer, which has the following fe - is ahead of the upstream — quickly see and explore the specific commits ahead of the upstream (i.e. commits that haven't been pushed) - A context menu provides _Open Repository in Remote_, and _Refresh_ commands - **Changed Files** — lists all the "working" changes - - Expands to a file-based view of all changed files in the working tree ([optionally](#gitlens-explorer-settings 'Jump to the GitLens explorer settings')) and/or all files in all commits ahead of the upstream + - Expands to a file-based view of all changed files in the working tree ([optionally](#repositories-explorer-settings 'Jump to the Repositories explorer settings')) and/or all files in all commits ahead of the upstream - **History (current-branch)** — lists the revision (commit) history of the current branch - See the _Branches expand_ section under **Branches** below for more details - **Branches** — lists the local branches - - Indicates which branch is the current branch and [optionally](#gitlens-explorer-settings 'Jump to the GitLens explorer settings') shows the remote tracking branch + - Indicates which branch is the current branch and [optionally](#repositories-explorer-settings 'Jump to the Repositories explorer settings') shows the remote tracking branch - A context menu provides _Open Branches in Remote_, and _Refresh_ commands - Branches expand to show its revision (commit) history - Provides indicator dots on each branch icon which denote the following: @@ -223,18 +173,18 @@ The explorer provides a full Git repository explorer, which has the following fe --- -### GitLens File History Explorer +### File History Explorer- +
-A [customizable](#gitlens-file-history-explorer-settings 'Jump to the GitLens File History Explorer settings') explorer to visualize the revision history of the current file. +A [customizable](#file-history-explorer-settings 'Jump to the File History explorer settings') explorer to visualize, navigate, and explore the revision history of the current file. - A toolbar provides a _Refresh_ command - A context menu provides a _Follow Renames_ or _Don't Follow Renames_ command -The file history explorer provides the revision history of the current file, which has the following features, +The file history explorer provides the following features, - Automatically updates to track the current editor - A context menu provides _Open File_, _Open File in Remote_ (if available), _Copy Remote File Url to Clipboard_ (if available), and _Refresh_ commands @@ -244,18 +194,18 @@ The file history explorer provides the revision history of the current file, whi --- -### GitLens Line History Explorer +### Line History Explorer- +
-A [customizable](#gitlens-line-history-explorer-settings 'Jump to the GitLens Line History Explorer settings') explorer to visualize the revision history of the selected lines of current file. +A [customizable](#line-history-explorer-settings 'Jump to the Line History explorer settings') explorer to visualize, navigate, and explore the revision history of the selected lines of current file. - A toolbar provides a _Refresh_ command - A context menu provides a _Follow Renames_ or _Don't Follow Renames_ command -The line history explorer provides the revision history of the selected lines in the current file, which has the following features, +The line history explorer provides the following features, - Automatically updates to track the selection of the current editor - A context menu provides _Open File_, _Open File in Remote_ (if available), _Copy Remote File Url to Clipboard_ (if available), and _Refresh_ commands @@ -265,17 +215,19 @@ The line history explorer provides the revision history of the selected lines in --- -### GitLens Results Explorer +### Results Explorer- +
-An on-demand, [customizable](#gitlens-results-explorer-settings 'Jump to the GitLens Results explorer settings') explorer to navigate and explore commits, histories, and searches, or visualize comparisons between branches, tags, commits, and more +An on-demand, [customizable](#results-explorer-settings 'Jump to the Results explorer settings') explorer to navigate and explore commits, histories, and searches, or visualize comparisons between branches, tags, commits, and more - A toolbar provides _Search Commits_, _Keep Results_, and _Refresh_ commands - A context menu provides _Automatic Layout_, _List Layout_, _Tree Layout_, and _Close_ commands +The results explorer provides the following features, + #### Explore - Provides a semi-persistent results view for exploring histories, commits, and searches @@ -319,7 +271,7 @@ An on-demand, [customizable](#gitlens-results-explorer-settings 'Jump to the Git ### Code Lens- +
- Adds Git authorship **code lens** to the top of the file and on code blocks ([optional](#code-lens-settings 'Jump to the Code Lens settings'), on by default) @@ -346,7 +298,7 @@ An on-demand, [customizable](#gitlens-results-explorer-settings 'Jump to the Git ### Current Line Blame- +
- Adds an unobtrusive, [customizable](#current-line-blame-settings 'Jump to the Current Line Blame settings'), and [themable](#themable-colors 'Jump to the Themable Colors'), **blame annotation** at the end of the current line @@ -358,7 +310,7 @@ An on-demand, [customizable](#gitlens-results-explorer-settings 'Jump to the Git ### Gutter Blame- +
- Adds on-demand, [customizable](#gutter-blame-settings 'Jump to the Gutter Blame settings'), and [themable](#themable-colors 'Jump to the Themable Colors'), **gutter blame annotations** for the whole file @@ -373,7 +325,7 @@ An on-demand, [customizable](#gitlens-results-explorer-settings 'Jump to the Git ### Gutter Heatmap- +
- Adds an on-demand **heatmap** to the edge of the gutter to show how recently lines were changed @@ -389,7 +341,7 @@ An on-demand, [customizable](#gitlens-results-explorer-settings 'Jump to the Git #### Current Line Hovers- +
- Adds [customizable](#hover-settings 'Jump to the Hover settings') Git blame hovers accessible over the current line @@ -397,7 +349,7 @@ An on-demand, [customizable](#gitlens-results-explorer-settings 'Jump to the Git ##### Details Hover- +
- Adds a **details hover** annotation to the current line to show more commit details ([optional](#hover-settings 'Jump to the Hover settings'), on by default) @@ -408,7 +360,7 @@ An on-demand, [customizable](#gitlens-results-explorer-settings 'Jump to the Git ##### Changes (diff) Hover- +
- Adds a **changes (diff) hover** annotation to the current line to show the line's previous version ([optional](#hover-settings 'Jump to the Hover settings'), on by default) @@ -418,7 +370,7 @@ An on-demand, [customizable](#gitlens-results-explorer-settings 'Jump to the Git #### Annotation Hovers- +
- Adds [customizable](#hover-settings 'Jump to the Hover settings') Git blame hovers accessible when annotating @@ -426,7 +378,7 @@ An on-demand, [customizable](#gitlens-results-explorer-settings 'Jump to the Git ##### Details Hover- +
- Adds a **details hover** annotation to each line while annotating to show more commit details ([optional](#hover-settings 'Jump to the Hover settings'), on by default) @@ -437,7 +389,7 @@ An on-demand, [customizable](#gitlens-results-explorer-settings 'Jump to the Git ##### Changes (diff) Hover- +
- Adds a **changes (diff) hover** annotation to each line while annotating to show the line's previous version ([optional](#hover-settings 'Jump to the Hover settings'), on by default) @@ -461,7 +413,7 @@ An on-demand, [customizable](#gitlens-results-explorer-settings 'Jump to the Git ### Recent Changes- +
- Adds an on-demand, [customizable](#recent-changes-settings 'Jump to the Recent Changes settings') and [themable](#themable-colors 'Jump to the Themable Colors'), **recent changes annotation** to highlight lines changed by the most recent commit @@ -473,7 +425,7 @@ An on-demand, [customizable](#gitlens-results-explorer-settings 'Jump to the Git ### Status Bar Blame- +
- Adds a [customizable](#status-bar-settings 'Jump to the Status Bar Blame settings') **Git blame annotation** about the current line to the **status bar** ([optional](#status-bar-settings 'Jump to the Status Bar Blame settings'), on by default) @@ -502,7 +454,7 @@ An on-demand, [customizable](#gitlens-results-explorer-settings 'Jump to the Git - Use `#- +
- 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 @@ -536,7 +488,7 @@ An on-demand, [customizable](#gitlens-results-explorer-settings 'Jump to the Git #### File History- +
- Adds a _Show File History_ command (`gitlens.showQuickFileHistory`) to show a paged **file history quick pick menu** of the current file for exploring its commit history @@ -547,7 +499,7 @@ An on-demand, [customizable](#gitlens-results-explorer-settings 'Jump to the Git #### Commit Details- +
- Adds a _Show Commit Details_ command (`gitlens.showQuickCommitDetails`) to show a **commit details quick pick menu** of the most recent commit of the current file @@ -558,7 +510,7 @@ An on-demand, [customizable](#gitlens-results-explorer-settings 'Jump to the Git - Use the `alt+right arrow` shortcut on a file entry in the `Changed Files` section to preview the comparison of the current revision with the previous one- +
- Adds a _Show Commit File Details_ command (`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 @@ -569,7 +521,7 @@ An on-demand, [customizable](#gitlens-results-explorer-settings 'Jump to the Git #### Repository Status- +
- Adds a _Show Repository Status_ command (`gitlens.showQuickRepoStatus`) with a shortcut of `alt+s` to show a **repository status quick pick menu** for visualizing the current repository status @@ -584,7 +536,7 @@ An on-demand, [customizable](#gitlens-results-explorer-settings 'Jump to the Git #### Stashes- +
- Adds a _Show Stashed Changes_ command (`gitlens.showQuickStashList`) to show a **stashed changes quick pick menu** for exploring your repository stash history @@ -598,7 +550,7 @@ An on-demand, [customizable](#gitlens-results-explorer-settings 'Jump to the Git #### Stash Details- +
- Stashed changes show a **stash details quick pick menu** which is very similar to the **commit details quick pick menu** above @@ -683,64 +635,64 @@ GitLens is highly customizable and provides many configuration settings to allow | `gitlens.settings.mode` | Specifies the display mode of the interactive settings editor- GitLens - supercharges the Git capabilities built into Visual Studio Code. It helps you to + 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. @@ -50,10 +49,13 @@
For advanced customizations refer to the - GitLens - settings docs and edit your - User - Settings + + GitLens settings docs + + and edit your + + User Settings +
@@ -113,17 +115,18 @@- Search for - - gitlens - in the - Keyboard - Shortcuts editor to see the shortcuts and to customize them further + Search for gitlens in the + + Keyboard Shortcuts + + editor to see the shortcuts and to customize them further
@@ -280,35 +283,36 @@For more advanced customizations open - User - Settings and search for - - gitlens - + + User Settings + + and search for gitlens
-Adds a GitLens explorer to navigate and explore repositories - or file histories
++ Adds a Repositories explorer to visualize, navigate, and explore Git repositories +
For more advanced customizations open - User - Settings and search for - - gitlens.gitExplorer - or - - gitlens.explorers - + + User Settings + + and search for gitlens.repositoriesExplorer or gitlens.explorers
Adds a GitLens File History explorer to visualize the - revision history of the current file
++ Adds a File History explorer to visualize, navigate, and explore the revision history + of the current file +
Adds a GitLens Line History explorer to visualize the - revision history of the selected lines of current file
++ Adds a Line History explorer to visualize, navigate, and explore the revision history + of the selected lines of current file +
Adds an on-demand GitLens Results explorer to navigate and - explore commits, histories, and searches, - or visualize comparisons between branches, tags, commits, and more
++ Adds an on-demand Results explorer to navigate and explore commits, histories, and + searches, or visualize comparisons between branches, tags, commits, and more +
For more advanced customizations open - User - Settings and search for - - gitlens.resultsExplorer - or - - gitlens.explorers - + + User Settings + + and search for gitlens.resultsExplorer or gitlens.explorers
Adds authorship code lens to the top of files and on code - blocks
++ Adds authorship code lens to the top of files and on code blocks +
For more advanced customizations open - User - Settings and search for - - gitlens.codeLens - + + User Settings + + and search for gitlens.codeLens Use the - GitLens: - Toggle Git Code Lens command to override this setting for the current - window + + GitLens: Toggle Git Code Lens + + command to override this setting for the current window
Adds an unobtrusive blame annotation at the end of the - current line
++ Adds an unobtrusive blame annotation at the end of the current line +
For more advanced customizations open - User - Settings and search for - - gitlens.currentLine - + + User Settings + + and search for gitlens.currentLine Use the - GitLens: - Toggle Line Blame Annotations command to override this setting for the - current - window + + GitLens: Toggle Line Blame Annotations + + command to override this setting for the current window
Indicator color reflects the age of the most recent change - (hot or cold), while indicator - brightness ranges from bright (newer) to dim (older) based on the relative age
++ Indicator color reflects the age of the most recent change (hot or cold), while + indicator brightness ranges from bright (newer) to dim (older) based on the + relative age +
- +Adds on-demand heatmap (age) indicator to the edge of the
- gutter to show how recently lines were
- changed
-
Indicator color reflects the age of the most recent change (hot or cold), while
- indicator
- brightness ranges from bright (newer) to dim (older) based on the relative age
+
+ Adds on-demand heatmap (age) indicator to the edge of the gutter to show how recently
+ lines were changed
Indicator color reflects the age of the most recent change
+ (hot or cold), while indicator brightness ranges from bright (newer) to dim (older)
+ based on the relative age
Use the - - Press - Esc to turn off the annotations + Press Esc to turn off the annotations
@@ -1251,8 +1276,9 @@ - + + data-visibility="heatmap.toggleMode =window"> + GitLens: Toggle File Heatmap Annotations + command to turn the annotations on or offGitLens supports user-defined modes for quickly toggling - between sets of settings
++ GitLens supports user-defined modes for quickly toggling between sets of settings +
For more advanced customizations or to add your own modes, open - User - Settings and search for - - gitlens.modes - + + User Settings + + and search for gitlens.modes Use the - GitLens: - Switch Mode command to quickly switch the active mode + + GitLens: Switch Mode + + command to quickly switch the active mode Use the - GitLens: - Toggle Review Mode command to toggle Review mode + + GitLens: Toggle Review Mode + + command to toggle Review mode Use the - GitLens: - Toggle Zen Mode command to toggle Zen mode + + GitLens: Toggle Zen Mode + + command to toggle Zen mode
Adds on-demand recent changes annotations to highlight lines - changed by the most recent commit
++ Adds on-demand recent changes annotations to highlight lines changed by the most recent + commit +
Use the - - Press - Esc to turn off the annotations + Press Esc to turn off the annotations
+ + data-visibility="recentChanges.toggleMode =window"> + GitLens: Toggle Recent File Changes Annotations + command to turn the annotations on or offAdds a Git blame annotation about the current line to the - status bar
++ Adds a Git blame annotation about the current line to the status bar +
For more advanced customizations open - User - Settings and search for - - gitlens.statusBar - + + User Settings + + and search for gitlens.statusBar Use the - GitLens: - Toggle Line Blame Annotations command to override this setting for the - current - window + + GitLens: Toggle Line Blame Annotations + + command to override this setting for the current window
- GitLens - supercharges the Git capabilities built into Visual Studio Code. It helps you to + 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. @@ -29,1050 +28,40 @@
The new view is enabled by default, but can easily be configured back to the existing - locations via the - GitLens interactive settings editor -
gitlens.showQuickFileHistory
) — closes
- #316
-
- gitlens.diffWithRevision
) as an alternate (
- alt+click
) for the
- Compare File with Previous Revision command in the editor toolbar
-
- gitlens.terminalCheckoutCommit
) to commit node(s) of the GitLens explorer
- — closes
- #463
-
- gitlens.hovers.avatars
setting to specify whether to show avatar images in hovers
- — closes
- #432
- thanks to
- PR #441
- by
- Segev Finer
-
- gitlens.historyExplorer.avatars
setting to specify whether to show avatar images
- instead of status icons in the
- GitLens File History explorer — allows for an independent value from the other explorers
-
- gitlens.hovers.avatars
setting to the
- GitLens interactive settings editor to specify whether to show avatar images in hovers
-
- gitlens.copyRemoteFileUrlToClipboard
)
- command — copies the remote url of the current file and line to the clipboard — closes
- #467
-
- gitlens.diffWithRevision
) to
- Choose from Branch or Tag History...
-
- gitlens.terminalRebaseCommit
)
- to apply to all commit node(s) of the GitLens explorer
-
- gitlens.terminalResetCommit
)
- to apply to all commit node(s) of the GitLens explorer
-
- gitlens:activeIsTracked
,
- gitlens:activeIsBlameable
,
- gitlens:activeIsRevision
, and
- gitlens:activeHasRemotes
contexts and consolidates them into
- gitlens:activeFileStatus
for better performance and UX
-
- -
-
- --first-parent
from git commands to show file history from merged in
-
- suppressShowKeyBindingsNotice
gets saved even when it is not required
-
- The indicator's color, now customizable, will either be hot or cold based on the age of - the most recent change (cold after 90 days by default) — closes - #419 -
- -The indicator's brightness ranges from bright (newer) to dim (older) based on the relative - age, which is calculated from the median age of all the changes in the file -
-gitlens.heatmap.ageThreshold
setting to specify 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
setting to specify the base color of the gutter heatmap
- annotations when the most recent change is older (cold) than the
- gitlens.heatmap.ageThreshold
setting
-
- gitlens.heatmap.hotColor
setting to specify the base color of the gutter heatmap
- annotations when the most recent change is newer (hot) than the
- gitlens.heatmap.ageThreshold
setting
-
- SymbolInformation
API changes (see
- Microsoft/vscode#34968)
-
- gitlens.switchMode
) to quickly switch the active GitLens mode
-
- gitlens.toggleZenMode
) to toggle Zen mode which disables many visual features
-
- gitlens.toggleReviewMode
) to toggle Review mode which enables many visual features
-
- gitlens.mode.*
) to the interactive settings editor
- gitlens.diffWithPrevious
) and moves it into the editor toolbar
-
- gitlens.diffWithNext
) and moves it into the editor toolbar
-
- gitlens.menus.*
) to the interactive settings editor
- gitlens.showGitExplorer
) — shows/expands the
- GitLens explorer
-
- gitlens.showHistoryExplorer
) — shows/expands the
- GitLens File History explorer
-
- gitlens.showResultsExplorer
) — shows/expands the
- GitLens Results explorer
-
- gitlens.explorers.closeRepository
) to repository and repository status nodes in
- the
- GitLens explorer — closes (hides) the repository in the
- GitLens explorer
-
- gitlens.openFileInRemote
) when the current branch has no upstream tracking branch
- — closes
- #209
-
- gitlens.advanced.menus
setting to
- gitlens.menus
-
- gitlens.openWorkingFile
) to the right of the
- Compare File with * Revision commands in the editor toolbar
-
- alt+,
gets stuck
-
- Open View
command
-
- chorded
keyboard shortcut for the
- Compare File with Previous Revision command (
- gitlens.diffWithPreviousInDiff
) — from
- #395
-
- gitlens.openWorkingFile
) not always showing in the editor toolbar when appropriate
-
- gitlens.defaultDateStyle
settings — closes
- #312
- gitlens.*.format
) to the interactive settings editor
- gitlens.currentLine.scrollable
setting to specify whether the current line blame
- annotation can be scrolled into view when it is outside the viewport — closes
- #149,
- #290,
- #265
- gitlens.statusBar.reduceFlicker
setting to the interactive settings editor
- - See the - release - notes - for the full set of changes + See the + release notes + + for the full set of changes
- GitLens is - an - open-source + 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. + . 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. Dive right in and see how GitLens can help! + 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. Dive right in and see how GitLens can + help!
-Here are just some of the features that GitLens provides, +
+ Here are just some of the features that GitLens provides,
GitLens is powerful, feature rich, and 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
- User
- Settings
+
+ GitLens is powerful, feature rich, and 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
+ User Settings
.
- 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 1 - 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. + 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. + 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. - 😉 + If you'd like to join them in supporting GitLens, please consider the following — + feel free to choose more than one. 😉