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.

89 lines
5.8 KiB

  1. # GitLens
  2. Provides Git information (most recent commit, # of authors) in CodeLens, on-demand inline blame annotations, a blame explorer, and commands to compare changes with the working tree or previous versions.
  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. - **Authors** - 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 annotations on/off
  9. ## Screenshot
  10. > ![GitLens preview](https://raw.githubusercontent.com/eamodio/vscode-git-codelens/master/images/preview-gitlens.gif)
  11. ## Requirements
  12. Must be using Git and it must be in your path.
  13. ## Extension Settings
  14. |Name | Description
  15. |-----|------------
  16. |`gitlens.blame.annotation.style`|Specifies the style of the blame annotations. `compact` - groups annotations to limit the repetition and also adds author and date when possible. `expanded` - shows an annotation on every line
  17. |`gitlens.blame.annotation.sha`|Specifies whether the commit sha will be shown in the blame annotations. Applies only to the `expanded` annotation style
  18. |`gitlens.blame.annotation.author`|Specifies whether the committer will be shown in the blame annotations. Applies only to the `expanded` annotation style
  19. |`gitlens.blame.annotation.date`|Specifies whether the commit date will be shown in the blame annotations. Applies only to the `expanded` annotation style
  20. |`gitlens.blame.annotation.useCodeActions`|Specifies whether code actions (Diff with Working, Diff with Previous) will be provided for the selected line, when annotating. Not required as context menu options are always provided
  21. |`gitlens.codeLens.visibility`|Specifies when CodeLens will be triggered in the active document. `auto` - automatically. `ondemand` - only when requested. `off` - disables all active document CodeLens
  22. |`gitlens.codeLens.location`|Specifies where CodeLens will be rendered in the active document. `all` - render at the top of the document, on container-like (classes, modules, etc), and on member-like (methods, functions, properties, etc) lines. `document+containers` - render at the top of the document and on container-like lines. `document` - only render at the top of the document. `custom` - rendering controlled by `gitlens.codeLens.locationCustomSymbols`
  23. |`gitlens.codeLens.locationCustomSymbols`|Specifies the set of document symbols to render active document CodeLens on. Must be a member of `SymbolKind`
  24. |`gitlens.codeLens.recentChange.enabled`|Specifies whether the recent change CodeLens is shown
  25. |`gitlens.codeLens.recentChange.command`|Specifies the command executed when the recent change CodeLens is clicked. `blame.annotate` - toggles blame annotations. `blame.explorer` - opens the blame explorer. `git.history` - opens a file history picker, which requires the Git History (git log) extension
  26. |`gitlens.codeLens.authors.enabled`|Specifies whether the authors CodeLens is shown
  27. |`gitlens.codeLens.authors.command`|Specifies the command executed when the authors CodeLens is clicked. `blame.annotate` - toggles blame annotations. `blame.explorer` - opens the blame explorer. `git.history` - opens a file history picker, which requires the Git History (git log) extension
  28. ## Known Issues
  29. - Content in the **Blame explorer** disappears after a bit: [vscode issue](https://github.com/Microsoft/vscode/issues/11360)
  30. - Highlighted lines disappear in **Blame explorer** after changing selection and returning to a previous selection: [vscode issue](https://github.com/Microsoft/vscode/issues/11360)
  31. - CodeLens aren't updated properly after a file is saved: [vscode issue](https://github.com/Microsoft/vscode/issues/11546)
  32. - Visible whitespace causes issue with blame overlay (currently fixed with a hack, but fails randomly): [vscode issue](https://github.com/Microsoft/vscode/issues/11485)
  33. ## Release Notes
  34. ### 0.3.1
  35. - Adds new CodeLens visibility & location settings -- see **Extension Settings** above for details
  36. - Adds new command to toggle CodeLens on and off when `gitlens.codeLens.visibility` is set to `ondemand`
  37. ### 0.2.0
  38. - Fixes [#1](https://github.com/eamodio/vscode-gitlens/issues/1) - Support blame on files outside the workspace repository
  39. - Replaces blame regex parsing with a more robust parser
  40. - Fixes failures with Diff with Previous command
  41. - Fixes issues with blame explorer CodeLens when dealing with previous commits
  42. - Fixes display issues with compact blame annotations (now skips blank lines)
  43. ### 0.1.3
  44. - Improved blame annotations, now with sha and author by default
  45. - Add new blame annotation styles -- compact and expanded (default)
  46. - Adds many new configuration settings; see **Extension Settings** above for details
  47. ### 0.0.7
  48. - Fixes [#4](https://github.com/eamodio/vscode-gitlens/issues/4) - Absolute paths fail on Windows due to backslash (Really!)
  49. - Fixes [#5](https://github.com/eamodio/vscode-gitlens/issues/5) - Finding first non-white-space fails sometimes
  50. - Adds .gitignore checks to reduce the number of blame calls
  51. ### 0.0.6
  52. - Fixes [#2](https://github.com/eamodio/vscode-gitlens/issues/2) - [request] Provide some debug info when things fail
  53. - Fixes [#4](https://github.com/eamodio/vscode-gitlens/issues/4) - Absolute paths fail on Windows due to backslash
  54. - Attempts to scroll to the correct position when opening a diff
  55. ### 0.0.5
  56. - Fixes issues where filename changes in history would cause diffs to fails
  57. - Fixes some issues with uncommited blames
  58. - Removes CodeLens from fields and single-line properties to reduce visual noise
  59. - Automatically turns off blame only when required now
  60. ### 0.0.4
  61. Candidate for preview release on the vscode marketplace.
  62. ### 0.0.1
  63. Initial release but still heavily a work in progress.