From fa04a75010bc0372ca2bd90c56714124b399e70e Mon Sep 17 00:00:00 2001 From: Eric Amodio Date: Thu, 22 Nov 2018 03:14:46 -0500 Subject: [PATCH] Fixes #533 - Updates setting descriptions to markdown --- README.md | 226 ++++++++++++++++++++++++++++----------------------------- package.json | 234 +++++++++++++++++++++++++++++------------------------------ 2 files changed, 230 insertions(+), 230 deletions(-) diff --git a/README.md b/README.md index e5dc87e..b0de955 100644 --- a/README.md +++ b/README.md @@ -647,66 +647,66 @@ GitLens is highly customizable and provides many configuration settings to allow ### General Settings [#](#general-settings 'General Settings') -| Name | Description | -| ----------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `gitlens.defaultDateFormat` | Specifies how absolute dates will be formatted by default
See https://momentjs.com/docs/#/displaying/format/ for valid formats | -| `gitlens.defaultDateStyle` | Specifies how dates will be displayed by default | -| `gitlens.defaultGravatarsStyle` | Specifies the style of the gravatar default (fallback) images
`identicon` - a geometric pattern
`mm` - a simple, cartoon-style silhouetted outline of a person (does not vary by email hash)
`monsterid` - a monster with different colors, faces, etc
`retro` - 8-bit arcade-style pixelated faces
`robohash` - a robot with different colors, faces, etc
`wavatar` - a face with differing features and backgrounds | -| `gitlens.insiders` | Specifies whether to enable experimental features | -| `gitlens.keymap` | Specifies the keymap to use for GitLens shortcut keys
`alternate` - adds an alternate set of shortcut keys that start with `Alt` (⌥ on macOS)
`chorded` - adds a chorded set of shortcut keys that start with `Ctrl+Shift+G` (⌥⌘G on macOS)
`none` - no shortcut keys will be added | -| `gitlens.menus` | Specifies which commands will be added to which menus | -| `gitlens.outputLevel` | Specifies how much (if any) output will be sent to the GitLens output channel | -| `gitlens.settings.mode` | Specifies the display mode of the interactive settings editor
`simple` - only displays common settings
`advanced` - displays all settings | -| `gitlens.showWhatsNewAfterUpgrades` | Specifies whether to show What's New after upgrading to new feature releases | +| Name | Description | +| ----------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `gitlens.defaultDateFormat` | Specifies how absolute dates will be formatted by default. See the [Moment.js docs](https://momentjs.com/docs/#/displaying/format/) for valid formats | +| `gitlens.defaultDateStyle` | Specifies how dates will be displayed by default | +| `gitlens.defaultGravatarsStyle` | Specifies the style of the gravatar default (fallback) images

`identicon` - a geometric pattern
`mm` - a simple, cartoon-style silhouetted outline of a person (does not vary by email hash)
`monsterid` - a monster with different colors, faces, etc
`retro` - 8-bit arcade-style pixelated faces
`robohash` - a robot with different colors, faces, etc
`wavatar` - a face with differing features and backgrounds | +| `gitlens.insiders` | Specifies whether to enable experimental features | +| `gitlens.keymap` | Specifies the keymap to use for GitLens shortcut keys

`alternate` - adds an alternate set of shortcut keys that start with `Alt` (⌥ on macOS)
`chorded` - adds a chorded set of shortcut keys that start with `Ctrl+Shift+G` (⌥⌘G on macOS)
`none` - no shortcut keys will be added | +| `gitlens.menus` | Specifies which commands will be added to which menus | +| `gitlens.outputLevel` | Specifies how much (if any) output will be sent to the GitLens output channel | +| `gitlens.settings.mode` | Specifies the display mode of the interactive settings editor

`simple` - only displays common settings
`advanced` - displays all settings | +| `gitlens.showWhatsNewAfterUpgrades` | Specifies whether to show What's New after upgrading to new feature releases | ### Repositories View Settings [#](#repositories-view-settings 'Repositories View Settings') See also [View Settings](#view-settings 'Jump to the View settings') -| Name | Description | -| ----------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `gitlens.views.repositories.autoRefresh` | Specifies whether to automatically refresh the _Repositories_ view when the repository or the file system changes | -| `gitlens.views.repositories.autoReveal` | Specifies whether to automatically reveal repositories in the _Repositories_ view when opening files | -| `gitlens.views.repositories.branches.layout` | Specifies how the _Repositories_ view will display branches
`list` - displays branches as a list
`tree` - displays branches as a tree when branch names contain slashes `/` | -| `gitlens.views.repositories.enabled` | Specifies whether to show the _Repositories_ view | -| `gitlens.views.repositories.files.compact` | Specifies whether to compact (flatten) unnecessary file nesting in the _Repositories_ view
Only applies when `gitlens.views.repositories.files.layout` is set to `tree` or `auto` | -| `gitlens.views.repositories.files.layout` | Specifies how the _Repositories_ view will display files
`auto` - automatically switches between displaying files as a `tree` or `list` based on the `gitlens.views.repositories.files.threshold` value and the number of files at each nesting level
`list` - displays files as a list
`tree` - displays files as a tree | -| `gitlens.views.repositories.files.threshold` | Specifies when to switch between displaying files as a `tree` or `list` based on the number of files in a nesting level in the _Repositories_ view
Only applies when `gitlens.views.repositories.files.layout` is set to `auto` | -| `gitlens.views.repositories.includeWorkingTree` | Specifies whether to include working tree files inside the `Repository Status` node of the _Repositories_ view | -| `gitlens.views.repositories.location` | Specifies where to show the _Repositories_ view
`gitlens` - adds to the GitLens side bar
`explorer` - adds to the Explorer side bar
`scm` - adds to the Source Control side bar | -| `gitlens.views.repositories.showTrackingBranch` | Specifies whether to show the tracking branch when displaying local branches in the _Repositories_ view | +| Name | Description | +| ----------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `gitlens.views.repositories.autoRefresh` | Specifies whether to automatically refresh the _Repositories_ view when the repository or the file system changes | +| `gitlens.views.repositories.autoReveal` | Specifies whether to automatically reveal repositories in the _Repositories_ view when opening files | +| `gitlens.views.repositories.branches.layout` | Specifies how the _Repositories_ view will display branches

`list` - displays branches as a list
`tree` - displays branches as a tree when branch names contain slashes `/` | +| `gitlens.views.repositories.enabled` | Specifies whether to show the _Repositories_ view | +| `gitlens.views.repositories.files.compact` | Specifies whether to compact (flatten) unnecessary file nesting in the _Repositories_ view. Only applies when `gitlens.views.repositories.files.layout` is set to `tree` or `auto` | +| `gitlens.views.repositories.files.layout` | Specifies how the _Repositories_ view will display files

`auto` - automatically switches between displaying files as a `tree` or `list` based on the `gitlens.views.repositories.files.threshold` value and the number of files at each nesting level
`list` - displays files as a list
`tree` - displays files as a tree | +| `gitlens.views.repositories.files.threshold` | Specifies when to switch between displaying files as a `tree` or `list` based on the number of files in a nesting level in the _Repositories_ view. Only applies when `gitlens.views.repositories.files.layout` is set to `auto` | +| `gitlens.views.repositories.includeWorkingTree` | Specifies whether to include working tree file status for each repository in the _Repositories_ view | +| `gitlens.views.repositories.location` | Specifies where to show the _Repositories_ view

`gitlens` - adds to the GitLens side bar
`explorer` - adds to the Explorer side bar
`scm` - adds to the Source Control side bar | +| `gitlens.views.repositories.showTrackingBranch` | Specifies whether to show the tracking branch when displaying local branches in the _Repositories_ view | ### File History View Settings [#](#file-history-view-settings 'File History View Settings') See also [View Settings](#view-settings 'Jump to the View settings') -| Name | Description | -| ------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `gitlens.views.fileHistory.avatars` | Specifies whether to show avatar images instead of status icons in the _File History_ view | -| `gitlens.views.fileHistory.enabled` | Specifies whether to show the _File History_ view | -| `gitlens.views.fileHistory.location` | Specifies where to show the _File History_ view
`gitlens` - adds to the GitLens side bar
`explorer` - adds to the Explorer side bar
`scm` - adds to the Source Control side bar | +| Name | Description | +| ------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `gitlens.views.fileHistory.avatars` | Specifies whether to show avatar images instead of status icons in the _File History_ view | +| `gitlens.views.fileHistory.enabled` | Specifies whether to show the _File History_ view | +| `gitlens.views.fileHistory.location` | Specifies where to show the _File History_ view

`gitlens` - adds to the GitLens side bar
`explorer` - adds to the Explorer side bar
`scm` - adds to the Source Control side bar | ### Line History View Settings [#](#line-history-view-settings 'Line History View Settings') See also [View Settings](#view-settings 'Jump to the View settings') -| Name | Description | -| ------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `gitlens.views.lineHistory.avatars` | Specifies whether to show avatar images instead of status icons in the _Line History_ view | -| `gitlens.views.lineHistory.enabled` | Specifies whether to show the _Line History_ view | -| `gitlens.views.lineHistory.location` | Specifies where to show the _Line History_ view
`gitlens` - adds to the GitLens side bar
`explorer` - adds to the Explorer side bar
`scm` - adds to the Source Control side bar | +| Name | Description | +| ------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `gitlens.views.lineHistory.avatars` | Specifies whether to show avatar images instead of status icons in the _Line History_ view | +| `gitlens.views.lineHistory.enabled` | Specifies whether to show the _Line History_ view | +| `gitlens.views.lineHistory.location` | Specifies where to show the _Line History_ view

`gitlens` - adds to the GitLens side bar
`explorer` - adds to the Explorer side bar
`scm` - adds to the Source Control side bar | ### Compare View Settings [#](#compare-view-settings 'Compare View Settings') See also [View Settings](#view-settings 'Jump to the View settings') -| Name | Description | -| --------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `gitlens.views.compare.files.compact` | Specifies whether to compact (flatten) unnecessary file nesting in the _Compare_ view
Only applies when `gitlens.views.compare.files.layout` is set to `tree` or `auto` | -| `gitlens.views.compare.enabled` | Specifies whether to show the _Compare_ view | -| `gitlens.views.compare.files.layout` | Specifies how the _Compare_ view will display files
`auto` - automatically switches between displaying files as a `tree` or `list` based on the `gitlens.views.compare.files.threshold` value and the number of files at each nesting level
`list` - displays files as a list
`tree` - displays files as a tree | -| `gitlens.views.compare.files.threshold` | Specifies when to switch between displaying files as a `tree` or `list` based on the number of files in a nesting level in the _Compare_ view
Only applies when `gitlens.views.compare.files.layout` is set to `auto` | -| `gitlens.views.compare.location` | Specifies where to show the _Compare_ view
`gitlens` - adds to the GitLens side bar
`explorer` - adds to the Explorer side bar
`scm` - adds to the Source Control side bar | +| Name | Description | +| --------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `gitlens.views.compare.files.compact` | Specifies whether to compact (flatten) unnecessary file nesting in the _Compare_ view. Only applies when `gitlens.views.compare.files.layout` is set to `tree` or `auto` | +| `gitlens.views.compare.enabled` | Specifies whether to show the _Compare_ view | +| `gitlens.views.compare.files.layout` | Specifies how the _Compare_ view will display files

`auto` - automatically switches between displaying files as a `tree` or `list` based on the `gitlens.views.compare.files.threshold` value and the number of files at each nesting level
`list` - displays files as a list
`tree` - displays files as a tree | +| `gitlens.views.compare.files.threshold` | Specifies when to switch between displaying files as a `tree` or `list` based on the number of files in a nesting level in the _Compare_ view. Only applies when `gitlens.views.compare.files.layout` is set to `auto` | +| `gitlens.views.compare.location` | Specifies where to show the _Compare_ view

`gitlens` - adds to the GitLens side bar
`explorer` - adds to the Explorer side bar
`scm` - adds to the Source Control side bar | ### Search View Settings [#](#search-view-settings 'Search View Settings') @@ -722,54 +722,54 @@ See also [View Settings](#view-settings 'Jump to the View settings') ### View Settings [#](#view-settings 'View Settings') -| Name | Description | -| -------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `gitlens.views.avatars` | Specifies whether to show avatar images instead of commit (or status) icons in the views | -| `gitlens.views.commitFileFormat` | Specifies the format of a committed file in the views
Available tokens
${directory} - directory name
${file} - file name
${filePath} - formatted file name and path
${path} - full file path | -| `gitlens.views.commitFormat` | Specifies the format of committed changes in the views
Available tokens
${id} - commit id
${author} - commit author
${message} - commit message
${ago} - relative commit date (e.g. 1 day ago)
\${date} - formatted commit date (format specified by `gitlens.statusBar.dateFormat`)
\${agoOrDate} - commit date specified by `gitlens.defaultDateStyle`
${authorAgo} - commit author, relative commit date
${authorAgoOrDate} - commit author, commit date specified by `gitlens.defaultDateStyle`
See https://github.com/eamodio/vscode-gitlens/wiki/Advanced-Formatting for advanced formatting | -| `gitlens.views.defaultItemLimit` | Specifies the default number of items to show in a view list. Use 0 to specify no limit | -| `gitlens.views.stashFileFormat` | Specifies the format of a stashed file in the views
Available tokens
${directory} - directory name
${file} - file name
${filePath} - formatted file name and path
${path} - full file path | -| `gitlens.views.stashFormat` | Specifies the format of stashed changes in the views
Available tokens
${id} - commit id
${author} - commit author
${message} - commit message
${ago} - relative commit date (e.g. 1 day ago)
\${date} - formatted commit date (format specified by `gitlens.statusBar.dateFormat`)
\${agoOrDate} - commit date specified by `gitlens.defaultDateStyle`
${authorAgo} - commit author, relative commit date
${authorAgoOrDate} - commit author, commit date specified by `gitlens.defaultDateStyle`
See https://github.com/eamodio/vscode-gitlens/wiki/Advanced-Formatting for advanced formatting | -| `gitlens.views.statusFileFormat` | Specifies the format of the status of a working or committed file in the views
Available tokens
${directory} - directory name
${file} - file name
${filePath} - formatted file name and path
${path} - full file path
\${working} - optional indicator if the file is uncommitted | +| Name | Description | +| -------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `gitlens.views.avatars` | Specifies whether to show avatar images instead of commit (or status) icons in the views | +| `gitlens.views.commitFileFormat` | Specifies the format of a committed file in the views

Available tokens
`${directory}` — directory name
`${file}` — file name
`${filePath}` — formatted file name and path
`${path}` — full file path | +| `gitlens.views.commitFormat` | Specifies the format of committed changes in the views. See the [GitLens docs](https://github.com/eamodio/vscode-gitlens/wiki/Advanced-Formatting) for advanced formatting

Available tokens
`${id}`— commit id
`${author}` — commit author
`${message}`— commit message
`${ago}` — relative commit date (e.g. 1 day ago)
`${date}`— formatted commit date (format specified by`gitlens.statusBar.dateFormat`)
`${agoOrDate}` — commit date specified by `gitlens.defaultDateStyle`
`${authorAgo}`— commit author, relative commit date
`${authorAgoOrDate}` — commit author, commit date specified by `gitlens.defaultDateStyle` | +| `gitlens.views.defaultItemLimit` | Specifies the default number of items to show in a view list. Use 0 to specify no limit | +| `gitlens.views.stashFileFormat` | Specifies the format of a stashed file in the views

Available tokens
`${directory}` — directory name
`${file}` — file name
`${filePath}` — formatted file name and path
`${path}` — full file path | +| `gitlens.views.stashFormat` | Specifies the format of stashed changes in the views. See the [GitLens docs](https://github.com/eamodio/vscode-gitlens/wiki/Advanced-Formatting) for advanced formatting

Available tokens
`${id}` — commit id
`${author}` — commit author
`${message}` — commit message
`${ago}` — relative commit date (e.g. 1 day ago)
`${date}`— formatted commit date (format specified by `gitlens.statusBar.dateFormat`)
`${agoOrDate}` — commit date specified by `gitlens.defaultDateStyle`
`${authorAgo}` — commit author, relative commit date
`${authorAgoOrDate}` — commit author, commit date specified by `gitlens.defaultDateStyle` | +| `gitlens.views.statusFileFormat` | Specifies the format of the status of a working or committed file in the views

Available tokens
`${directory}` — directory name
`${file}` — file name
`${filePath}` — formatted file name and path
`${path}` — full file path
`${working}` — optional indicator if the file is uncommitted | ### Code Lens Settings [#](#code-lens-settings 'Code Lens Settings') -| Name | Description | -| ------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `gitlens.codeLens.authors.command` | Specifies the command to be executed when the `authors` code lens is clicked
`gitlens.toggleFileBlame` - toggles file blame annotations
`gitlens.diffWithPrevious` - compares the current committed file with the previous commit
`gitlens.showQuickCommitDetails` - shows a commit details quick pick
`gitlens.showQuickCommitFileDetails` - shows a commit file details quick pick
`gitlens.showQuickFileHistory` - shows a file history quick pick
`gitlens.showQuickRepoHistory` - shows a branch history quick pick | -| `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 the `recent change` code lens is clicked
`gitlens.toggleFileBlame` - toggles file blame annotations
`gitlens.diffWithPrevious` - compares the current committed file with the previous commit
`gitlens.showQuickCommitDetails` - shows a commit details quick pick
`gitlens.showQuickCommitFileDetails` - shows a commit file details quick pick
`gitlens.showQuickFileHistory` - shows a file history quick pick
`gitlens.showQuickRepoHistory` - shows a branch history quick pick | -| `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` | Specifies where Git code lens will be shown in the document for the specified languages | -| `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

`gitlens.toggleFileBlame` - toggles file blame annotations
`gitlens.diffWithPrevious` - compares the current committed file with the previous commit
`gitlens.showQuickCommitDetails` - shows a commit details quick pick
`gitlens.showQuickCommitFileDetails` - shows a commit file details quick pick
`gitlens.showQuickFileHistory` - shows a file history quick pick
`gitlens.showQuickRepoHistory` - shows a branch history quick pick | +| `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

`gitlens.toggleFileBlame` - toggles file blame annotations
`gitlens.diffWithPrevious` - compares the current committed file with the previous commit
`gitlens.showQuickCommitDetails` - shows a commit details quick pick
`gitlens.showQuickCommitFileDetails` - shows a commit file details quick pick
`gitlens.showQuickFileHistory` - shows a file history quick pick
`gitlens.showQuickRepoHistory` - shows a branch history quick pick | +| `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` | Specifies where Git code lens will be shown in the document for the specified languages | +| `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) | #### Current Line Blame Settings [#](#current-line-blame-settings 'Current Line Blame Settings') -| Name | Description | -| -------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `gitlens.currentLine.dateFormat` | Specifies how to format absolute dates (using the `${date}` token) for the current line blame annotations
See 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
Available tokens
`${id}` - commit id
`${author}` - commit author
`${message}` - commit message
`${ago}` - relative commit date (e.g. 1 day ago)
`${date}` - formatted commit date (format specified by `gitlens.currentLine.dateFormat`)
`${agoOrDate}` - commit date specified by `gitlens.defaultDateStyle`
`${authorAgo}` - commit author, relative commit date
`${authorAgoOrDate}` - commit author, commit date specified by `gitlens.defaultDateStyle`
See https://github.com/eamodio/vscode-gitlens/wiki/Advanced-Formatting for advanced formatting | -| `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 (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 the [GitLens docs](https://github.com/eamodio/vscode-gitlens/wiki/Advanced-Formatting) for advanced formatting

Available tokens
`${id}` — commit id
`${author}` — commit author
`${message}` — commit message
`${ago}` — relative commit date (e.g. 1 day ago)
`${date}` — formatted commit date (format specified by `gitlens.currentLine.dateFormat`)
`${agoOrDate}` — commit date specified by `gitlens.defaultDateStyle`
`${authorAgo}` — commit author, relative commit date
`${authorAgoOrDate}` — commit author, commit date specified by `gitlens.defaultDateStyle` | +| `gitlens.currentLine.scrollable` | Specifies whether the current line blame annotation can be scrolled into view when it is outside the viewport | ### Gutter Blame Settings [#](#gutter-blame-settings 'Gutter Blame Settings') -| Name | Description | -| ----------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `gitlens.blame.avatars` | Specifies whether to show avatar images in the gutter blame annotations | -| `gitlens.blame.compact` | Specifies whether to compact (deduplicate) matching adjacent gutter blame annotations | -| `gitlens.blame.dateFormat` | Specifies how to format absolute dates (using the `${date}` token) in gutter blame annotations
See https://momentjs.com/docs/#/displaying/format/ for valid formats | -| `gitlens.blame.format` | Specifies the format of the gutter blame annotations
Available tokens
`${id}` - commit id
`${author}` - commit author
`${message}` - commit message
`${ago}` - relative commit date (e.g. 1 day ago)
`${date}` - formatted commit date (format specified by `gitlens.blame.dateFormat`)
`${agoOrDate}` - commit date specified by `gitlens.defaultDateStyle`
`${authorAgo}` - commit author, relative commit date
`${authorAgoOrDate}` - commit author, commit date specified by `gitlens.defaultDateStyle`
See https://github.com/eamodio/vscode-gitlens/wiki/Advanced-Formatting for advanced formatting | -| `gitlens.blame.heatmap.enabled` | Specifies whether to provide a heatmap indicator in the gutter blame annotations | -| `gitlens.blame.heatmap.location` | Specifies where the heatmap indicators will be shown in the gutter blame annotations
`left` - adds a heatmap indicator on the left edge of the gutter blame annotations
`right` - adds a heatmap indicator on the right edge of the gutter blame annotations | -| `gitlens.blame.highlight.enabled` | Specifies whether to highlight lines associated with the current line | -| `gitlens.blame.highlight.locations` | Specifies where the associated line highlights will be shown
`gutter` - adds a gutter glyph
`line` - adds a full-line highlight background color
`overview` - adds a decoration to the overview ruler (scroll bar) | -| `gitlens.blame.ignoreWhitespace` | Specifies whether to ignore whitespace when comparing revisions during blame operations | -| `gitlens.blame.separateLines` | Specifies whether gutter blame annotations will have line separators | -| `gitlens.blame.toggleMode` | Specifies how the gutter blame annotations will be toggled
`file` - toggles each file individually
`window` - toggles the window, i.e. all files at once | +| Name | Description | +| ----------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `gitlens.blame.avatars` | Specifies whether to show avatar images in the gutter blame annotations | +| `gitlens.blame.compact` | Specifies whether to compact (deduplicate) matching adjacent gutter blame annotations | +| `gitlens.blame.dateFormat` | Specifies how to format absolute dates (using the `${date}` token) in gutter blame annotations. See the [Moment.js docs](https://momentjs.com/docs/#/displaying/format/) for valid formats | +| `gitlens.blame.format` | Specifies the format of the gutter blame annotations. See the [GitLens docs](https://github.com/eamodio/vscode-gitlens/wiki/Advanced-Formatting) for advanced formatting

Available tokens
`${id}` — commit id
`${author}` — commit author
`${message}` — commit message
`${ago}` — relative commit date (e.g. 1 day ago)
`${date}` — formatted commit date (format specified by `gitlens.blame.dateFormat`)
`${agoOrDate}` — commit date specified by `gitlens.defaultDateStyle`
`${authorAgo}` — commit author, relative commit date
`${authorAgoOrDate}` — commit author, commit date specified by `gitlens.defaultDateStyle` | +| `gitlens.blame.heatmap.enabled` | Specifies whether to provide a heatmap indicator in the gutter blame annotations | +| `gitlens.blame.heatmap.location` | Specifies where the heatmap indicators will be shown in the gutter blame annotations

`left` - adds a heatmap indicator on the left edge of the gutter blame annotations
`right` - adds a heatmap indicator on the right edge of the gutter blame annotations | +| `gitlens.blame.highlight.enabled` | Specifies whether to highlight lines associated with the current line | +| `gitlens.blame.highlight.locations` | Specifies where the associated line highlights will be shown

`gutter` - adds a gutter glyph
`line` - adds a full-line highlight background color
`overview` - adds a decoration to the overview ruler (scroll bar) | +| `gitlens.blame.ignoreWhitespace` | Specifies whether to ignore whitespace when comparing revisions during blame operations | +| `gitlens.blame.separateLines` | Specifies whether gutter blame annotations will have line separators | +| `gitlens.blame.toggleMode` | Specifies how the gutter blame annotations will be toggled

`file` - toggles each file individually
`window` - toggles the window, i.e. all files at once | ### Gutter Heatmap Settings [#](#gutter-heatmap-settings 'Gutter Heatmap Settings') @@ -778,49 +778,49 @@ See also [View Settings](#view-settings 'Jump to the View settings') | `gitlens.heatmap.ageThreshold` | Specifies the age of the most recent change (in days) after which the gutter heatmap annotations will be cold rather than hot (i.e. will use `gitlens.heatmap.coldColor` instead of `gitlens.heatmap.hotColor`) | | `gitlens.heatmap.coldColor` | Specifies the base color of the gutter heatmap annotations when the most recent change is older (cold) than the `gitlens.heatmap.ageThreshold` value | | `gitlens.heatmap.hotColor` | Specifies the base color of the gutter heatmap annotations when the most recent change is newer (hot) than the `gitlens.heatmap.ageThreshold` value | -| `gitlens.heatmap.toggleMode` | Specifies how the gutter heatmap annotations will be toggled
`file` - toggles each file individually
`window` - toggles the window, i.e. all files at once | +| `gitlens.heatmap.toggleMode` | Specifies how the gutter heatmap annotations will be toggled

`file` - toggles each file individually
`window` - toggles the window, i.e. all files at once | ### Hover Settings [#](#hover-settings 'Hover Settings') -| Name | Description | -| ------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `gitlens.hovers.annotations.changes` | Specifies whether to provide a changes (diff) hover for all lines when showing blame annotations | -| `gitlens.hovers.annotations.details` | Specifies whether to provide a commit details hover for all lines when showing blame annotations | -| `gitlens.hovers.annotations.enabled` | Specifies whether to provide any hovers when showing blame annotations | -| `gitlens.hovers.annotations.over` | Specifies when to trigger hovers when showing blame annotations
`annotation` - only shown when hovering over the line annotation
`line` - shown when hovering anywhere over the line | -| `gitlens.hovers.avatars` | Specifies whether to show avatar images in hovers | -| `gitlens.hovers.currentLine.changes` | Specifies whether to provide a changes (diff) hover for the current line | -| `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
`annotation` - only shown when hovering over the line annotation
`line` - shown when hovering anywhere over the line | -| `gitlens.hovers.enabled` | Specifies whether to provide any hovers | +| Name | Description | +| ------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `gitlens.hovers.annotations.changes` | Specifies whether to provide a _changes (diff)_ hover for all lines when showing blame annotations | +| `gitlens.hovers.annotations.details` | Specifies whether to provide a _commit details_ hover for all lines when showing blame annotations | +| `gitlens.hovers.annotations.enabled` | Specifies whether to provide any hovers when showing blame annotations | +| `gitlens.hovers.annotations.over` | Specifies when to trigger hovers when showing blame annotations

`annotation` - only shown when hovering over the line annotation
`line` - shown when hovering anywhere over the line | +| `gitlens.hovers.avatars` | Specifies whether to show avatar images in hovers | +| `gitlens.hovers.currentLine.changes` | Specifies whether to provide a _changes (diff)_ hover for the current line | +| `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

`annotation` - only shown when hovering over the line annotation
`line` - shown when hovering anywhere over the line | +| `gitlens.hovers.enabled` | Specifies whether to provide any hovers | ### Modes Settings [#](#modes-settings 'Modes Settings') -| Name | Description | -| ---------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| `gitlens.mode.active` | Specifies the active GitLens mode, if any | -| `gitlens.mode.statusBar.enabled` | Specifies whether to provide the active GitLens mode in the status bar | -| `gitlens.mode.statusBar.alignment` | Specifies the active GitLens mode alignment in the status bar
`left` - aligns to the left
`right` - aligns to the right | -| `gitlens.modes` | Specifies the user-defined GitLens modes | +| Name | Description | +| ---------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- | +| `gitlens.mode.active` | Specifies the active GitLens mode, if any | +| `gitlens.mode.statusBar.enabled` | Specifies whether to provide the active GitLens mode in the status bar | +| `gitlens.mode.statusBar.alignment` | Specifies the active GitLens mode alignment in the status bar

`left` - aligns to the left
`right` - aligns to the right | +| `gitlens.modes` | Specifies the user-defined GitLens modes | ### Recent Changes Settings [#](#recent-changes-settings 'Recent Changes Settings') -| Name | Description | -| ------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `gitlens.recentChanges.highlight.locations` | Specifies where the highlights of the recently changed lines will be shown
`gutter` - adds a gutter glyph
`line` - adds a full-line highlight background color
`overview` - adds a decoration to the overview ruler (scroll bar) | -| `gitlens.recentChanges.toggleMode` | Specifies how the recently changed lines annotations will be toggled
`file` - toggles each file individually
`window` - toggles the window, i.e. all files at once | +| Name | Description | +| ------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `gitlens.recentChanges.highlight.locations` | Specifies where the highlights of the recently changed lines will be shown

`gutter` - adds a gutter glyph
`line` - adds a full-line highlight background color
`overview` - adds a decoration to the overview ruler (scroll bar) | +| `gitlens.recentChanges.toggleMode` | Specifies how the recently changed lines annotations will be toggled

`file` - toggles each file individually
`window` - toggles the window, i.e. all files at once | ### 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 | -| `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` - compares the current line commit with the previous
`gitlens.diffWithWorking` - compares the current line commit with the working tree
`gitlens.toggleCodeLens` - toggles Git code lens
`gitlens.showQuickCommitDetails` - shows a commit details quick pick
`gitlens.showQuickCommitFileDetails` - shows a commit file details quick pick
`gitlens.showQuickFileHistory` - shows a file history quick pick
`gitlens.showQuickRepoHistory` - shows a branch history quick pick | -| `gitlens.statusBar.dateFormat` | Specifies the date format of absolute dates shown in the blame information in the status bar
See 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
Available tokens
`${id}` - commit id
`${author}` - commit author
`${message}` - commit message
`${ago}` - relative commit date (e.g. 1 day ago)
`${date}` - formatted commit date (format specified by `gitlens.statusBar.dateFormat`)
`${agoOrDate}` - commit date specified by `gitlens.defaultDateStyle`
`${authorAgo}` - commit author, relative commit date
`${authorAgoOrDate}` - commit author, commit date specified by `gitlens.defaultDateStyle`
See https://github.com/eamodio/vscode-gitlens/wiki/Advanced-Formatting for advanced formatting | -| `gitlens.statusBar.reduceFlicker` | Specifies whether to avoid clearing the previous blame information when changing lines to reduce status bar "flashing" | +| 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` - compares the current line commit with the previous
`gitlens.diffWithWorking` - compares the current line commit with the working tree
`gitlens.toggleCodeLens` - toggles Git code lens
`gitlens.showQuickCommitDetails` - shows a commit details quick pick
`gitlens.showQuickCommitFileDetails` - shows a commit file details quick pick
`gitlens.showQuickFileHistory` - shows a file history quick pick
`gitlens.showQuickRepoHistory` - shows a branch history quick pick | +| `gitlens.statusBar.dateFormat` | Specifies the date format of absolute dates shown 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 the [GitLens docs](https://github.com/eamodio/vscode-gitlens/wiki/Advanced-Formatting) for advanced formatting

Available tokens
`${id}` — commit id
`${author}` — commit author
`${message}` — commit message
`${ago}` — relative commit date (e.g. 1 day ago)
`${date}` — formatted commit date (format specified by `gitlens.statusBar.dateFormat`)
`${agoOrDate}` — commit date specified by `gitlens.defaultDateStyle`
`${authorAgo}` — commit author, relative commit date
`${authorAgoOrDate}` — commit author, commit date specified by `gitlens.defaultDateStyle` | +| `gitlens.statusBar.reduceFlicker` | Specifies whether to avoid clearing the previous blame information when changing lines to reduce status bar "flashing" | ### Advanced Settings [#](#advanced-settings 'Advanced Settings') @@ -847,9 +847,9 @@ See also [View Settings](#view-settings 'Jump to the View settings') | Name | Description | | ---------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | -| `gitlens.strings.codeLens.unsavedChanges.recentChangeAndAuthors` | Specifies the string to be shown in place of both the `recent change` and `authors` code lens when there are unsaved changes | -| `gitlens.strings.codeLens.unsavedChanges.recentChangeOnly` | Specifies the string to be shown in place of the `recent change` code lens when there are unsaved changes | -| `gitlens.strings.codeLens.unsavedChanges.authorsOnly` | Specifies the string to be shown in place of the `authors` code lens when there are unsaved changes | +| `gitlens.strings.codeLens.unsavedChanges.recentChangeAndAuthors` | Specifies the string to be shown in place of both the _recent change_ and _authors_ code lens when there are unsaved changes | +| `gitlens.strings.codeLens.unsavedChanges.recentChangeOnly` | Specifies the string to be shown in place of the _recent change_ code lens when there are unsaved changes | +| `gitlens.strings.codeLens.unsavedChanges.authorsOnly` | Specifies the string to be shown in place of the _authors_ code lens when there are unsaved changes | --- diff --git a/package.json b/package.json index a98c6eb..44b04fc 100644 --- a/package.json +++ b/package.json @@ -56,31 +56,31 @@ "gitlens.blame.avatars": { "type": "boolean", "default": true, - "description": "Specifies whether to show avatar images in the gutter blame annotations", + "markdownDescription": "Specifies whether to show avatar images in the gutter blame annotations", "scope": "window" }, "gitlens.blame.compact": { "type": "boolean", "default": true, - "description": "Specifies whether to compact (deduplicate) matching adjacent gutter blame annotations", + "markdownDescription": "Specifies whether to compact (deduplicate) matching adjacent gutter blame annotations", "scope": "window" }, "gitlens.blame.dateFormat": { "type": "string", "default": null, - "description": "Specifies how to format absolute dates (using the `${date}` token) in gutter blame annotations\nSee https://momentjs.com/docs/#/displaying/format/ for valid formats", + "markdownDescription": "Specifies how to format absolute dates (using the `${date}` token) in gutter blame annotations. See the [Moment.js docs](https://momentjs.com/docs/#/displaying/format/) for valid formats", "scope": "window" }, "gitlens.blame.format": { "type": "string", "default": "${message|40?} ${agoOrDate|14-}", - "description": "Specifies the format of the gutter blame annotations\nAvailable tokens\n ${id} - commit id\n ${author} - commit author\n ${message} - commit message\n ${ago} - relative commit date (e.g. 1 day ago)\n ${date} - formatted commit date (format specified by `gitlens.blame.dateFormat`)\n ${agoOrDate} - commit date specified by `gitlens.defaultDateStyle`\n ${authorAgo} - commit author, relative commit date\n ${authorAgoOrDate} - commit author, commit date specified by `gitlens.defaultDateStyle`\nSee https://github.com/eamodio/vscode-gitlens/wiki/Advanced-Formatting for advanced formatting", + "markdownDescription": "Specifies the format of the gutter blame annotations. See the [GitLens docs](https://github.com/eamodio/vscode-gitlens/wiki/Advanced-Formatting) for advanced formatting\n- Available tokens\n - `${id}` — commit id\n - `${author}` — commit author\n - `${message}` — commit message\n - `${ago}` — relative commit date (e.g. 1 day ago)\n - `${date}` — formatted commit date (format specified by `#gitlens.blame.dateFormat#`)\n - `${agoOrDate}` — commit date specified by `#gitlens.defaultDateStyle#`\n - `${authorAgo}` — commit author, relative commit date\n - `${authorAgoOrDate}` — commit author, commit date specified by `#gitlens.defaultDateStyle#`", "scope": "window" }, "gitlens.blame.heatmap.enabled": { "type": "boolean", "default": true, - "description": "Specifies whether to provide a heatmap indicator in the gutter blame annotations", + "markdownDescription": "Specifies whether to provide a heatmap indicator in the gutter blame annotations", "scope": "window" }, "gitlens.blame.heatmap.location": { @@ -94,13 +94,13 @@ "Adds a heatmap indicator on the left edge of the gutter blame annotations", "Adds a heatmap indicator on the right edge of the gutter blame annotations" ], - "description": "Specifies where the heatmap indicators will be shown in the gutter blame annotations", + "markdownDescription": "Specifies where the heatmap indicators will be shown in the gutter blame annotations", "scope": "window" }, "gitlens.blame.highlight.enabled": { "type": "boolean", "default": true, - "description": "Specifies whether to highlight lines associated with the current line", + "markdownDescription": "Specifies whether to highlight lines associated with the current line", "scope": "window" }, "gitlens.blame.highlight.locations": { @@ -126,19 +126,19 @@ "minItems": 1, "maxItems": 3, "uniqueItems": true, - "description": "Specifies where the associated line highlights will be shown", + "markdownDescription": "Specifies where the associated line highlights will be shown", "scope": "window" }, "gitlens.blame.ignoreWhitespace": { "type": "boolean", "default": false, - "description": "Specifies whether to ignore whitespace when comparing revisions during blame operations", + "markdownDescription": "Specifies whether to ignore whitespace when comparing revisions during blame operations", "scope": "resource" }, "gitlens.blame.separateLines": { "type": "boolean", "default": true, - "description": "Specifies whether gutter blame annotations will be separated by a small gap", + "markdownDescription": "Specifies whether gutter blame annotations will be separated by a small gap", "scope": "window" }, "gitlens.blame.toggleMode": { @@ -152,7 +152,7 @@ "Toggles each file individually", "Toggles the window, i.e. all files at once" ], - "description": "Specifies how the gutter blame annotations will be toggled", + "markdownDescription": "Specifies how the gutter blame annotations will be toggled", "scope": "window" }, "gitlens.codeLens.authors.command": { @@ -174,25 +174,25 @@ "Shows a file history quick pick", "Shows a branch history quick pick" ], - "description": "Specifies the command to be executed when the `authors` code lens is clicked", + "markdownDescription": "Specifies the command to be executed when an _authors_ code lens is clicked", "scope": "window" }, "gitlens.codeLens.authors.enabled": { "type": "boolean", "default": true, - "description": "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)", + "markdownDescription": "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)", "scope": "window" }, "gitlens.codeLens.enabled": { "type": "boolean", "default": true, - "description": "Specifies whether to provide any Git code lens, by default\nUse the `Toggle Git Code Lens` command (`gitlens.toggleCodeLens`) to toggle the Git code lens on and off for the current window", + "markdownDescription": "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", "scope": "window" }, "gitlens.codeLens.includeSingleLineSymbols": { "type": "boolean", "default": false, - "description": "Specifies whether to provide any Git code lens on symbols that span only a single line", + "markdownDescription": "Specifies whether to provide any Git code lens on symbols that span only a single line", "scope": "window" }, "gitlens.codeLens.recentChange.command": { @@ -214,13 +214,13 @@ "Shows a file history quick pick", "Shows a branch history quick pick" ], - "description": "Specifies the command to be executed when the `recent change` code lens is clicked", + "markdownDescription": "Specifies the command to be executed when a _recent change_ code lens is clicked", "scope": "window" }, "gitlens.codeLens.recentChange.enabled": { "type": "boolean", "default": true, - "description": "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", + "markdownDescription": "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", "scope": "window" }, "gitlens.codeLens.scopes": { @@ -245,7 +245,7 @@ "minItems": 1, "maxItems": 4, "uniqueItems": true, - "description": "Specifies where Git code lens will be shown in the document", + "markdownDescription": "Specifies where Git code lens will be shown in the document", "scope": "resource" }, "gitlens.codeLens.scopesByLanguage": { @@ -354,12 +354,12 @@ "type": "string" }, "uniqueItems": true, - "description": "Specifies the set of document symbols where Git code lens will be shown in the document for the specified language\nMust be a member of `SymbolKind`" + "description": "Specifies the set of document symbols where Git code lens will be shown in the document for the specified language. Must be a member of `SymbolKind`" } } }, "uniqueItems": true, - "description": "Specifies where Git code lens will be shown in the document for the specified languages", + "markdownDescription": "Specifies where Git code lens will be shown in the document for the specified languages", "scope": "resource" }, "gitlens.codeLens.symbolScopes": { @@ -368,43 +368,43 @@ "type": "string" }, "uniqueItems": true, - "description": "Specifies a set of document symbols where Git code lens will or will not be shown in the document\nPrefix with `!` to avoid providing a Git code lens for the symbol\nMust be a member of `SymbolKind`", + "markdownDescription": "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`", "scope": "resource" }, "gitlens.currentLine.dateFormat": { "type": "string", "default": null, - "description": "Specifies how to format absolute dates (using the `${date}` token) for the current line blame annotation\nSee https://momentjs.com/docs/#/displaying/format/ for valid formats", + "markdownDescription": "Specifies how to format absolute dates (using the `${date}` token) for the current line blame annotation. See the [Moment.js docs](https://momentjs.com/docs/#/displaying/format/) for valid formats", "scope": "window" }, "gitlens.currentLine.enabled": { "type": "boolean", "default": true, - "description": "Specifies whether to provide a blame annotation for the current line, by default\nUse the `Toggle Line Blame Annotations` command (`gitlens.toggleLineBlame`) to toggle the annotations on and off for the current window", + "markdownDescription": "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", "scope": "window" }, "gitlens.currentLine.format": { "type": "string", "default": "${authorAgoOrDate} • ${message}", - "description": "Specifies the format of the current line blame annotation\nAvailable tokens\n ${id} - commit id\n ${author} - commit author\n ${message} - commit message\n ${ago} - relative commit date (e.g. 1 day ago)\n ${date} - formatted commit date (format specified by `gitlens.currentLine.dateFormat`)\n ${agoOrDate} - commit date specified by `gitlens.defaultDateStyle`\n ${authorAgo} - commit author, relative commit date\n ${authorAgoOrDate} - commit author, commit date specified by `gitlens.defaultDateStyle`\nSee https://github.com/eamodio/vscode-gitlens/wiki/Advanced-Formatting for advanced formatting", + "markdownDescription": "Specifies the format of the current line blame annotation. See the [GitLens docs](https://github.com/eamodio/vscode-gitlens/wiki/Advanced-Formatting) for advanced formatting\n- Available tokens\n - `${id}` — commit id\n - `${author}` — commit author\n - `${message}` — commit message\n - `${ago}` — relative commit date (e.g. 1 day ago)\n - `${date}` — formatted commit date (format specified by `#gitlens.currentLine.dateFormat#`)\n - `${agoOrDate}` — commit date specified by `#gitlens.defaultDateStyle#`\n - `${authorAgo}` — commit author, relative commit date\n - `${authorAgoOrDate}` — commit author, commit date specified by `#gitlens.defaultDateStyle#`", "scope": "window" }, "gitlens.currentLine.scrollable": { "type": "boolean", "default": true, - "description": "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", "scope": "window" }, "gitlens.debug": { "type": "boolean", "default": false, - "description": "Specifies debug mode", + "markdownDescription": "Specifies debug mode", "scope": "window" }, "gitlens.defaultDateFormat": { "type": "string", "default": null, - "description": "Specifies how absolute dates will be formatted by default\nSee https://momentjs.com/docs/#/displaying/format/ for valid formats", + "markdownDescription": "Specifies how absolute dates will be formatted by default. See the [Moment.js docs](https://momentjs.com/docs/#/displaying/format/) for valid formats", "scope": "window" }, "gitlens.defaultDateStyle": { @@ -418,7 +418,7 @@ "e.g. 1 day ago", "e.g. July 25th, 2018 7:18pm" ], - "description": "Specifies how dates will be displayed by default", + "markdownDescription": "Specifies how dates will be displayed by default", "scope": "window" }, "gitlens.defaultGravatarsStyle": { @@ -440,25 +440,25 @@ "A robot with different colors, faces, etc", "A face with differing features and backgrounds" ], - "description": "Specifies the style of the gravatar default (fallback) images", + "markdownDescription": "Specifies the style of the gravatar default (fallback) images", "scope": "window" }, "gitlens.heatmap.ageThreshold": { "type": "string", "default": "90", - "description": "Specifies the age of the most recent change (in days) after which the gutter heatmap annotations will be cold rather than hot (i.e. will use `#gitlens.heatmap.coldColor#` instead of `#gitlens.heatmap.hotColor#`)", + "markdownDescription": "Specifies the age of the most recent change (in days) after which the gutter heatmap annotations will be cold rather than hot (i.e. will use `#gitlens.heatmap.coldColor#` instead of `#gitlens.heatmap.hotColor#`)", "scope": "window" }, "gitlens.heatmap.coldColor": { "type": "string", "default": "#0a60f6", - "description": "Specifies the base color of the gutter heatmap annotations when the most recent change is older (cold) than the `#gitlens.heatmap.ageThreshold#` value", + "markdownDescription": "Specifies the base color of the gutter heatmap annotations when the most recent change is older (cold) than the `#gitlens.heatmap.ageThreshold#` value", "scope": "window" }, "gitlens.heatmap.hotColor": { "type": "string", "default": "#f66a0a", - "description": "Specifies the base color of the gutter heatmap annotations when the most recent change is newer (hot) than the `#gitlens.heatmap.ageThreshold#` value", + "markdownDescription": "Specifies the base color of the gutter heatmap annotations when the most recent change is newer (hot) than the `#gitlens.heatmap.ageThreshold#` value", "scope": "window" }, "gitlens.heatmap.toggleMode": { @@ -472,25 +472,25 @@ "Toggles each file individually", "Toggles the window, i.e. all files at once" ], - "description": "Specifies how the gutter heatmap annotations will be toggled", + "markdownDescription": "Specifies how the gutter heatmap annotations will be toggled", "scope": "window" }, "gitlens.hovers.annotations.changes": { "type": "boolean", "default": true, - "description": "Specifies whether to provide a changes (diff) hover for all lines when showing blame annotations", + "markdownDescription": "Specifies whether to provide a _changes (diff)_ hover for all lines when showing blame annotations", "scope": "window" }, "gitlens.hovers.annotations.details": { "type": "boolean", "default": true, - "description": "Specifies whether to provide a commit details hover for all lines when showing blame annotations", + "markdownDescription": "Specifies whether to provide a _commit details_ hover for all lines when showing blame annotations", "scope": "window" }, "gitlens.hovers.annotations.enabled": { "type": "boolean", "default": true, - "description": "Specifies whether to provide any hovers when showing blame annotations", + "markdownDescription": "Specifies whether to provide any hovers when showing blame annotations", "scope": "window" }, "gitlens.hovers.annotations.over": { @@ -504,25 +504,25 @@ "Only shown when hovering over the line annotation", "Shown when hovering anywhere over the line" ], - "description": "Specifies when to trigger hovers when showing blame annotations", + "markdownDescription": "Specifies when to trigger hovers when showing blame annotations", "scope": "window" }, "gitlens.hovers.currentLine.changes": { "type": "boolean", "default": true, - "description": "Specifies whether to provide a changes (diff) hover for the current line", + "markdownDescription": "Specifies whether to provide a _changes (diff)_ hover for the current line", "scope": "window" }, "gitlens.hovers.currentLine.details": { "type": "boolean", "default": true, - "description": "Specifies whether to provide a commit details hover for the current line", + "markdownDescription": "Specifies whether to provide a _commit details_ hover for the current line", "scope": "window" }, "gitlens.hovers.currentLine.enabled": { "type": "boolean", "default": true, - "description": "Specifies whether to provide any hovers for the current line", + "markdownDescription": "Specifies whether to provide any hovers for the current line", "scope": "window" }, "gitlens.hovers.currentLine.over": { @@ -536,25 +536,25 @@ "Only shown when hovering over the line annotation", "Shown when hovering anywhere over the line" ], - "description": "Specifies when to trigger hovers for the current line", + "markdownDescription": "Specifies when to trigger hovers for the current line", "scope": "window" }, "gitlens.hovers.avatars": { "type": "boolean", "default": true, - "description": "Specifies whether to show avatar images in hovers", + "markdownDescription": "Specifies whether to show avatar images in hovers", "scope": "window" }, "gitlens.hovers.enabled": { "type": "boolean", "default": true, - "description": "Specifies whether to provide any hovers", + "markdownDescription": "Specifies whether to provide any hovers", "scope": "window" }, "gitlens.insiders": { "type": "boolean", "default": false, - "description": "Specifies whether to enable experimental features", + "markdownDescription": "Specifies whether to enable experimental features", "scope": "window" }, "gitlens.keymap": { @@ -570,7 +570,7 @@ "Adds a chorded set of shortcut keys that start with `Ctrl+Alt+G` (`⌥⌘G` on macOS)", "No shortcut keys will be added" ], - "description": "Specifies the keymap to use for GitLens shortcut keys", + "markdownDescription": "Specifies the keymap to use for GitLens shortcut keys", "scope": "window" }, "gitlens.menus": { @@ -716,18 +716,18 @@ "remote": true } }, - "description": "Specifies which commands will be added to which menus", + "markdownDescription": "Specifies which commands will be added to which menus", "scope": "window" }, "gitlens.mode.active": { "type": "string", - "description": "Specifies the active GitLens mode, if any", + "markdownDescription": "Specifies the active GitLens mode, if any", "scope": "window" }, "gitlens.mode.statusBar.enabled": { "type": "boolean", "default": true, - "description": "Specifies whether to provide the active GitLens mode in the status bar", + "markdownDescription": "Specifies whether to provide the active GitLens mode in the status bar", "scope": "window" }, "gitlens.mode.statusBar.alignment": { @@ -741,7 +741,7 @@ "Aligns to the left", "Aligns to the right" ], - "description": "Specifies the active GitLens mode alignment in the status bar", + "markdownDescription": "Specifies the active GitLens mode alignment in the status bar", "scope": "window" }, "gitlens.modes": { @@ -863,7 +863,7 @@ "hovers": true } }, - "description": "Specifies the user-defined GitLens modes", + "markdownDescription": "Specifies the user-defined GitLens modes", "scope": "window" }, "gitlens.outputLevel": { @@ -875,7 +875,7 @@ "verbose", "debug" ], - "description": "Specifies how much (if any) output will be sent to the GitLens output channel", + "markdownDescription": "Specifies how much (if any) output will be sent to the GitLens output channel", "scope": "window" }, "gitlens.recentChanges.highlight.locations": { @@ -901,7 +901,7 @@ "minItems": 1, "maxItems": 3, "uniqueItems": true, - "description": "Specifies where the highlights of the recently changed lines will be shown", + "markdownDescription": "Specifies where the highlights of the recently changed lines will be shown", "scope": "window" }, "gitlens.recentChanges.toggleMode": { @@ -915,7 +915,7 @@ "Toggles each file individually", "Toggles the window, i.e. all files at once" ], - "description": "Specifies how the recently changed lines annotations will be toggled", + "markdownDescription": "Specifies how the recently changed lines annotations will be toggled", "scope": "window" }, "gitlens.remotes": { @@ -968,39 +968,39 @@ "properties": { "repository": { "type": "string", - "description": "Specifies the format of a respository url for the custom remote service\nAvailable tokens\n ${repo} - repository path" + "description": "Specifies the format of a respository url for the custom remote service\nAvailable tokens\n ${repo}` — repository path" }, "branches": { "type": "string", - "description": "Specifies the format of a branches url for the custom remote service\nAvailable tokens\n ${repo} - repository path\n ${branch} - branch" + "description": "Specifies the format of a branches url for the custom remote service\nAvailable tokens\n ${repo}` — repository path\n ${branch}` — branch" }, "branch": { "type": "string", - "description": "Specifies the format of a branch url for the custom remote service\nAvailable tokens\n ${repo} - repository path\n ${branch} - branch" + "description": "Specifies the format of a branch url for the custom remote service\nAvailable tokens\n ${repo}` — repository path\n ${branch}` — branch" }, "commit": { "type": "string", - "description": "Specifies the format of a commit url for the custom remote service\nAvailable tokens\n ${repo} - repository path\n ${id} - commit id" + "description": "Specifies the format of a commit url for the custom remote service\nAvailable tokens\n ${repo}` — repository path\n ${id}` — commit id" }, "file": { "type": "string", - "description": "Specifies the format of a file url for the custom remote service\nAvailable tokens\n ${repo} - repository path\n ${file} - file name\n ${line} - formatted line information" + "description": "Specifies the format of a file url for the custom remote service\nAvailable tokens\n ${repo}` — repository path\n ${file}` — file name\n ${line}` — formatted line information" }, "fileInBranch": { "type": "string", - "description": "Specifies the format of a branch file url for the custom remote service\nAvailable tokens\n ${repo} - repository path\n ${file} - file name\n ${branch} - branch\n ${line} - formatted line information" + "description": "Specifies the format of a branch file url for the custom remote service\nAvailable tokens\n ${repo}` — repository path\n ${file}` — file name\n ${branch}` — branch\n ${line}` — formatted line information" }, "fileInCommit": { "type": "string", - "description": "Specifies the format of a commit file url for the custom remote service\nAvailable tokens\n ${repo} - repository path\n ${file} - file name\n ${id} - commit id\n ${line} - formatted line information" + "description": "Specifies the format of a commit file url for the custom remote service\nAvailable tokens\n ${repo}` — repository path\n ${file}` — file name\n ${id}` — commit id\n ${line}` — formatted line information" }, "fileLine": { "type": "string", - "description": "Specifies the format of a line in a file url for the custom remote service\nAvailable tokens\n ${line} - line" + "description": "Specifies the format of a line in a file url for the custom remote service\nAvailable tokens\n ${line}` — line" }, "fileRange": { "type": "string", - "description": "Specifies the format of a range in a file url for the custom remote service\nAvailable tokens\n ${start} - starting line\n ${end} - ending line" + "description": "Specifies the format of a range in a file url for the custom remote service\nAvailable tokens\n ${start}` — starting line\n ${end}` — ending line" } } }, @@ -1008,7 +1008,7 @@ } }, "uniqueItems": true, - "description": "Specifies user-defined remote (code-hosting) services or custom domains for built-in remote services", + "markdownDescription": "Specifies user-defined remote (code-hosting) services or custom domains for built-in remote services", "scope": "resource" }, "gitlens.settings.mode": { @@ -1022,13 +1022,13 @@ "Only displays common settings", "Displays all settings" ], - "description": "Specifies the display mode of the interactive settings editor", + "markdownDescription": "Specifies the display mode of the interactive settings editor", "scope": "window" }, "gitlens.showWhatsNewAfterUpgrades": { "type": "boolean", "default": true, - "description": "Specifies whether to show What's New after upgrading to new feature releases", + "markdownDescription": "Specifies whether to show What's New after upgrading to new feature releases", "scope": "window" }, "gitlens.statusBar.alignment": { @@ -1042,7 +1042,7 @@ "Aligns to the left", "Aligns to the right" ], - "description": "Specifies the blame alignment in the status bar", + "markdownDescription": "Specifies the blame alignment in the status bar", "scope": "window" }, "gitlens.statusBar.command": { @@ -1068,79 +1068,79 @@ "Shows a file history quick pick", "Shows a branch history quick pick" ], - "description": "Specifies the command to be executed when the blame status bar item is clicked", + "markdownDescription": "Specifies the command to be executed when the blame status bar item is clicked", "scope": "window" }, "gitlens.statusBar.dateFormat": { "type": "string", "default": null, - "description": "Specifies the date format of absolute dates shown in the blame information in the status bar. See https://momentjs.com/docs/#/displaying/format/ for valid formats", + "markdownDescription": "Specifies the date format of absolute dates shown in the blame information in the status bar. See the [Moment.js docs](https://momentjs.com/docs/#/displaying/format/) for valid formats", "scope": "window" }, "gitlens.statusBar.enabled": { "type": "boolean", "default": true, - "description": "Specifies whether to provide blame information in the status bar", + "markdownDescription": "Specifies whether to provide blame information in the status bar", "scope": "window" }, "gitlens.statusBar.format": { "type": "string", "default": "${authorAgoOrDate}", - "description": "Specifies the format of the status bar blame information\nAvailable tokens\n ${id} - commit id\n ${author} - commit author\n ${message} - commit message\n ${ago} - relative commit date (e.g. 1 day ago)\n ${date} - formatted commit date (format specified by `gitlens.statusBar.dateFormat`)\n ${agoOrDate} - commit date specified by `gitlens.defaultDateStyle`\n ${authorAgo} - commit author, relative commit date\n ${authorAgoOrDate} - commit author, commit date specified by `gitlens.defaultDateStyle`\nSee https://github.com/eamodio/vscode-gitlens/wiki/Advanced-Formatting for advanced formatting", + "markdownDescription": "Specifies the format of the gutter blame annotations. See the [GitLens docs](https://github.com/eamodio/vscode-gitlens/wiki/Advanced-Formatting) for advanced formatting\n- Available tokens\n - `${id}` — commit id\n - `${author}` — commit author\n - `${message}` — commit message\n - `${ago}` — relative commit date (e.g. 1 day ago)\n - `${date}` — formatted commit date (format specified by `#gitlens.statusBar.dateFormat#`)\n - `${agoOrDate}` — commit date specified by `#gitlens.defaultDateStyle#`\n - `${authorAgo}` — commit author, relative commit date\n - `${authorAgoOrDate}` — commit author, commit date specified by `#gitlens.defaultDateStyle#`", "scope": "window" }, "gitlens.statusBar.reduceFlicker": { "type": "boolean", "default": false, - "description": "Specifies whether to avoid clearing the previous blame information when changing lines to reduce status bar \"flashing\"", + "markdownDescription": "Specifies whether to avoid clearing the previous blame information when changing lines to reduce status bar \"flashing\"", "scope": "window" }, "gitlens.strings.codeLens.unsavedChanges.recentChangeAndAuthors": { "type": "string", "default": "Unsaved changes (cannot determine recent change or authors)", - "description": "Specifies the string to be shown in place of both the `recent change` and `authors` code lens when there are unsaved changes", + "markdownDescription": "Specifies the string to be shown in place of both the _recent change_ and _authors_ code lens when there are unsaved changes", "scope": "window" }, "gitlens.strings.codeLens.unsavedChanges.recentChangeOnly": { "type": "string", "default": "Unsaved changes (cannot determine recent change)", - "description": "Specifies the string to be shown in place of the `recent change` code lens when there are unsaved changes", + "markdownDescription": "Specifies the string to be shown in place of the _recent change_ code lens when there are unsaved changes", "scope": "window" }, "gitlens.strings.codeLens.unsavedChanges.authorsOnly": { "type": "string", "default": "Unsaved changes (cannot determine authors)", - "description": "Specifies the string to be shown in place of the `authors` code lens when there are unsaved changes", + "markdownDescription": "Specifies the string to be shown in place of the _authors_ code lens when there are unsaved changes", "scope": "window" }, "gitlens.views.avatars": { "type": "boolean", "default": true, - "description": "Specifies whether to show avatar images instead of commit (or status) icons in the views", + "markdownDescription": "Specifies whether to show avatar images instead of commit (or status) icons in the views", "scope": "window" }, "gitlens.views.commitFileFormat": { "type": "string", "default": "${filePath}", - "description": "Specifies the format of a committed file in the views\nAvailable tokens\n ${directory} - directory name\n ${file} - file name\n ${filePath} - formatted file name and path\n ${path} - full file path", + "markdownDescription": "Specifies the format of a committed file in the views\n- Available tokens\n - `${directory}` — directory name\n - `${file}` — file name\n - `${filePath}` — formatted file name and path\n - `${path}` — full file path", "scope": "window" }, "gitlens.views.commitFormat": { "type": "string", "default": "${message} • ${authorAgoOrDate}${ • changes}${ (id)}", - "description": "Specifies the format of committed changes in the views\nAvailable tokens\n ${id} - commit id\n ${author} - commit author\n ${message} - commit message\n ${ago} - relative commit date (e.g. 1 day ago)\n ${date} - formatted commit date (format specified by `gitlens.defaultDateFormat`)\\n ${agoOrDate} - commit date specified by `gitlens.defaultDateStyle`\n ${authorAgo} - commit author, relative commit date\n ${authorAgoOrDate} - commit author, commit date specified by `gitlens.defaultDateStyle`\nSee https://github.com/eamodio/vscode-gitlens/wiki/Advanced-Formatting for advanced formatting", + "markdownDescription": "Specifies the format of committed changes in the views. See the [GitLens docs](https://github.com/eamodio/vscode-gitlens/wiki/Advanced-Formatting) for advanced formatting\n- Available tokens\n - `${id}` — commit id\n - `${author}` — commit author\n - `${message}` — commit message\n - `${ago}` — relative commit date (e.g. 1 day ago)\n - `${date}` — formatted commit date (format specified by `#gitlens.defaultDateFormat#`)\n - `${agoOrDate}` — commit date specified by `#gitlens.defaultDateStyle#`\n - `${authorAgo}` — commit author, relative commit date\n - `${authorAgoOrDate}` — commit author, commit date specified by `#gitlens.defaultDateStyle#`", "scope": "window" }, "gitlens.views.compare.enabled": { "type": "boolean", "default": true, - "description": "Specifies whether to show the `Compare` view", + "markdownDescription": "Specifies whether to show the _Compare_ view", "scope": "window" }, "gitlens.views.compare.files.compact": { "type": "boolean", "default": true, - "description": "Specifies whether to compact (flatten) unnecessary file nesting in the `Compare` view\nOnly applies when `#gitlens.views.compare.files.layout#` is set to `tree` or `auto`", + "markdownDescription": "Specifies whether to compact (flatten) unnecessary file nesting in the _Compare_ view. Only applies when `#gitlens.views.compare.files.layout#` is set to `tree` or `auto`", "scope": "window" }, "gitlens.views.compare.files.layout": { @@ -1156,13 +1156,13 @@ "Displays files as a list", "Displays files as a tree" ], - "description": "Specifies how the `Compare` view will display files", + "markdownDescription": "Specifies how the _Compare_ view will display files", "scope": "window" }, "gitlens.views.compare.files.threshold": { "type": "number", "default": 5, - "description": "Specifies when to switch between displaying files as a `tree` or `list` based on the number of files in a nesting level in the `Compare` view\nOnly applies when `#gitlens.views.compare.files.layout#` is set to `auto`", + "markdownDescription": "Specifies when to switch between displaying files as a `tree` or `list` based on the number of files in a nesting level in the _Compare_ view. Only applies when `#gitlens.views.compare.files.layout#` is set to `auto`", "scope": "window" }, "gitlens.views.compare.location": { @@ -1178,25 +1178,25 @@ "Adds to the Explorer side bar", "Adds to the Source Control side bar" ], - "description": "Specifies where to show the `Compare` view", + "markdownDescription": "Specifies where to show the _Compare_ view", "scope": "window" }, "gitlens.views.defaultItemLimit": { "type": "number", "default": 10, - "description": "Specifies the default number of items to show in a view list. Use 0 to specify no limit", + "markdownDescription": "Specifies the default number of items to show in a view list. Use 0 to specify no limit", "scope": "window" }, "gitlens.views.fileHistory.avatars": { "type": "boolean", "default": true, - "description": "Specifies whether to show avatar images instead of status icons in the `File History` view", + "markdownDescription": "Specifies whether to show avatar images instead of status icons in the _File History_ view", "scope": "window" }, "gitlens.views.fileHistory.enabled": { "type": "boolean", "default": true, - "description": "Specifies whether to show the `File History` view", + "markdownDescription": "Specifies whether to show the _File History_ view", "scope": "window" }, "gitlens.views.fileHistory.location": { @@ -1212,19 +1212,19 @@ "Adds to the Explorer side bar", "Adds to the Source Control side bar" ], - "description": "Specifies where to show the `File History` view", + "markdownDescription": "Specifies where to show the _File History_ view", "scope": "window" }, "gitlens.views.lineHistory.avatars": { "type": "boolean", "default": true, - "description": "Specifies whether to show avatar images instead of status icons in the `Line History` view", + "markdownDescription": "Specifies whether to show avatar images instead of status icons in the _Line History_ view", "scope": "window" }, "gitlens.views.lineHistory.enabled": { "type": "boolean", "default": true, - "description": "Specifies whether to show the `Line History` view", + "markdownDescription": "Specifies whether to show the _Line History_ view", "scope": "window" }, "gitlens.views.lineHistory.location": { @@ -1240,19 +1240,19 @@ "Adds to the Explorer side bar", "Adds to the Source Control side bar" ], - "description": "Specifies where to show the `Line History` view", + "markdownDescription": "Specifies where to show the _Line History_ view", "scope": "window" }, "gitlens.views.repositories.autoRefresh": { "type": "boolean", "default": true, - "description": "Specifies whether to automatically refresh the `Repositories` view when the repository or the file system changes", + "markdownDescription": "Specifies whether to automatically refresh the _Repositories_ view when the repository or the file system changes", "scope": "window" }, "gitlens.views.repositories.autoReveal": { "type": "boolean", "default": true, - "description": "Specifies whether to automatically reveal repositories in the `Repositories` view when opening files", + "markdownDescription": "Specifies whether to automatically reveal repositories in the _Repositories_ view when opening files", "scope": "window" }, "gitlens.views.repositories.branches.layout": { @@ -1266,19 +1266,19 @@ "Displays branches as a list", "Displays branches as a tree when branch names contain slashes `/`" ], - "description": "Specifies how the `Repositories` view will display branches", + "markdownDescription": "Specifies how the _Repositories_ view will display branches", "scope": "window" }, "gitlens.views.repositories.enabled": { "type": "boolean", "default": true, - "description": "Specifies whether to show the `Repositories` view", + "markdownDescription": "Specifies whether to show the _Repositories_ view", "scope": "window" }, "gitlens.views.repositories.files.compact": { "type": "boolean", "default": true, - "description": "Specifies whether to compact (flatten) unnecessary file nesting in the `Repositories` view\nOnly applies when `#gitlens.views.repositories.files.layout#` is set to `tree` or `auto`", + "markdownDescription": "Specifies whether to compact (flatten) unnecessary file nesting in the _Repositories_ view. Only applies when `#gitlens.views.repositories.files.layout#` is set to `tree` or `auto`", "scope": "window" }, "gitlens.views.repositories.files.layout": { @@ -1294,19 +1294,19 @@ "Displays files as a list", "Displays files as a tree" ], - "description": "Specifies how the `Repositories` view will display files", + "markdownDescription": "Specifies how the _Repositories_ view will display files", "scope": "window" }, "gitlens.views.repositories.files.threshold": { "type": "number", "default": 5, - "description": "Specifies when to switch between displaying files as a `tree` or `list` based on the number of files in a nesting level in the `Repositories` view\nOnly applies when `#gitlens.views.repositories.files.layout#` is set to `auto`", + "markdownDescription": "Specifies when to switch between displaying files as a `tree` or `list` based on the number of files in a nesting level in the _Repositories_ view. Only applies when `#gitlens.views.repositories.files.layout#` is set to `auto`", "scope": "window" }, "gitlens.views.repositories.includeWorkingTree": { "type": "boolean", "default": true, - "description": "Specifies whether to include working tree files inside the `Repository` node of the `Repositories` view", + "markdownDescription": "Specifies whether to include working tree file status for each repository in the _Repositories_ view", "scope": "window" }, "gitlens.views.repositories.location": { @@ -1322,25 +1322,25 @@ "Adds to the Explorer side bar", "Adds to the Source Control side bar" ], - "description": "Specifies where to show the `Repositories` view", + "markdownDescription": "Specifies where to show the _Repositories_ view", "scope": "window" }, "gitlens.views.repositories.showTrackingBranch": { "type": "boolean", "default": true, - "description": "Specifies whether to show the tracking branch when displaying local branches in the `Repositories` view", + "markdownDescription": "Specifies whether to show the tracking branch when displaying local branches in the _Repositories_ view", "scope": "window" }, "gitlens.views.search.enabled": { "type": "boolean", "default": true, - "description": "Specifies whether to show the `Search Commits` view", + "markdownDescription": "Specifies whether to show the _Search Commits_ view", "scope": "window" }, "gitlens.views.search.files.compact": { "type": "boolean", "default": true, - "description": "Specifies whether to compact (flatten) unnecessary file nesting in the `Search Commits` view\nOnly applies when `#gitlens.views.search.files.layout#` is set to `tree` or `auto`", + "markdownDescription": "Specifies whether to compact (flatten) unnecessary file nesting in the _Search Commits_ view. Only applies when `#gitlens.views.search.files.layout#` is set to `tree` or `auto`", "scope": "window" }, "gitlens.views.search.files.layout": { @@ -1356,13 +1356,13 @@ "Displays files as a list", "Displays files as a tree" ], - "description": "Specifies how the `Search Commits` view will display files", + "markdownDescription": "Specifies how the _Search Commits_ view will display files", "scope": "window" }, "gitlens.views.search.files.threshold": { "type": "number", "default": 5, - "description": "Specifies when to switch between displaying files as a `tree` or `list` based on the number of files in a nesting level in the `Search Commits` view\nOnly applies when `#gitlens.views.search.files.layout#` is set to `auto`", + "markdownDescription": "Specifies when to switch between displaying files as a `tree` or `list` based on the number of files in a nesting level in the _Search Commits_ view. Only applies when `#gitlens.views.search.files.layout#` is set to `auto`", "scope": "window" }, "gitlens.views.search.location": { @@ -1378,25 +1378,25 @@ "Adds to the Explorer side bar", "Adds to the Source Control side bar" ], - "description": "Specifies where to show the `Search Commits` view", + "markdownDescription": "Specifies where to show the _Search Commits_ view", "scope": "window" }, "gitlens.views.stashFileFormat": { "type": "string", "default": "${filePath}", - "description": "Specifies the format of a stashed file in the views\nAvailable tokens\n ${directory} - directory name\n ${file} - file name\n ${filePath} - formatted file name and path\n ${path} - full file path", + "markdownDescription": "Specifies the format of a stashed file in the views\n- Available tokens\n - `${directory}` — directory name\n - `${file}` — file name\n - `${filePath}` — formatted file name and path\n - `${path}` — full file path", "scope": "window" }, "gitlens.views.stashFormat": { "type": "string", "default": "${message}", - "description": "Specifies the format of stashed changes in the views\nAvailable tokens\n ${id} - commit id\n ${author} - commit author\n ${message} - commit message\n ${ago} - relative commit date (e.g. 1 day ago)\n ${date} - formatted commit date (format specified by `gitlens.statusBar.dateFormat`)\n ${agoOrDate} - commit date specified by `gitlens.defaultDateStyle`\n ${authorAgo} - commit author, relative commit date\n ${authorAgoOrDate} - commit author, commit date specified by `gitlens.defaultDateStyle`\nSee https://github.com/eamodio/vscode-gitlens/wiki/Advanced-Formatting for advanced formatting", + "markdownDescription": "Specifies the format of stashed changes in the views. See the [GitLens docs](https://github.com/eamodio/vscode-gitlens/wiki/Advanced-Formatting) for advanced formatting\n- Available tokens\n - `${id}` — commit id\n - `${author}` — commit author\n - `${message}` — commit message\n - `${ago}` — relative commit date (e.g. 1 day ago)\n - `${date}` — formatted commit date (format specified by `#gitlens.statusBar.dateFormat#`)\n - `${agoOrDate}` — commit date specified by `#gitlens.defaultDateStyle#`\n - `${authorAgo}` — commit author, relative commit date\n - `${authorAgoOrDate}` — commit author, commit date specified by `#gitlens.defaultDateStyle#`", "scope": "window" }, "gitlens.views.statusFileFormat": { "type": "string", "default": "${working }${filePath}", - "description": "Specifies the format of the status of a working or committed file in the views\nAvailable tokens\n ${directory} - directory name\n ${file} - file name\n ${filePath} - formatted file name and path\n ${path} - full file path\n ${working} - optional indicator if the file is uncommitted", + "markdownDescription": "Specifies the format of the status of a working or committed file in the views\n- Available tokens\n - `${directory}` — directory name\n - `${file}` — file name\n - `${filePath}` — formatted file name and path\n - `${path}` — full file path\n - `${working}` — optional indicator if the file is uncommitted", "scope": "window" }, "gitlens.advanced.blame.customArguments": { @@ -1405,37 +1405,37 @@ "items": { "type": "string" }, - "description": "Specifies additional arguments to pass to the `git blame` command", + "markdownDescription": "Specifies additional arguments to pass to the `git blame` command", "scope": "resource" }, "gitlens.advanced.blame.delayAfterEdit": { "type": "number", "default": 5000, - "description": "Specifies the time (in milliseconds) to wait before re-blaming an unsaved document after an edit. Use 0 to specify an infinite wait", + "markdownDescription": "Specifies the time (in milliseconds) to wait before re-blaming an unsaved document after an edit. Use 0 to specify an infinite wait", "scope": "window" }, "gitlens.advanced.blame.sizeThresholdAfterEdit": { "type": "number", "default": 5000, - "description": "Specifies the maximum document size (in lines) allowed to be re-blamed after an edit while still unsaved. Use 0 to specify no maximum", + "markdownDescription": "Specifies the maximum document size (in lines) allowed to be re-blamed after an edit while still unsaved. Use 0 to specify no maximum", "scope": "window" }, "gitlens.advanced.caching.enabled": { "type": "boolean", "default": true, - "description": "Specifies whether git output will be cached — changing the default is not recommended", + "markdownDescription": "Specifies whether git output will be cached — changing the default is not recommended", "scope": "window" }, "gitlens.advanced.fileHistoryFollowsRenames": { "type": "boolean", "default": true, - "description": "Specifies whether file histories will follow renames — will affect how merge commits are shown in histories", + "markdownDescription": "Specifies whether file histories will follow renames — will affect how merge commits are shown in histories", "scope": "window" }, "gitlens.advanced.maxListItems": { "type": "number", "default": 200, - "description": "Specifies the maximum number of items to show in a list. Use 0 to specify no maximum", + "markdownDescription": "Specifies the maximum number of items to show in a list. Use 0 to specify no maximum", "scope": "window" }, "gitlens.advanced.messages": { @@ -1489,25 +1489,25 @@ "default": false } }, - "description": "Specifies which messages should be suppressed", + "markdownDescription": "Specifies which messages should be suppressed", "scope": "window" }, "gitlens.advanced.quickPick.closeOnFocusOut": { "type": "boolean", "default": true, - "description": "Specifies whether to close QuickPick menus when focus is lost", + "markdownDescription": "Specifies whether to close QuickPick menus when focus is lost", "scope": "window" }, "gitlens.advanced.repositorySearchDepth": { "type": "number", "default": 1, - "description": "Specifies how many folders deep to search for repositories", + "markdownDescription": "Specifies how many folders deep to search for repositories", "scope": "resource" }, "gitlens.advanced.telemetry.enabled": { "type": "boolean", "default": true, - "description": "Specifies whether to enable GitLens telemetry (even if enabled still abides by the overall `telemetry.enableTelemetry` setting", + "markdownDescription": "Specifies whether to enable GitLens telemetry (even if enabled still abides by the overall `#telemetry.enableTelemetry#` setting", "scope": "window" } }