wlxsp
/
test1
1
0
Fork 0
Code Issues 0 Pull Requests 0 Releases 0 Wiki Activity
Browse Source

Adds note about hovers - closes #1293

main
Eric Amodio 3 years ago
parent
10ec613441
commit
bbbbc017aa
4 changed files with 26 additions and 9 deletions
Split View
Diff Options
Show Stats Download Patch File Download Diff File
  1. +7
    -7
      README.md
  2. +1
    -1
      package.json
  3. +8
    -0
      src/webviews/apps/scss/base.scss
  4. +10
    -1
      src/webviews/apps/settings/partials/current-line.html

+ 7
- 7
README.md View File

@ -641,13 +641,13 @@ GitLens is highly customizable and provides many configuration settings to allow
## Current Line Blame Settings [#](#current-line-blame-settings- 'Current Line Blame Settings')
| Name | Description |
| ------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `gitlens.currentLine.dateFormat` | Specifies how to format absolute dates (e.g. using the `${date}` token) for the current line blame annotations. See the [Moment.js docs](https://momentjs.com/docs/#/displaying/format/) for valid formats |
| `gitlens.currentLine.enabled` | Specifies whether to provide a blame annotation for the current line, by default. Use the _Toggle Line Blame Annotations_ command (`gitlens.toggleLineBlame`) to toggle the annotations on and off for the current window |
| `gitlens.currentLine.format` | Specifies the format of the current line blame annotation. See [_Commit Tokens_](https://github.com/eamodio/vscode-gitlens/wiki/Custom-Formatting#commit-tokens) in the GitLens docs. Date formatting is controlled by the `gitlens.currentLine.dateFormat` setting |
| `gitlens.currentLine.pullRequests.enabled` | Specifies whether to provide information about the Pull Request (if any) that introduced the commit in the current line blame annotation. Requires a connection to a supported remote service (e.g. GitHub) |
| `gitlens.currentLine.scrollable` | Specifies whether the current line blame annotation can be scrolled into view when it is outside the viewport |
| Name | Description |
| ------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `gitlens.currentLine.dateFormat` | Specifies how to format absolute dates (e.g. using the `${date}` token) for the current line blame annotations. See the [Moment.js docs](https://momentjs.com/docs/#/displaying/format/) for valid formats |
| `gitlens.currentLine.enabled` | Specifies whether to provide a blame annotation for the current line, by default. Use the _Toggle Line Blame Annotations_ command (`gitlens.toggleLineBlame`) to toggle the annotations on and off for the current window |
| `gitlens.currentLine.format` | Specifies the format of the current line blame annotation. See [_Commit Tokens_](https://github.com/eamodio/vscode-gitlens/wiki/Custom-Formatting#commit-tokens) in the GitLens docs. Date formatting is controlled by the `gitlens.currentLine.dateFormat` setting |
| `gitlens.currentLine.pullRequests.enabled` | Specifies whether to provide information about the Pull Request (if any) that introduced the commit in the current line blame annotation. Requires a connection to a supported remote service (e.g. GitHub) |
| `gitlens.currentLine.scrollable` | Specifies whether the current line blame annotation can be scrolled into view when it is outside the viewport. **NOTE**: Setting this to `false` will inhibit the hovers from showing over the annotation; Set `gitlens.hovers.currentLine.over` to `line` to enable the hovers to show anywhere over the line. |
## Git Code Lens Settings [#](#git-code-lens-settings- 'Git Code Lens Settings')

+ 1
- 1
package.json View File

@ -538,7 +538,7 @@
"gitlens.currentLine.scrollable": {
"type": "boolean",
"default": true,
"markdownDescription": "Specifies whether the current line blame annotation can be scrolled into view when it is outside the viewport",
"markdownDescription": "Specifies whether the current line blame annotation can be scrolled into view when it is outside the viewport. **NOTE**: Setting this to `false` will inhibit the hovers from showing over the annotation; Set `#gitlens.hovers.currentLine.over#` to `line` to enable the hovers to show anywhere over the line.",
"scope": "window"
},
"gitlens.debug": {

+ 8
- 0
src/webviews/apps/scss/base.scss View File

@ -242,3 +242,11 @@ ul {
::-webkit-scrollbar-corner {
background-color: transparent !important;
}
code {
background: rgba(255, 255, 255, 0.05);
color: var(--color-foreground--75);
border-radius: 3px;
padding: 2px 4px;
vertical-align: middle;
}

+ 10
- 1
src/webviews/apps/settings/partials/current-line.html View File

@ -100,7 +100,16 @@
</label>
</div>
<p class="setting__hint">
When enabled the annotation can be scrolled into view when it is outside the viewport
When enabled the annotation can be scrolled into view when it is outside the viewport.
</p>
<p class="setting__hint">
<i class="icon icon__info"></i>
Setting this to <code>false</code> will inhibit the hovers from showing over the annotation;
Set
<a title="Jump to Hovers settings" data-action="jump" href="#hovers.currentLine.over"
><code>gitlens.hovers.currentLine.over</code></a
>
to <code>line</code> to enable the hovers to show anywhere over the line.
</p>
</div>
</div>

Write Preview
Loading…
Cancel
Save