Browse Source

Removes dead file annotation settings

Adds missing settings to README
main
Eric Amodio 4 years ago
parent
commit
807dec5b6b
4 changed files with 39 additions and 114 deletions
  1. +0
    -3
      CHANGELOG.md
  2. +11
    -7
      README.md
  3. +28
    -64
      package.json
  4. +0
    -40
      src/webviews/apps/settings/partials/menus.html

+ 0
- 3
CHANGELOG.md View File

@ -70,9 +70,6 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/) and this p
- Adds a new default click action on changed files nodes in GitLens views to open all changes
- Adds a new `gitlens.hovers.avatarSize` setting to customize the size of avatars shown in hovers
- Increases the default avatar size in hovers from 16px to 32px
- Adds new `gitlens.fileAnnotations.command` & `gitlens.fileAnnotations.diffCommand` settings to control the behavior of the toggling of file annotations from the editor toolbar
- Choose both the default click behavior as well as the `alt`+click behavior
- Can also be configured via the GitLens Interactive Settings in the _Menus & Toolbars_ section
- Adds new _Welcome_ and _Open Settings_ menu options to the GitLens context/gear menu in the _Extensions_ sidebar — closes [#952](https://github.com/eamodio/vscode-gitlens/issues/952) & [#953](https://github.com/eamodio/vscode-gitlens/issues/953) thanks to [PR #992](https://github.com/eamodio/vscode-gitlens/pull/992) by Zeeshan Adnan ([@zeeshanadnan](https://github.com/zeeshanadnan))
- Adds a new _Set Views Layout_ (`gitlens.setViewsLayout`) command — quickly switch between showing GitLens views in _GitLens_ sidebar (default) and the _Source Control_ sidebar
- Adds a _Clear_ command to branch comparison nodes in the _Commits_ and _Repositories_ views

+ 11
- 7
README.md View File

@ -695,12 +695,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.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 |
## Git Code Lens Settings [#](#git-code-lens-settings- 'Git Code Lens Settings')
@ -742,8 +743,11 @@ GitLens is highly customizable and provides many configuration settings to allow
| `gitlens.hovers.currentLine.details` | Specifies whether to provide a _commit details_ hover for the current line |
| `gitlens.hovers.currentLine.enabled` | Specifies whether to provide any hovers for the current line |
| `gitlens.hovers.currentLine.over` | Specifies when to trigger hovers for the current line<br /><br />`annotation` - only shown when hovering over the line annotation<br />`line` - shown when hovering anywhere over the line |
| `gitlens.hovers.enabled` | Specifies whether to provide any hovers |
| `gitlens.hovers.detailsMarkdownFormat` | Specifies the format (in markdown) of the _commit details_ hover. See [_Commit Tokens_](https://github.com/eamodio/vscode-gitlens/wiki/Custom-Formatting#commit-tokens) in the GitLens docs |
| `gitlens.hovers.enabled` | Specifies whether to provide any hovers |
| `gitlens.hovers.autolinks.enabled` | Specifies whether to automatically link external resources in commit messages |
| `gitlens.hovers.autolinks.enhanced` | Specifies whether to lookup additional details about automatically link external resources in commit messages. Requires a connection to a supported remote service (e.g. GitHub) |
| `gitlens.hovers.pullRequests.enabled` | Specifies whether to provide information about the Pull Request (if any) that introduced the commit in the hovers. Requires a connection to a supported remote service (e.g. GitHub) |
## View Settings [#](#view-settings- 'View Settings')

+ 28
- 64
package.json View File

@ -581,7 +581,7 @@
"gitlens.currentLine.pullRequests.enabled": {
"type": "boolean",
"default": true,
"markdownDescription": "Specifies whether to provide information about the Pull Request (if any) that introduced a commit in the current line blame annotation. Requires a connection to a supported remote service (e.g. GitHub)",
"markdownDescription": "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)",
"scope": "window"
},
"gitlens.currentLine.scrollable": {
@ -664,42 +664,6 @@
"markdownDescription": "Specifies the style of the gravatar default (fallback) images",
"scope": "window"
},
"gitlens.fileAnnotations.command": {
"type": "string",
"default": "blame+heatmap",
"enum": [
"blame+heatmap",
"blame+changes",
"changes+blame",
"changes+heatmap",
"heatmap+blame",
"heatmap+changes"
],
"enumDescriptions": [
"Toggles Gutter Blame annotations, and toggles Gutter Heatmap annotations when holding `alt`",
"Toggles Gutter Blame annotations, and toggles Gutter Changes annotations when holding `alt`",
"Toggles Gutter Changes annotations, and toggles Gutter Blame annotations when holding `alt`",
"Toggles Gutter Changes annotations, and toggles Gutter Heatmap annotations when holding `alt`",
"Toggles Gutter Heatmap annotations, and toggles Gutter Blame annotations when holding `alt`",
"Toggles Gutter Heatmap annotations, and toggles Gutter Changes annotations when holding `alt`"
],
"markdownDescription": "Specifies the file annotation types to be toggled by the editor toolbar command and alternate command",
"scope": "window"
},
"gitlens.fileAnnotations.diffCommand": {
"type": "string",
"default": "blame",
"enum": [
"blame+heatmap",
"heatmap+blame"
],
"enumDescriptions": [
"Toggles Gutter Blame annotations, and toggles Gutter Heatmap annotations when holding `alt`",
"Toggles Gutter Heatmap annotations, and toggles Gutter Blame annotations when holding `alt`"
],
"markdownDescription": "Specifies the file annotation types to be toggled by the editor toolbar command and alternate command when in a diff editor",
"scope": "window"
},
"gitlens.gitCommands.closeOnFocusOut": {
"type": "boolean",
"default": true,
@ -861,6 +825,32 @@
"markdownDescription": "Specifies when to trigger hovers when showing blame annotations",
"scope": "window"
},
"gitlens.hovers.avatars": {
"type": "boolean",
"default": true,
"markdownDescription": "Specifies whether to show avatar images in hovers",
"scope": "window"
},
"gitlens.hovers.avatarSize": {
"type": "number",
"default": 32,
"markdownDescription": "Specifies the size of the avatar images in hovers",
"scope": "window"
},
"gitlens.hovers.changesDiff": {
"type": "string",
"default": "line",
"enum": [
"line",
"hunk"
],
"enumDescriptions": [
"Shows only the changes to the line",
"Shows the set of related changes"
],
"markdownDescription": "Specifies whether to show just the changes to the line or the set of related changes in the _changes (diff)_ hover",
"scope": "window"
},
"gitlens.hovers.currentLine.changes": {
"type": "boolean",
"default": true,
@ -893,32 +883,6 @@
"markdownDescription": "Specifies when to trigger hovers for the current line",
"scope": "window"
},
"gitlens.hovers.avatars": {
"type": "boolean",
"default": true,
"markdownDescription": "Specifies whether to show avatar images in hovers",
"scope": "window"
},
"gitlens.hovers.avatarSize": {
"type": "number",
"default": 32,
"markdownDescription": "Specifies the size of the avatar images in hovers",
"scope": "window"
},
"gitlens.hovers.changesDiff": {
"type": "string",
"default": "line",
"enum": [
"line",
"hunk"
],
"enumDescriptions": [
"Shows only the changes to the line",
"Shows the set of related changes"
],
"markdownDescription": "Specifies whether to show just the changes to the line or the set of related changes in the _changes (diff)_ hover",
"scope": "window"
},
"gitlens.hovers.detailsMarkdownFormat": {
"type": "string",
"default": "${avatar} &nbsp;__${author}__, ${ago}${' via 'pullRequest} &nbsp; _(${date})_ \n\n${message}\n\n${commands}",
@ -946,7 +910,7 @@
"gitlens.hovers.pullRequests.enabled": {
"type": "boolean",
"default": true,
"markdownDescription": "Specifies whether to provide information about the Pull Request (if any) that introduced a commit in the hovers. Requires a connection to a supported remote service (e.g. GitHub)",
"markdownDescription": "Specifies whether to provide information about the Pull Request (if any) that introduced the commit in the hovers. Requires a connection to a supported remote service (e.g. GitHub)",
"scope": "window"
},
"gitlens.insiders": {

+ 0
- 40
src/webviews/apps/settings/partials/menus.html View File

@ -230,46 +230,6 @@
<label for="menus.editorGroup.blame">Add <i>File Annotations</i> submenu</label>
</div>
</div>
<!-- <div class="settings ml-4">
<div class="setting" data-enablement="menus.editorGroup.blame">
<div class="setting__input">
<label for="fileAnnotations.command">File annotation command toggle</label>
<div class="select-container">
<select
id="fileAnnotations.command"
name="fileAnnotations.command"
data-setting
disabled
>
<option value="blame+heatmap">Blame, Heatmap (alt)</option>
<option value="blame+changes">Blame, Changes (alt)</option>
<option value="changes+blame">Changes, Blame (alt)</option>
<option value="changes+heatmap">Changes, Heatmap (alt)</option>
<option value="heatmap+blame">Heatmap, Blame (alt)</option>
<option value="heatmap+changes">Heatmap, Changes (alt)</option>
</select>
</div>
</div>
</div>
<div class="setting" data-enablement="menus.editorGroup.blame">
<div class="setting__input">
<label for="fileAnnotations.diffCommand">File (diff) annotation command toggle</label>
<div class="select-container">
<select
id="fileAnnotations.diffCommand"
name="fileAnnotations.diffCommand"
data-setting
disabled
>
<option value="blame+heatmap">Blame, Heatmap (alt)</option>
<option value="heatmap+blame">Heatmap, Blame (alt)</option>
</select>
</div>
</div>
</div>
</div> -->
</div>
<div class="setting setting--expandable" data-enablement="menus">

Loading…
Cancel
Save