fix: add startup prompt to extension

extensions/vscode/README.md

@@ -16,25 +16,34 @@ provides support for
 
 3.  Open any FTL project with a `ftl-project.toml` or `ftl.toml` file.
 
-4.  The extension will automatically activate and provide support for FTL projects.
+4.  The extension will prompt to start the FTL development server.
 
-> [!IMPORTANT]
-> If you have installed FTL with hermit (or other dependency management tools), you may need to specify the path to the FTL binary in the extension settings.
+## Settings
 
-Example:
+Configure the FTL extension by setting the following options in your Visual Studio Code settings.json:
 
-```json
-{
-  "ftl.executablePath": "bin/ftl"
-}
-```
+- `ftl.executablePath`: Specifies the path to the FTL executable. The default is "ftl", which uses the system's PATH to find the executable.
 
-You can also configure additional command line arguments for the FTL binary in the settings.
+  > [!IMPORTANT]
+  > If you have installed FTL with hermit (or other dependency management tools), you may need to specify the path to the FTL binary in the extension settings.
 
-Example:
+  ```json
+  {
+    "ftl.executablePath": "bin/ftl"`
+  }
+  ```
 
-```json
-{
-  "ftl.devCommandFlags": ["--recreate", "--parallelism=4"]
-}
-```
+- `ftl.devCommandFlags`: Defines flags to pass to the FTL executable when starting the development environment. The default is ["--recreate"].
+
+  ```json
+  {
+    "ftl.devCommandFlags": ["--recreate", "--parallelism=4"]
+  }
+  ```
+
+- `ftl.startClientOption`: Controls if and when to automatically start the FTL development server. Available options are "always" and "never". If not set, the extension will prompt to start the server when opening a FTL project.
+  ```json
+  {
+    "ftl.startClientOption": "always"
+  }
+  ```

extensions/vscode/package.json

@@ -3,7 +3,8 @@
   "displayName": "FTL",
   "publisher": "ftl",
   "description": "VSCode extension for FTL",
-  "version": "0.0.3",
+  "icon": "images/icon.png",
+  "version": "0.0.5",
   "repository": {
     "type": "git",
     "url": "https://github.com/TBD54566975/ftl-vscode"
@@ -36,6 +37,15 @@
             "type": "string"
           },
           "description": "Flags to pass to the FTL executable when starting ftl dev"
+        },
+        "ftl.startClientOption": {
+          "type": "string",
+          "enum": [
+            "always",
+            "never"
+          ],
+          "default": null,
+          "description": "Control if and when to automatically start the FTL client."
         }
       }
     },

extensions/vscode/src/extension.ts

@@ -61,7 +61,7 @@ export async function activate(context: ExtensionContext) {
   statusBarItem.command = "ftl.statusItemClicked"
   statusBarItem.show()
 
-  await startClient(context)
+  await promptStartClient(context)
 
   context.subscriptions.push(
     restartCmd,
@@ -76,6 +76,71 @@ export async function deactivate() {
   await stopClient()
 }
 
+async function FTLPreflightCheck(ftlPath: string) {
+  const ftlRunning = await isFTLRunning(ftlPath)
+  if (ftlRunning) {
+    vscode.window.showErrorMessage(
+      "FTL is already running. Please stop the other instance and restart the service."
+    )
+    return false
+  }
+
+  let version: string
+  try {
+    version = await getFTLVersion(ftlPath)
+  } catch (error: any) {
+    vscode.window.showErrorMessage(`${error.message}`)
+    return false
+  }
+
+  const versionOK = checkMinimumVersion(version, MIN_FTL_VERSION)
+  if (!versionOK) {
+    vscode.window.showErrorMessage(
+      `FTL version ${version} is not supported. Please upgrade to at least ${MIN_FTL_VERSION}.`
+    )
+    return false
+  }
+
+  return true
+}
+
+async function promptStartClient(context: vscode.ExtensionContext): Promise<void> {
+  const configuration = vscode.workspace.getConfiguration('ftl')
+  const startClientOption = configuration.get<string>('startClientOption')
+
+  if (startClientOption === 'always') {
+    await startClient(context)
+    return
+  } else if (startClientOption === 'never') {
+    FTLStatus.disabled(statusBarItem)
+    return
+  }
+
+
+  const options = ['Always', 'Yes', 'No', 'Never']
+  const result = await vscode.window.showInformationMessage(
+    'FTL project detected. Would you like to start the FTL development server?',
+    ...options
+  )
+
+  switch (result) {
+    case 'Always':
+      configuration.update('startClientOption', 'always', vscode.ConfigurationTarget.Global)
+      await startClient(context)
+      break
+    case 'Yes':
+      await startClient(context)
+      break
+    case 'No':
+      FTLStatus.disabled(statusBarItem)
+      break
+    case 'Never':
+      configuration.update('startClientOption', 'never', vscode.ConfigurationTarget.Global)
+      FTLStatus.disabled(statusBarItem)
+      break
+  }
+}
+
 async function startClient(context: ExtensionContext) {
   console.log("Starting client")
 
@@ -150,6 +215,7 @@ async function stopClient() {
   }
   console.log("Disposing client")
 
+  client.diagnostics?.clear()
   if (client["_serverProcess"]) {
     process.kill(client["_serverProcess"].pid, "SIGINT")
   }
@@ -162,31 +228,3 @@ async function stopClient() {
   console.log("Output channel disposed")
   FTLStatus.stopped(statusBarItem)
 }
-
-async function FTLPreflightCheck(ftlPath: string) {
-  const ftlRunning = await isFTLRunning(ftlPath)
-  if (ftlRunning) {
-    vscode.window.showErrorMessage(
-      "FTL is already running. Please stop the other instance and restart the service."
-    )
-    return false
-  }
-
-  let version: string
-  try {
-    version = await getFTLVersion(ftlPath)
-  } catch (error: any) {
-    vscode.window.showErrorMessage(`${error.message}`)
-    return false
-  }
-
-  const versionOK = checkMinimumVersion(version, MIN_FTL_VERSION)
-  if (!versionOK) {
-    vscode.window.showErrorMessage(
-      `FTL version ${version} is not supported. Please upgrade to at least ${MIN_FTL_VERSION}.`
-    )
-    return false
-  }
-
-  return true
-}