|
|
- # GitLens
-
- 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.
-
- ## Features
-
- Provides two CodeLens on code blocks:
- - **Recent Change** - author and date of the most recent check-in
- > 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
- - **Authors** - number of authors of a block and the most prominent author (if there are more than one)
- > Clicking on the CodeLens toggles Git blame annotations on/off
-
- ## Screenshot
- > 
-
- ## Requirements
-
- Must be using Git and it must be in your path.
-
- ## Extension Settings
-
- |Name | Description
- |-----|------------
- |_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
- |_gitlens.blame.annotation.sha_|Specifies whether the commit sha will be shown in the blame annotations. Applies only to the Expanded annotation style
- |_gitlens.blame.annotation.author_|Specifies whether the committer will be shown in the blame annotations. Applies only to the Expanded annotation style
- |_gitlens.blame.annotation.date_|Specifies whether the commit date will be shown in the blame annotations. Applies only to the Expanded annotation style
- |_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
- |_gitlens.codeLens.recentChange.enabled_|Specifies whether the recent change CodeLens is shown
- |_gitlens.codeLens.recentChange.command_|Specifies the command executed when the recent change CodeLens is clicked. Annotate - toggles blame annotations. Explorer - opens the blame explorer. History - opens a file history picker, which requires the Git History (git log) extension
- |_gitlens.codeLens.authors.enabled_|Specifies whether the authors CodeLens is shown
- |_gitlens.codeLens.authors.command_|Specifies the command executed when the authors CodeLens is clicked. Annotate - toggles blame annotations. Explorer - opens the blame explorer. History - opens a file history picker, which requires the Git History (git log) extension
-
- ## Known Issues
-
- - Content in the **Blame explorer** disappears after a bit: [vscode issue](https://github.com/Microsoft/vscode/issues/11360)
- - Highlighted lines disappear in **Blame explorer** after changing selection and returning to a previous selection: [vscode issue](https://github.com/Microsoft/vscode/issues/11360)
- - CodeLens aren't updated properly after a file is saved: [vscode issue](https://github.com/Microsoft/vscode/issues/11546)
- - Visible whitespace causes issue with blame overlay (currently fixed with a hack, but fails randomly): [vscode issue](https://github.com/Microsoft/vscode/issues/11485)
-
- ## Release Notes
-
- ### 0.2.0
-
- - Fixes [#1](https://github.com/eamodio/vscode-gitlens/issues/1) - Support blame on files outside the workspace repository
- - Replaces blame regex parsing with a more robust parser
- - Fixes failures with Diff with Previous command
- - Fixes issues with blame explorer CodeLens when dealing with previous commits
- - Fixes display issues with compact blame annotations (now skips blank lines)
-
- ### 0.1.3
-
- - Improved blame annotations, now with sha and author by default
- - Add new blame annotation styles -- compact and expanded (default)
- - Adds many new configuration settings; see Contributions tab above
-
- ### 0.0.7
-
- - Fixes [#4](https://github.com/eamodio/vscode-gitlens/issues/4) - Absolute paths fail on Windows due to backslash (Really!)
- - Fixes [#5](https://github.com/eamodio/vscode-gitlens/issues/5) - Finding first non-white-space fails sometimes
- - Adds .gitignore checks to reduce the number of blame calls
-
- ### 0.0.6
-
- - Fixes [#2](https://github.com/eamodio/vscode-gitlens/issues/2) - [request] Provide some debug info when things fail
- - Fixes [#4](https://github.com/eamodio/vscode-gitlens/issues/4) - Absolute paths fail on Windows due to backslash
- - Attempts to scroll to the correct position when opening a diff
-
- ### 0.0.5
-
- - Fixes issues where filename changes in history would cause diffs to fails
- - Fixes some issues with uncommited blames
- - Removes CodeLens from fields and single-line properties to reduce visual noise
- - Automatically turns off blame only when required now
-
- ### 0.0.4
-
- Candidate for preview release on the vscode marketplace.
-
- ### 0.0.1
-
- Initial release but still heavily a work in progress.
|
