fix: ci-deploy import attributes

Author: Adrian Hall

package-lock.json

@@ -88,7 +88,7 @@
     "husky": "^4.3.8",
     "lint-staged": "^12.4.1",
     "memfs": "^4.9.3",
-    "prettier": "2.6.2",
+    "prettier": "3.3.2",
     "semantic-release": "^22.0.12",
     "start-server-and-test": "^2.0.4",
     "supertest": "^6.3.4",

package.json

@@ -6,7 +6,7 @@ import * as accountModule from "../../../core/account.js";
 import * as deployClientModule from "../../../core/deploy-client.js";
 import { deploy } from "./deploy.js";
 import * as loginModule from "../login/login.js";
-import pkg from "../../../../package.json";
+import pkg from "../../../../package.json" with { type: "json" };
 
 vi.mock("../../../core/utils/logger", () => {
   return {
@@ -97,7 +97,7 @@ describe("deploy", () => {
     expect(logger.error).toHaveBeenNthCalledWith(
       2,
       "Provide a deployment token using the --deployment-token option or SWA_CLI_DEPLOYMENT_TOKEN environment variable",
-      true
+      true,
     );
 
     expect(deployClientModule.getDeployClientPath).not.toBeCalled();

src/cli/commands/deploy/deploy.spec.ts

@@ -14,7 +14,7 @@ import { cleanUp, getDeployClientPath } from "../../../core/deploy-client.js";
 import { swaCLIEnv } from "../../../core/env.js";
 import { getDefaultVersion } from "../../../core/functions-versions.js";
 import { login } from "../login/login.js";
-import packageInfo from "../../../../package.json";
+import packageInfo from "../../../../package.json" with { type: "json" };
 
 export async function deploy(options: SWACLIConfig) {
   const { SWA_CLI_DEPLOYMENT_TOKEN, SWA_CLI_DEBUG } = swaCLIEnv();
@@ -94,7 +94,7 @@ export async function deploy(options: SWACLIConfig) {
       logger.warn(
         `An API folder was found at ".${
           path.sep + path.basename(apiFolder)
-        }" but the --api-location option was not provided. The API will not be deployed.\n`
+        }" but the --api-location option was not provided. The API will not be deployed.\n`,
       );
     }
   }
@@ -152,7 +152,7 @@ export async function deploy(options: SWACLIConfig) {
         credentialChain,
         subscriptionId,
         resourceGroup as string,
-        staticSiteName as string
+        staticSiteName as string,
       );
 
       deploymentToken = deploymentTokenResponse?.properties?.apiKey;
@@ -212,7 +212,7 @@ export async function deploy(options: SWACLIConfig) {
     logger.warn(`Error reading workflow configuration:`);
     logger.warn((err as any).message);
     logger.warn(
-      `See https://docs.microsoft.com/azure/static-web-apps/build-configuration?tabs=github-actions#build-configuration for more information.`
+      `See https://docs.microsoft.com/azure/static-web-apps/build-configuration?tabs=github-actions#build-configuration for more information.`,
     );
   }
 
@@ -298,7 +298,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://learn.microsoft.com/azure/static-web-apps/build-configuration?tabs=github-actions#skip-building-the-api`
+                  `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/azure/static-web-apps/build-configuration?tabs=github-actions#skip-building-the-api`,
                 );
               }
 
@@ -331,7 +331,7 @@ export async function deploy(options: SWACLIConfig) {
     logger.error("Deployment Failed :(");
     logger.error(`Deployment Failure Reason: ${(error as any).message}`);
     logger.error(
-      `For further information, please visit the Azure Static Web Apps documentation at https://docs.microsoft.com/azure/static-web-apps/`
+      `For further information, please visit the Azure Static Web Apps documentation at https://docs.microsoft.com/azure/static-web-apps/`,
     );
     logGitHubIssueMessageAndExit();
   } finally {

src/cli/commands/deploy/deploy.ts

@@ -16,7 +16,7 @@ import { DATA_API_BUILDER_BINARY_NAME, DATA_API_BUILDER_DEFAULT_CONFIG_FILE_NAME
 import { getDataApiBuilderBinaryPath } from "../../../core/dataApiBuilder/index.js";
 import { swaCLIEnv } from "../../../core/env.js";
 import { getCertificate } from "../../../core/ssl.js";
-import packageInfo from "../../../../package.json";
+import packageInfo from "../../../../package.json" with { type: "json" };
 
 import { createRequire } from "node:module";
 const require = createRequire(import.meta.url);
@@ -153,7 +153,7 @@ export async function start(options: SWACLIConfig) {
     logger.warn(`Error reading workflow configuration:`);
     logger.warn((err as any).message);
     logger.warn(
-      `See https://docs.microsoft.com/azure/static-web-apps/build-configuration?tabs=github-actions#build-configuration for more information.`
+      `See https://docs.microsoft.com/azure/static-web-apps/build-configuration?tabs=github-actions#build-configuration for more information.`,
     );
   }
 
@@ -186,7 +186,7 @@ export async function start(options: SWACLIConfig) {
       } else {
         if (isCoreToolsVersionCompatible(targetVersion, nodeMajorVersion) === false) {
           logger.error(
-            `Found Azure Functions Core Tools v${targetVersion} which is incompatible with your current Node.js v${process.versions.node}.`
+            `Found Azure Functions Core Tools v${targetVersion} which is incompatible with your current Node.js v${process.versions.node}.`,
           );
           logger.error("See https://aka.ms/functions-node-versions for more information.");
           process.exit(1);
@@ -214,7 +214,7 @@ export async function start(options: SWACLIConfig) {
           `Could not find or install ${DATA_API_BUILDER_BINARY_NAME} binary.
         If you already have data-api-builder installed, try connecting using --data-api-devserver-url by
         starting data-api-builder engine separately. Exiting!!`,
-          true
+          true,
         );
       } else {
         serveDataApiCommand = `cd "${dataApiLocation}" && "${dataApiBinary}" start -c ${DATA_API_BUILDER_DEFAULT_CONFIG_FILE_NAME} --no-https-redirect`;
@@ -314,7 +314,7 @@ export async function start(options: SWACLIConfig) {
   if (isApiLocationExistsOnDisk) {
     concurrentlyCommands.push(
       // serve the api, if it's available
-      { command: serveApiCommand, name: "api", env, prefixColor: "gray.dim" }
+      { command: serveApiCommand, name: "api", env, prefixColor: "gray.dim" },
     );
   }
 
@@ -372,7 +372,7 @@ export async function start(options: SWACLIConfig) {
             break;
         }
         logger.error(`SWA emulator stopped because ${commandMessage}.`, true);
-      }
+      },
     )
     .catch((err: Error) => {
       logger.error(err.message, true);

src/cli/commands/start/start.ts

@@ -1,7 +1,7 @@
 import { fs, vol } from "memfs";
 import { program } from "commander";
 import { run } from "./index.js";
-import pkg from "../../package.json";
+import pkg from "../../package.json" with { type: "json" };
 import * as builder from "./commands/build/build.js";
 
 vi.mock("node:fs");

src/cli/index.spec.ts

@@ -20,7 +20,7 @@ import { default as registerBuild } from "./commands/build/register.js";
 import { registerDocs } from "./commands/docs.js";
 import { default as registerDb } from "./commands/db/init/register.js";
 import { promptOrUseDefault } from "../core/prompts.js";
-import pkg from "../../package.json";
+import pkg from "../../package.json" with { type: "json" };
 
 function printWelcomeMessage(argv?: string[]) {
   const args = argv?.slice(2) || [];
@@ -62,7 +62,7 @@ export async function run(argv?: string[]) {
     .addOption(
       new Option("-V, --verbose [prefix]", "enable verbose output. Values are: silly,info,log,silent")
         .preset(DEFAULT_CONFIG.verbose)
-        .default(DEFAULT_CONFIG.verbose)
+        .default(DEFAULT_CONFIG.verbose),
     )
     .option("-c, --config <path>", "path to swa-cli.config.json file to use", path.relative(process.cwd(), swaCliConfigFilename))
     .option("-cn, --config-name <name>", "name of the configuration to use", undefined)
@@ -78,7 +78,7 @@ export async function run(argv?: string[]) {
 
   Documentation:
     https://aka.ms/swa/cli-local-development
-  `
+  `,
     );
 
   // Register commands

src/cli/index.ts

@@ -2,7 +2,7 @@ import { Draft04, Draft, JsonError } from "json-schema-library";
 import { promises as fs } from "node:fs";
 import chalk from "chalk";
 import { logger } from "./logger.js";
-import configSchema from "../../../schema/staticwebapp.config.json";
+import configSchema from "../../../schema/staticwebapp.config.json" with { type: "json" };
 
 /**
  * Loads JSON from the designated file path, printing any JSON errors to the console.

src/core/utils/json.ts

@@ -1,5 +1,5 @@
 import updateNotifier from "update-notifier";
-import pkg from "../../../package.json";
+import pkg from "../../../package.json" with { type: "json" };
 
 export function notifyOnUpdate() {
   updateNotifier({ pkg }).notify();

src/core/utils/update-notifier.ts

@@ -1,8 +1,8 @@
 {
   "compilerOptions": {
-    "target": "ES2022",
-    "module": "Node16", // ESM Module resolution
-    "moduleResolution": "Node16", // ESM module resolution
+    "target": "ESNext",
+    "module": "NodeNext", // ESM Module resolution
+    "moduleResolution": "NodeNext", // ESM module resolution
     "declaration": true,
     "declarationMap": true,
     "sourceMap": true,