build: introduce "packageAlpha" task

- `npm run packageAlpha` creates an artifact that can be delivered to
  users for testing alpha builds. It creates artifact:
  aws-toolkit-vscode-1.99.0-SNAPSHOT.vsix
- Show a warning message on startup if the extension version is such an
  alpha artifact.

Author: justinmk3

.gitignore

@@ -10,6 +10,7 @@ telemetryCache
 quickStart.html
 .gitcommit
 media/libs/
+package.json.bk
 
 # Auto generated definitions
 src/**/*.gen.ts

CONTRIBUTING.md

@@ -32,8 +32,22 @@ When you launch the extension or run tests from Visual Studio Code, it will auto
 
 If you prefer, you can build from the command line:
 
--   To build one time: `npm run compile`
--   To build and watch for file changes: `npm run watch`
+-   To build one time:
+    ```
+    npm run compile
+    ```
+-   To build and watch for file changes:
+    ```
+    npm run watch
+    ```
+-   To build a release artifact:
+    ```
+    npm run package
+    ```
+-   To build an "alpha" artifact (useful for letting others test a particular build):
+    ```
+    npm run packageAlpha
+    ```
 
 #### If you run out of memory while building
 

package.json

@@ -851,6 +851,7 @@
         "lint": "eslint -c .eslintrc.js --ext .ts .",
         "lintfix": "eslint -c .eslintrc.js --fix --ext .ts .",
         "package": "vsce package",
+        "packageAlpha": "sed -i .bk 's/\\(    \"version\":\\) .*/\\1 \"1.99.0-SNAPSHOT\",/' package.json && vsce package && mv package.json.bk package.json",
         "install-plugin": "vsce package -o aws-toolkit-vscode-test.vsix && code --install-extension aws-toolkit-vscode-test.vsix",
         "generateTelemetry": "node node_modules/@aws-toolkits/telemetry/lib/generateTelemetry.js --extraInput=src/shared/telemetry/vscodeTelemetry.json --output=src/shared/telemetry/telemetry.gen.ts",
         "generateConfigurationAttributes": "ts-node ./build-scripts/generateConfigurationAttributes.ts",

package.nls.json

@@ -3,6 +3,7 @@
     "AWS.title.createCredentialProfile": "Create a new AWS credential profile",
     "AWS.title.creatingCredentialProfile": "Saving new credential profile {0}",
     "AWS.title.selectCredentialProfile": "Select an AWS credential profile",
+    "AWS.startup.toastIfAlpha": "AWS Toolkit PREVIEW. (To get the latest STABLE version, uninstall this version.)",
     "AWS.cdk.explorerTitle": "AWS CDK Explorer (Preview)",
     "Aws.cdk.explorerNode.noApps": "[No CDK Apps found in Workspaces]",
     "Aws.cdk.explorerNode.app.noConstructTree": "[Unable to load construct tree for this App. Run `cdk synth`]",

src/extension.ts

@@ -33,7 +33,7 @@ import {
     aboutToolkit,
     getToolkitEnvironmentDetails,
     showQuickStartWebview,
-    toastNewUser,
+    showWelcomeMessage,
 } from './shared/extensionUtilities'
 import { getLogger, Logger } from './shared/logger'
 import { activate as activateLogger } from './shared/logger/activation'
@@ -194,7 +194,7 @@ export async function activate(context: vscode.ExtensionContext) {
             await activateStepFunctions(context, awsContext, toolkitOutputChannel)
         })
 
-        toastNewUser(context)
+        showWelcomeMessage(context)
 
         await loginWithMostRecentCredentials(toolkitSettings, loginManager)
 

src/shared/extensionUtilities.ts

@@ -12,6 +12,7 @@ import { ext } from '../shared/extensionGlobals'
 import { mostRecentVersionKey, pluginVersion } from './constants'
 import { readFileAsString } from './filesystemUtilities'
 import { getLogger } from './logger'
+import { VSCODE_EXTENSION_ID, EXTENSION_ALPHA_VERSION } from './extensions'
 
 const localize = nls.loadMessageBundle()
 
@@ -156,9 +157,9 @@ export function setMostRecentVersion(context: vscode.ExtensionContext): void {
 }
 
 /**
- * Publishes a toast with a link to the welcome page
+ * Shows a message with a link to the quickstart page.
  */
-async function promptQuickStart(): Promise<void> {
+async function showQuickstartPrompt(): Promise<void> {
     const view = localize('AWS.command.quickStart', 'View Quick Start')
     const prompt = await vscode.window.showInformationMessage(
         localize(
@@ -174,18 +175,33 @@ async function promptQuickStart(): Promise<void> {
 }
 
 /**
- * Checks if a user is new to this version
- * If so, pops a toast with a link to a quick start page
+ * Shows a "new version" or "alpha version" message.
+ *
+ * - If extension version is "alpha", shows a warning message.
+ * - If extension version was not previously run on this machine, shows a toast
+ *   with a link to the quickstart page.
+ * - Otherwise does nothing.
  *
  * @param context VS Code Extension Context
  */
-export function toastNewUser(context: vscode.ExtensionContext): void {
+export function showWelcomeMessage(context: vscode.ExtensionContext): void {
+    const version = vscode.extensions.getExtension(VSCODE_EXTENSION_ID.awstoolkit)?.packageJSON.version
+    if (version === EXTENSION_ALPHA_VERSION) {
+        vscode.window.showWarningMessage(
+            localize(
+                'AWS.startup.toastIfAlpha',
+                'AWS Toolkit PREVIEW. (To get the latest STABLE version, uninstall this version.)'
+            )
+        )
+        return
+    }
+
     try {
         if (isDifferentVersion(context)) {
             setMostRecentVersion(context)
             // the welcome toast should be nonblocking.
             // tslint:disable-next-line: no-floating-promises
-            promptQuickStart()
+            showQuickstartPrompt()
         }
     } catch (err) {
         // swallow error and don't block extension load

src/shared/extensions.ts

@@ -7,3 +7,8 @@ export const VSCODE_EXTENSION_ID = {
     awstoolkit: 'amazonwebservices.aws-toolkit-vscode',
     python: 'ms-python.python',
 }
+
+/**
+ * Version of the .vsix produced by the `packageAlpha` script.
+ */
+export const EXTENSION_ALPHA_VERSION = '1.99.0-SNAPSHOT'