You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

43 lines
2.6 KiB

  1. ## File Annotations
  2. <p align="center">
  3. <img src="../../images/docs/gutter-toggle.png" alt="Toggle File Annotations" />
  4. </p>
  5. GitLens adds on-demand annotations for the whole file directly to the editor's scroll bar and in the gutter area, the space beside the line number, to help you gain more insights into your code.
  6. ### File Blame
  7. <p align="center">
  8. <img src="../../images/docs/gutter-blame.png" alt="File Blame" />
  9. </p>
  10. When activated, GitLens expands the gutter area to show the commit and author for each line of the file, similar to the current line blame. On the right edge of the gutter, an age indicator (heatmap) is shown to provide an easy, at-a-glance way to tell how recently lines were changed (see the Heatmap below for more details). An additional indicator, which highlights other lines that were also changed as part of the current line's commit, is shown both the far left edge and on the scrollbar.
  11. 💡 On an active file, use the [Toggle File Blame](command:workbench.action.quickOpen?%22>GitLens%3A%20Toggle%20File%20Blame%22) command from the Command Palette to turn the annotation on and off.
  12. ⚙️ Use the settings editor to customize the [file blame](command:gitlens.showSettingsPage?%22blame%22 'Jump to the File Blame settings').
  13. ### File Changes
  14. <p align="center">
  15. <img src="../../images/docs/gutter-changes.png" alt="File Changes" />
  16. </p>
  17. When activated, indicators are shown on the editor to highlight any local, unpublished, changes or lines changed by the most recent commit.
  18. 💡 On an active file, use the [Toggle File Changes](command:workbench.action.quickOpen?%22>GitLens%3A%20Toggle%20File%20Changes%22) command from the Command Palette to turn the annotation on and off.
  19. ⚙️ Use the settings editor to customize the [file changes](command:gitlens.showSettingsPage?%22changes%22 'Jump to the File Changes settings').
  20. ### Heatmap
  21. <p align="center">
  22. <img src="../../images/docs/gutter-heatmap.png" alt="File Heatmap" />
  23. </p>
  24. When activated, color-coded indicators are shown on the editor to highlight how recently lines were changed relative to all the other changes in the file. The colors range from hot, orange, to cold, blue, based on the age of the most recent change. Changes are considered cold after 90 days.
  25. 💡 On an active file, use the [Toggle File Heatmap](command:workbench.action.quickOpen?%22>GitLens%3A%20Toggle%20File%20Heatmap%22) command from the Command Palette to turn the annotation on and off.
  26. ⚙️ Use the settings editor to customize the [file heatmap](command:gitlens.showSettingsPage?%22heatmap%22 'Jump to the File Heatmap settings').