feat(codecatalyst): show README.md on first connect #3340

* Show the README.md when connecting to a devenv for the first time.
* Don't do this on Cloud9, because it shows a "third-party content" warning.

Signed-off-by: Nikolas Komonen <[email protected]>

Author: nkomonen-amazon

.changes/next-release/Feature-865fc431-55f8-4156-b3f2-dfdcb898241e.json

@@ -0,0 +1,4 @@
+{
+	"type": "Feature",
+	"description": "CodeCatalyst: show readme on first load of a Dev Environment"
+}

src/codecatalyst/activation.ts

@@ -75,6 +75,8 @@ export async function activate(ctx: ExtContext): Promise<void> {
             return
         }
 
+        await showReadmeFileOnFirstLoad(ctx.extensionContext.workspaceState)
+
         const settings = PromptSettings.instance
         if (await settings.isPromptEnabled('remoteConnected')) {
             const message = localize(
@@ -96,3 +98,39 @@ export async function activate(ctx: ExtContext): Promise<void> {
         authProvider.removeSavedConnection()
     })
 }
+
+async function showReadmeFileOnFirstLoad(workspaceState: vscode.ExtensionContext['workspaceState']): Promise<void> {
+    if (isCloud9()) {
+        return
+    }
+
+    getLogger().info('codecatalyst: showReadmeFileOnFirstLoad()')
+    // Check dev env state to see if this is the first time the user has connected to a dev env
+    const isFirstLoad = workspaceState.get('aws.codecatalyst.devEnv.isFirstLoad', true)
+
+    if (!isFirstLoad) {
+        getLogger().info('codecatalyst: is not first load, skipping showing README.md')
+        return
+    }
+
+    // Determine expected readme file location
+    const readmePath = `README.md`
+
+    // Find readme file in workspace
+    const readmeUri = await vscode.workspace.findFiles(readmePath).then(files => {
+        if (files.length === 0) {
+            return undefined
+        }
+        return files[0]
+    })
+
+    if (readmeUri === undefined) {
+        getLogger().info(`codecatalyst: README.md not found in path '${readmePath}'`)
+        return
+    }
+
+    // Show rendered readme file to user
+    await vscode.commands.executeCommand('markdown.showPreview', readmeUri)
+
+    await workspaceState.update('aws.codecatalyst.devEnv.isFirstLoad', false)
+}