feat: add select option for apiLanguage flags

Author: sgollapudi77

src/cli/commands/deploy.ts

@@ -9,15 +9,16 @@ import {
   configureOptions,
   findSWAConfigFile,
   getCurrentSwaCliConfigFromFile,
+  getDefaultVersion,
   isUserOption,
+  isUserOrConfigOption,
   logger,
   logGiHubIssueMessageAndExit,
   matchLoadedConfigName,
   readWorkflowFile,
   updateSwaCliConfigFile,
 } from "../../core";
 import { chooseOrCreateProjectDetails, getStaticSiteDeployment } from "../../core/account";
-import { DEFAULT_DOTNET_ISOLATED_VERSION, DEFAULT_DOTNET_VERSION, DEFAULT_NODE_VERSION, DEFAULT_PYTHON_VERSION } from "../../core/constants";
 import { cleanUp, getDeployClientPath } from "../../core/deploy-client";
 import { swaCLIEnv } from "../../core/env";
 import { addSharedLoginOptionsToCommand, login } from "./login";
@@ -32,8 +33,8 @@ export default function registerCommand(program: Command) {
     .option("-a, --app-location <path>", "the folder containing the source code of the front-end application", DEFAULT_CONFIG.appLocation)
     .option("-i, --api-location <path>", "the folder containing the source code of the API application", DEFAULT_CONFIG.apiLocation)
     .option("-O, --output-location <path>", "the folder containing the built source of the front-end application", DEFAULT_CONFIG.outputLocation)
-    .option("-l, --api-language <apiLanguage>", "the runtime language of the function/api")
-    .option("-v, --api-version <apiVersion>", "the version of the function runtime language")
+    .option("-l, --api-language <apiLanguage>", "the runtime language of the function/api", DEFAULT_CONFIG.apiLanguage)
+    .option("-f, --api-version <apiVersion>", "the version of the function runtime language", DEFAULT_CONFIG.apiVersion)
     .option(
       "-w, --swa-config-location <swaConfigLocation>",
       "the directory where the staticwebapp.config.json file is located",
@@ -138,33 +139,6 @@ export async function deploy(options: SWACLIConfig) {
       logger.log(`  ${chalk.green(resolvedApiLocation)}`);
       logger.log(``);
     }
-    if (!apiLanguage) {
-      apiLanguage = DEFAULT_CONFIG.apiLanguage;
-      apiVersion = DEFAULT_CONFIG.apiVersion;
-      logger.log(`Consider providing api-language and version using --api-language and --api-version flags,
-      otherwise default values apiLanguage: ${apiLanguage} and apiVersion: ${apiVersion} will apply`);
-    } else if (apiLanguage && !apiVersion) {
-      switch (apiLanguage) {
-        case "node":
-          apiVersion = DEFAULT_NODE_VERSION;
-          break;
-        case "python":
-          apiVersion = DEFAULT_PYTHON_VERSION;
-          break;
-        case "dotnet":
-          apiVersion = DEFAULT_DOTNET_VERSION;
-          break;
-        case "dotnetisolated":
-          apiVersion = DEFAULT_DOTNET_ISOLATED_VERSION;
-          break;
-        default:
-          apiLanguage = DEFAULT_CONFIG.apiLanguage;
-          apiVersion = DEFAULT_CONFIG.apiVersion;
-          break;
-      }
-      logger.silly(`Api language "${apiLanguage}" is provided but api version is not provided.
-      Assuming default version "${apiVersion}"`);
-    }
   } else {
     // otherwise, check if the default api folder exists and print a warning
     const apiFolder = await findApiFolderInPath(appLocation);
@@ -177,6 +151,15 @@ export async function deploy(options: SWACLIConfig) {
     }
   }
 
+  if (!isUserOrConfigOption("apiLanguage")) {
+    logger.log(`Consider providing api-language and version using --api-language and --api-version flags,
+    otherwise default values apiLanguage: ${apiLanguage} and apiVersion: ${apiVersion} will apply`);
+  } else if (!isUserOrConfigOption("apiVersion")) {
+    apiVersion = getDefaultVersion(apiLanguage);
+    logger.log(`Api language "${apiLanguage}" is provided but api version is not provided.
+      Assuming default version "${apiVersion}"`);
+  }
+
   // resolve the deployment token
   if (deploymentToken) {
     deploymentToken = deploymentToken;
@@ -362,7 +345,7 @@ export async function deploy(options: SWACLIConfig) {
             else if (line.includes("[31m")) {
               if (line.includes("Cannot deploy to the function app because Function language info isn't provided.")) {
                 line = chalk.red(
-                  `Cannot deploy to the function app because Function language info isn't provided, use flags "--api-language" and "--api-version" or add a "platform.apiRuntime" property to your staticwebapp.config.json file, or create one in ${options.outputLocation!}. Please consult the documentation for more information about staticwebapp.config.json: https://docs.microsoft.com/azure/static-web-apps/configuration`
+                  `Cannot deploy to the function app because Function language info isn't provided, use flags "--api-language" and "--api-version" or add a "platform.apiRuntime" property to your staticwebapp.config.json file, or create one in ${options.outputLocation!}. Please consult the documentation for more information about staticwebapp.config.json: https://learn.microsoft.com/en-us/azure/static-web-apps/build-configuration?tabs=github-actions#skip-building-the-api`
                 );
               }
 

src/cli/commands/init.ts

@@ -2,6 +2,7 @@ import chalk from "chalk";
 import { Command } from "commander";
 import path from "path";
 import process from "process";
+import prompts from "prompts";
 import { promptOrUseDefault } from "../../core/prompts";
 import {
   configureOptions,
@@ -175,7 +176,8 @@ async function promptConfigSettings(disablePrompts: boolean, detectedConfig: Fra
     value = value.trim();
     return value === "" ? undefined : value;
   };
-  const response = await promptOrUseDefault(disablePrompts, [
+
+  let response = await promptOrUseDefault(disablePrompts, [
     {
       type: "text",
       name: "appLocation",
@@ -200,20 +202,6 @@ async function promptConfigSettings(disablePrompts: boolean, detectedConfig: Fra
       initial: detectedConfig.apiLocation,
       format: trimValue,
     },
-    {
-      type: "text",
-      name: "apiLanguage",
-      message: "What's your API language? (optional)",
-      initial: detectedConfig.apiLanguage,
-      format: trimValue,
-    },
-    {
-      type: "text",
-      name: "apiVersion",
-      message: "What's your API version? (optional)",
-      initial: detectedConfig.apiVersion,
-      format: trimValue,
-    },
     {
       type: "text",
       name: "appBuildCommand",
@@ -242,10 +230,85 @@ async function promptConfigSettings(disablePrompts: boolean, detectedConfig: Fra
       initial: detectedConfig.appDevserverUrl,
       format: trimValue,
     },
+    {
+      type: null,
+      name: "apiLanguage",
+    },
+    {
+      type: null,
+      name: "apiVersion",
+    },
   ]);
+
+  if (response.apiLocation) {
+    const apiLanguagePrompt = await prompts([
+      {
+        type: "select",
+        name: "apiLanguage",
+        message: "What's your API language? (optional)",
+        choices: [
+          { title: "Node.js", value: "node" },
+          { title: "Python", value: "python" },
+          { title: "Dotnet", value: "dotnet" },
+          { title: "Dotnet isolated", value: "dotnet-isolated" },
+        ],
+      },
+    ]);
+
+    response.apiLanguage = apiLanguagePrompt.apiLanguage;
+
+    const apiVersionPrompt = await prompts([
+      {
+        type: "select",
+        name: "apiVersion",
+        message: "What's your API version? (optional)",
+        choices: getChoicesForApiLanguage(response.apiLanguage),
+      },
+    ]);
+
+    response.apiVersion = apiVersionPrompt.apiVersion;
+  }
+
   return response;
 }
 
+function getChoicesForApiLanguage(apiLanguage: string) {
+  // Refer to this for functions and versions - https://learn.microsoft.com/en-us/azure/static-web-apps/configuration#selecting-the-api-language-runtime-version
+  let choices = [];
+  switch (apiLanguage) {
+    case "node":
+      choices = [
+        { title: "16", value: "16" },
+        { title: "14", value: "14" },
+        { title: "12", value: "12" },
+      ];
+      break;
+    case "python":
+      choices = [
+        { title: "3.8", value: "3.8" },
+        { title: "3.9", value: "3.9" },
+      ];
+      break;
+    case "dotnet":
+      choices = [
+        { title: "6.0", value: "6.0" },
+        { title: "3.1", value: "3.1" },
+      ];
+      break;
+    case "dotnet-isolated":
+      choices = [{ title: "6.0", value: "6.0" }];
+      break;
+    default:
+      choices = [
+        { title: "16", value: "16" },
+        { title: "14", value: "14" },
+        { title: "12", value: "12" },
+      ];
+      break;
+  }
+  return choices;
+}
+
 function printFrameworkConfig(config: FrameworkConfig) {
   logger.log(chalk.bold("\nDetected configuration for your app:"));
   logger.log(`- Framework(s): ${chalk.green(config.name ?? "none")}`);

src/core/frameworks/detect.ts

@@ -43,8 +43,6 @@ export async function generateConfiguration(app?: DetectedFolder, api?: Detected
       logger.silly(`Built API location "${computedApiLocation}" does not match root API location ${api.rootPath}, which is not supported yet`);
     }
     config.apiLocation = removeTrailingPathSep(api.rootPath);
-    // config.apiLanguage = api.frameworks[0].name; //todo:check if the detected framework is valid or not
-    config.apiVersion = getDefaultVersion(config.apiLanguage);
   }
 
   const appRootPath = app && removeTrailingPathSep(app.rootPath);
@@ -163,7 +161,6 @@ export async function detectFrameworks(projectFiles: string[], frameworks: Frame
       detectedFrameworks.push({ ...framework, rootPaths });
     }
   }
-
   detectedFrameworks = await asyncFilter(
     detectedFrameworks,
     async (framework) => (await matchPackages(framework)) && (await matchContains(framework, projectFiles))
@@ -395,11 +392,12 @@ export function formatDetectedFolders(folders: DetectedFolder[], type: string):
     `- ${folders.map((f) => `${f.rootPath} (${f.frameworks.map((fr) => fr.name).join(", ")})`).join("\n- ")}`
   );
 }
-function getDefaultVersion(apiLanguage: string): string {
+export function getDefaultVersion(apiLanguage: string | undefined): string {
   let apiVersion = "16";
-  apiLanguage = apiLanguage.toLowerCase();
+  if (!apiLanguage) apiLanguage = "node";
+  // apiLanguage = apiLanguage.toLowerCase();
   switch (apiLanguage) {
-    case "node.js":
+    case "node":
       apiVersion = DEFAULT_NODE_VERSION;
       break;
     case "python":
@@ -408,7 +406,7 @@ function getDefaultVersion(apiLanguage: string): string {
     case "dotnet":
       apiVersion = DEFAULT_DOTNET_VERSION;
       break;
-    case "dotnetisolated" || "dotnet isolated":
+    case "dotnetisolated" || "dotnet isolated" || "dotnet-isolated":
       apiVersion = DEFAULT_DOTNET_ISOLATED_VERSION;
       break;
     default:

src/core/frameworks/frameworks.ts

@@ -5,7 +5,8 @@ export const apiFrameworks: FrameworkDefinition[] = [
     files: ["package.json", "host.json"],
     config: {
       apiBuildCommand: "npm run build --if-present",
-      apiLanguage: "",
+      apiLanguage: "node.js",
+      apiVersion: "16",
     },
   },
   {
@@ -25,6 +26,17 @@ export const apiFrameworks: FrameworkDefinition[] = [
     files: ["*.?(csproj|fsproj)", "host.json"],
     config: {
       apiBuildCommand: "dotnet publish -c Release",
+      apiLanguage: "dotnet",
+      apiVersion: "6.0",
+    },
+  },
+  {
+    id: "dotnet-isolated",
+    name: ".NET",
+    files: ["*.?(csproj|fsproj)", "host.json"],
+    config: {
+      apiLanguage: "dotnet-isolated",
+      apiVersion: "6.0",
     },
   },
   {
@@ -33,6 +45,8 @@ export const apiFrameworks: FrameworkDefinition[] = [
     files: ["?(requirements.txt|pyproject.toml|runtime.txt|setup.py)", "host.json"],
     config: {
       // Nothing to setup, but we need to know the apiLocation (rootPath)
+      apiLanguage: "python",
+      apiVersion: "3.9",
     },
   },
 ];