From dbe3e64e83ff241ef2489294f607e40e27e65386 Mon Sep 17 00:00:00 2001 From: Eric Amodio Date: Wed, 23 Sep 2020 22:24:01 -0400 Subject: [PATCH] =?UTF-8?q?=F0=9F=92=84?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 36 ++++++++++++++++++------------------ 1 file changed, 18 insertions(+), 18 deletions(-) diff --git a/README.md b/README.md index d8b699a..b97271c 100644 --- a/README.md +++ b/README.md @@ -678,28 +678,28 @@ GitLens is highly customizable and provides many configuration settings to allow ### Git Code Lens Settings [#](#git-code-lens-settings- 'Git Code Lens Settings') -| Name | Description | -| ------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `gitlens.codeLens.authors.command` | Specifies the command to be executed when an _authors_ code lens is clicked, set to (`gitlens.toggleFileBlame`) by default. Can be set to `false` to disable click actions on the code lens.

`gitlens.toggleFileBlame` - toggles file blame annotations
`gitlens.diffWithPrevious` - opens changes with the previous revision
`gitlens.revealCommitInView` - reveals the commit in the Side Bar
`gitlens.showCommitsInView` - searches for commits within the range
`gitlens.showQuickCommitDetails` - shows details of the commit
`gitlens.showQuickCommitFileDetails` - show file details of the commit
`gitlens.showQuickFileHistory` - shows the current file history
`gitlens.showQuickRepoHistory` - shows the current branch history | -| `gitlens.codeLens.authors.enabled` | Specifies whether to provide an _authors_ code lens, showing number of authors of the file or code block and the most prominent author (if there is more than one) | -| `gitlens.codeLens.enabled` | Specifies whether to provide any Git code lens, by default. Use the _Toggle Git Code Lens_ command (`gitlens.toggleCodeLens`) to toggle the Git code lens on and off for the current window | -| `gitlens.codeLens.includeSingleLineSymbols` | Specifies whether to provide any Git code lens on symbols that span only a single line | -| `gitlens.codeLens.recentChange.command` | Specifies the command to be executed when a _recent change_ code lens is clicked, set to (`gitlens.showQuickCommitFileDetails`) by default. Can be set to `false` to disable click actions on the code lens.

`gitlens.toggleFileBlame` - toggles file blame annotations
`gitlens.diffWithPrevious` - opens changes with the previous revision
`gitlens.revealCommitInView` - reveals the commit in the Side Bar
`gitlens.showCommitsInView` - searches for the commit
`gitlens.showQuickCommitDetails` - shows details of the commit
`gitlens.showQuickCommitFileDetails` - show file details of the commit
`gitlens.showQuickFileHistory` - shows the current file history
`gitlens.showQuickRepoHistory` - shows the current branch history | -| `gitlens.codeLens.recentChange.enabled` | Specifies whether to provide a _recent change_ code lens, showing the author and date of the most recent commit for the file or code block | -| `gitlens.codeLens.scopes` | Specifies where Git code lens will be shown in the document

`document` - adds code lens at the top of the document
`containers` - adds code lens at the start of container-like symbols (modules, classes, interfaces, etc)
`blocks` - adds code lens at the start of block-like symbols (functions, methods, etc) lines | -| `gitlens.codeLens.scopesByLanguage` | Deprecated. Use per-language `gitlens.codeLens.scopes` and `gitlens.codeLens.symbolScopes` settings instead | -| `gitlens.codeLens.symbolScopes` | Specifies a set of document symbols where Git code lens will or will not be shown in the document. Prefix with `!` to avoid providing a Git code lens for the symbol. Must be a member of [`SymbolKind`](https://code.visualstudio.com/docs/extensionAPI/vscode-api#_a-namesymbolkindaspan-classcodeitem-id660symbolkindspan) | +| Name | Description | +| ------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `gitlens.codeLens.authors.command` | Specifies the command to be executed when an _authors_ code lens is clicked, set to (`gitlens.toggleFileBlame`) by default. Can be set to `false` to disable click actions on the code lens.

`gitlens.toggleFileBlame` - toggles file blame annotations
`gitlens.diffWithPrevious` - opens changes with the previous revision
`gitlens.revealCommitInView` - reveals the commit in the Side Bar
`gitlens.showCommitsInView` - searches for commits within the range
`gitlens.showQuickCommitDetails` - shows details of the commit
`gitlens.showQuickCommitFileDetails` - show file details of the commit
`gitlens.showQuickFileHistory` - shows the current file history
`gitlens.showQuickRepoHistory` - shows the current branch history | +| `gitlens.codeLens.authors.enabled` | Specifies whether to provide an _authors_ code lens, showing number of authors of the file or code block and the most prominent author (if there is more than one) | +| `gitlens.codeLens.enabled` | Specifies whether to provide any Git code lens, by default. Use the _Toggle Git Code Lens_ command (`gitlens.toggleCodeLens`) to toggle the Git code lens on and off for the current window | +| `gitlens.codeLens.includeSingleLineSymbols` | Specifies whether to provide any Git code lens on symbols that span only a single line | +| `gitlens.codeLens.recentChange.command` | Specifies the command to be executed when a _recent change_ code lens is clicked, set to (`gitlens.showQuickCommitFileDetails`) by default. Can be set to `false` to disable click actions on the code lens.

`gitlens.toggleFileBlame` - toggles file blame annotations
`gitlens.diffWithPrevious` - opens changes with the previous revision
`gitlens.revealCommitInView` - reveals the commit in the Side Bar
`gitlens.showCommitsInView` - searches for the commit
`gitlens.showQuickCommitDetails` - shows details of the commit
`gitlens.showQuickCommitFileDetails` - show file details of the commit
`gitlens.showQuickFileHistory` - shows the current file history
`gitlens.showQuickRepoHistory` - shows the current branch history | +| `gitlens.codeLens.recentChange.enabled` | Specifies whether to provide a _recent change_ code lens, showing the author and date of the most recent commit for the file or code block | +| `gitlens.codeLens.scopes` | Specifies where Git code lens will be shown in the document

`document` - adds code lens at the top of the document
`containers` - adds code lens at the start of container-like symbols (modules, classes, interfaces, etc)
`blocks` - adds code lens at the start of block-like symbols (functions, methods, etc) lines | +| `gitlens.codeLens.scopesByLanguage` | Deprecated. Use per-language `gitlens.codeLens.scopes` and `gitlens.codeLens.symbolScopes` settings instead | +| `gitlens.codeLens.symbolScopes` | Specifies a set of document symbols where Git code lens will or will not be shown in the document. Prefix with `!` to avoid providing a Git code lens for the symbol. Must be a member of [`SymbolKind`](https://code.visualstudio.com/docs/extensionAPI/vscode-api#_a-namesymbolkindaspan-classcodeitem-id660symbolkindspan) | ### Status Bar Settings [#](#status-bar-settings- 'Status Bar Settings') -| Name | Description | -| --------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `gitlens.statusBar.alignment` | Specifies the blame alignment in the status bar

`left` - aligns to the left
`right` - aligns to the right | +| Name | Description | +| --------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `gitlens.statusBar.alignment` | Specifies the blame alignment in the status bar

`left` - aligns to the left
`right` - aligns to the right | | `gitlens.statusBar.command` | Specifies the command to be executed when the blame status bar item is clicked

`gitlens.toggleFileBlame` - toggles file blame annotations
`gitlens.diffWithPrevious` - opens line changes with the previous revision
`gitlens.diffWithWorking` - opens line changes with the working file
`gitlens.revealCommitInView` - reveals the commit in the Side Bar
`gitlens.showCommitsInView` - searches for the commit
`gitlens.toggleCodeLens` - toggles the Git code lens
`gitlens.showQuickCommitDetails` - shows details of the commit
`gitlens.showQuickCommitFileDetails` - show file details of the commit
`gitlens.showQuickFileHistory` - shows the current file history
`gitlens.showQuickRepoHistory` - shows the current branch history | -| `gitlens.statusBar.dateFormat` | Specifies how to format absolute dates (e.g. using the `${date}` token) in the blame information in the status bar. See the [Moment.js docs](https://momentjs.com/docs/#/displaying/format/) for valid formats | -| `gitlens.statusBar.enabled` | Specifies whether to provide blame information in the status bar | -| `gitlens.statusBar.format` | Specifies the format of the blame information in the status bar. 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.statusBar.dateFormat` setting | -| `gitlens.statusBar.reduceFlicker` | Specifies whether to avoid clearing the previous blame information when changing lines to reduce status bar "flashing" | +| `gitlens.statusBar.dateFormat` | Specifies how to format absolute dates (e.g. using the `${date}` token) in the blame information in the status bar. See the [Moment.js docs](https://momentjs.com/docs/#/displaying/format/) for valid formats | +| `gitlens.statusBar.enabled` | Specifies whether to provide blame information in the status bar | +| `gitlens.statusBar.format` | Specifies the format of the blame information in the status bar. 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.statusBar.dateFormat` setting | +| `gitlens.statusBar.reduceFlicker` | Specifies whether to avoid clearing the previous blame information when changing lines to reduce status bar "flashing" | ### Hover Settings [#](#hover-settings- 'Hover Settings')