37 lines
1.6 KiB

  1. # GitLens
  2. Provides Git blame and blame history CodeLens for many supported Visual Studio Code languages (in theory -- the language must support symbol searching).
  3. ## Features
  4. Provides two CodeLens on code blocks :
  5. - **Recent Change** - author and date of the most recent check-in
  6. > Clicking on the CodeLens opens a **Blame explorer** with the commits and changed lines in the right pane and the commit (file) contents on the left
  7. - **Blame** - number of authors of a block and the most prominent author (if there are more than one)
  8. > Clicking on the CodeLens toggles Git blame overlay
  9. > ![GitLens preview](https://raw.githubusercontent.com/eamodio/vscode-git-codelens/master/images/preview-gitlens.gif)
  10. ## Requirements
  11. Must be using Git and it must be in your path.
  12. ## Extension Settings
  13. None yet.
  14. ## Known Issues
  15. - Content in the **Blame explorer** disappears after a bit: [Open vscode issue](https://github.com/Microsoft/vscode/issues/11360)
  16. - Highlighted lines disappear in **Blame explorer** after changing selection and returning to a previous selection: [Open vscode issue](https://github.com/Microsoft/vscode/issues/11360)
  17. - CodeLens aren't updated properly after a file is saved: [Open vscode issue](https://github.com/Microsoft/vscode/issues/11546)
  18. - Visible whitespace causes issue with blame overlay (currently fixed with a hack, but fails randomly): [Open vscode issue](https://github.com/Microsoft/vscode/issues/11485)
  19. ## Release Notes
  20. ### 0.0.4
  21. Candidate for preview release on the vscode marketplace.
  22. ### 0.0.1
  23. Initial release but still heavily a work in progress.