From 1f8c16fa58f2c55325bd2e975223c593080a3ec8 Mon Sep 17 00:00:00 2001 From: Eric Amodio Date: Mon, 14 Dec 2020 17:02:05 -0500 Subject: [PATCH] Renames showWelcomeOrWhatsNew And limits it to only affect the welcome experience since showWhatsNewAfterUpgrades already exists --- CHANGELOG.md | 3 ++- README.md | 3 ++- package.json | 4 ++-- src/config.ts | 2 +- src/extension.ts | 4 +--- 5 files changed, 8 insertions(+), 8 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 27e1576..6d18127 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -9,7 +9,7 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/) and this p ### Added - Adds ability to show gutter heatmap in the gutter and/or on the scroll bar — closes [#297](https://github.com/eamodio/vscode-gitlens/issues/297) - - Adds `gitlens.heatmap.locations` setting to specify where the indicators of the gutter heatmap annotations will be shown + - Adds a `gitlens.heatmap.locations` setting to specify where the indicators of the gutter heatmap annotations will be shown - Adds a `gitlens.fileAnnotations.command` setting to specify whether the file annotations button in the editor title shows a menu or immediately toggles the specified file annotations — closes [#1165](https://github.com/eamodio/vscode-gitlens/issues/1165) thanks to [PR #1171](https://github.com/eamodio/vscode-gitlens/pull/1171) by Raaj Patil ([@arrpee](https://github.com/arrpee)) - Adds this new option to the _Menus & Toolbars_ section of the GitLens Interactive Settings - Adds an _Open File on Remote From..._ command (`gitlens.openFileOnRemoteFrom`) to open a file or revision on a specific branch or tag on the remote provider — closes [#1071](https://github.com/eamodio/vscode-gitlens/issues/1071) @@ -18,6 +18,7 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/) and this p - Adds preview extensibility APIs - Adds a preview _action runner_ extensibility point to provide a runner (handler) for a new _createPullRequest_ and _openPullRequest_ actions — see `gitlens.d.ts` for API definitions - Preview APIs are only available in the Insiders edition +- Adds a `gitlens.showWelcomeOnInstall` setting to specify whether to show the Welcome (Quick Setup) experience on first install — closes [#1049](https://github.com/eamodio/vscode-gitlens/issues/1049) thanks to [PR #1258](https://github.com/eamodio/vscode-gitlens/pull/1258) by Rickard ([@rickardp](https://github.com/rickardp)) ### Changed diff --git a/README.md b/README.md index 287aafe..4b34801 100644 --- a/README.md +++ b/README.md @@ -903,7 +903,7 @@ See also [View Settings](#view-settings- 'Jump to the View settings') | `gitlens.insiders` | Specifies whether to enable experimental features | | `gitlens.liveshare.allowGuestAccess` | Specifies whether to allow guest access to GitLens features when using Visual Studio Live Share | | `gitlens.outputLevel` | Specifies how much (if any) output will be sent to the GitLens output channel | -| `gitlens.showWelcomeOrWhatsNew` | Specifies whether to show the Welcome (Quick Setup) experience on first install, or the What's New notification after upgrading to new feature releases | +| `gitlens.showWelcomeOnInstall` | Specifies whether to show the Welcome (Quick Setup) experience on first install | | `gitlens.showWhatsNewAfterUpgrades` | Specifies whether to show the What's New notification after upgrading to new feature releases | | `gitlens.advanced.abbreviatedShaLength` | Specifies the length of abbreviated commit SHAs (shas) | | `gitlens.advanced.blame.customArguments` | Specifies additional arguments to pass to the `git blame` command | @@ -985,6 +985,7 @@ A big thanks to the people that have contributed to this project: - Connor Peet ([@connor4312](https://github.com/connor4312)) — [contributions](https://github.com/eamodio/vscode-gitlens/commits?author=connor4312) - Maxim Pekurin ([@pmaxim25](https://github.com/pmaxim25)) — [contributions](https://github.com/eamodio/vscode-gitlens/commits?author=pmaxim25) - Arunprasad Rajkumar ([@arajkumar](https://github.com/arajkumar)) — [contributions](https://github.com/eamodio/vscode-gitlens/commits?author=arajkumar) +- Rickard ([@rickardp](https://github.com/rickardp)) — [contributions](https://github.com/eamodio/vscode-gitlens/commits?author=rickardp) - Johannes Rieken ([@jrieken](https://github.com/jrieken)) — [contributions](https://github.com/eamodio/vscode-gitlens/commits?author=jrieken) - Guillaume Rozan ([@rozangu1](https://github.com/rozangu1)) — [contributions](https://github.com/eamodio/vscode-gitlens/commits?author=rozangu1) - ryenus ([@ryenus](https://github.com/ryenus)) — [contributions](https://github.com/eamodio/vscode-gitlens/commits?author=ryenus) diff --git a/package.json b/package.json index 737d697..91f30b6 100644 --- a/package.json +++ b/package.json @@ -1463,10 +1463,10 @@ "markdownDescription": "Specifies user-defined remote (code-hosting) services or custom domains for built-in remote services", "scope": "resource" }, - "gitlens.showWelcomeOrWhatsNew": { + "gitlens.showWelcomeOnInstall": { "type": "boolean", "default": true, - "markdownDescription": "Specifies whether to show the Welcome (Quick Setup) experience on first install, or the What's New notification after upgrading to new feature releases", + "markdownDescription": "Specifies whether to show the Welcome (Quick Setup) experience on first install", "scope": "window" }, "gitlens.showWhatsNewAfterUpgrades": { diff --git a/src/config.ts b/src/config.ts index a948a9b..f01deb9 100644 --- a/src/config.ts +++ b/src/config.ts @@ -108,7 +108,7 @@ export interface Config { modes: Record; outputLevel: TraceLevel; remotes: RemotesConfig[] | null; - showWelcomeOrWhatsNew: boolean; + showWelcomeOnInstall: boolean; showWhatsNewAfterUpgrades: boolean; sortBranchesBy: BranchSorting; sortTagsBy: TagSorting; diff --git a/src/extension.ts b/src/extension.ts index 54566c4..e675b0f 100644 --- a/src/extension.ts +++ b/src/extension.ts @@ -198,7 +198,7 @@ export function notifyOnUnsupportedGitVersion(version: string) { async function showWelcomeOrWhatsNew(version: string, previousVersion: string | undefined) { if (previousVersion == null) { Logger.log('GitLens first-time install'); - if (!Container.config.showWelcomeOrWhatsNew) return; + if (Container.config.showWelcomeOnInstall === false) return; await commands.executeCommand(Commands.ShowWelcomePage); @@ -209,8 +209,6 @@ async function showWelcomeOrWhatsNew(version: string, previousVersion: string | Logger.log(`GitLens upgraded from v${previousVersion} to v${version}`); } - if (!Container.config.showWelcomeOrWhatsNew) return; - const [major, minor] = version.split('.').map(v => parseInt(v, 10)); const [prevMajor, prevMinor] = previousVersion.split('.').map(v => parseInt(v, 10)); if (