refactor: format warning message

Author: manekinekko

src/cli/commands/start.ts

@@ -86,11 +86,12 @@ export async function start(startContext: string, options: SWACLIConfig) {
       userWorkflowConfig,
     });
   } catch (err) {
-    logger.warn(`Error reading workflow configuration:`);
-    logger.warn((err as any).message);
-    logger.warn(``);
+    logger.warn(``, "swa");
+    logger.warn(`Error reading workflow configuration:`, "swa");
+    logger.warn((err as any).message, "swa");
     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.`,
+      "swa"
     );
   }
 

src/core/utils/workflow-config.spec.ts

@@ -29,25 +29,25 @@ describe("readWorkflowFile()", () => {
   });
 
   describe("checking workflow properties", () => {
-    it("missing property 'jobs' should throw", () => {
+    it(`missing property "jobs" should throw`, () => {
       mockFs({
         ".github/workflows/azure-static-web-apps__not-valid.yml": `name: Azure Static Web Apps CI/CD`,
       });
 
-      expect(() => readWorkflowFile()).toThrow(/missing property 'jobs'/);
+      expect(() => readWorkflowFile()).toThrow(/missing property "jobs"/);
     });
 
-    it("missing property 'jobs.build_and_deploy_job' should throw", () => {
+    it(`missing property "jobs.build_and_deploy_job" should throw`, () => {
       mockFs({
         ".github/workflows/azure-static-web-apps.yml": `
 jobs:
   invalid_property:
 `,
       });
-      expect(() => readWorkflowFile()).toThrow(/missing property 'jobs.build_and_deploy_job'/);
+      expect(() => readWorkflowFile()).toThrow(/missing property "jobs.build_and_deploy_job"/);
     });
 
-    it("missing property 'jobs.build_and_deploy_job.steps' should throw", () => {
+    it(`missing property "jobs.build_and_deploy_job.steps" should throw`, () => {
       mockFs({
         ".github/workflows/azure-static-web-apps.yml": `
 jobs:
@@ -56,21 +56,21 @@ jobs:
 `,
       });
 
-      expect(() => readWorkflowFile()).toThrow(/missing property 'jobs.build_and_deploy_job.steps'/);
+      expect(() => readWorkflowFile()).toThrow(/missing property "jobs.build_and_deploy_job.steps"/);
     });
 
-    it("invalid property 'jobs.build_and_deploy_job.steps' should throw", () => {
+    it(`invalid property"jobs.build_and_deploy_job.steps" should throw`, () => {
       mockFs({
         ".github/workflows/azure-static-web-apps.yml": `
 jobs:
   build_and_deploy_job:
     steps:
 `,
       });
-      expect(() => readWorkflowFile()).toThrow(/missing property 'jobs.build_and_deploy_job.steps'/);
+      expect(() => readWorkflowFile()).toThrow(/missing property "jobs.build_and_deploy_job.steps"/);
     });
 
-    it("invalid property 'jobs.build_and_deploy_job.steps[]' should throw", () => {
+    it(`invalid property "jobs.build_and_deploy_job.steps[]" should throw`, () => {
       mockFs({
         ".github/workflows/azure-static-web-apps.yml": `
 jobs:
@@ -80,10 +80,10 @@ jobs:
 `,
       });
 
-      expect(() => readWorkflowFile()).toThrow(/invalid property 'jobs.build_and_deploy_job.steps\[\]'/);
+      expect(() => readWorkflowFile()).toThrow(/invalid property "jobs.build_and_deploy_job.steps\[\]"/);
     });
 
-    it("missing property 'jobs.build_and_deploy_job.steps[].with' should throw", () => {
+    it(`missing property "jobs.build_and_deploy_job.steps[].with" should throw`, () => {
       mockFs({
         ".github/workflows/azure-static-web-apps.yml": `
 jobs:
@@ -94,7 +94,7 @@ jobs:
 `,
       });
 
-      expect(() => readWorkflowFile()).toThrow(/missing property 'jobs.build_and_deploy_job.steps\[\].with'/);
+      expect(() => readWorkflowFile()).toThrow(/missing property "jobs.build_and_deploy_job.steps\[\].with"/);
     });
   });
 

src/core/utils/workflow-config.ts

@@ -60,38 +60,30 @@ export function readWorkflowFile({ userWorkflowConfig }: { userWorkflowConfig?:
   const swaYaml = YAML.parse(githubActionContent);
 
   if (!swaYaml) {
-    throw Error(`could not parse the SWA workflow file "${githubActionFile}". Make sure it's a valid YAML file`);
+    throw Error(`could not parse the SWA workflow file "${githubActionFile}".`);
   }
 
   if (!swaYaml.jobs) {
-    throw Error(`missing property 'jobs' in the SWA workflow file "${githubActionFile}". Make sure it's a valid SWA workflow file`);
+    throw Error(`missing property "jobs" in the SWA workflow file "${githubActionFile}".`);
   }
 
   if (!swaYaml.jobs.build_and_deploy_job) {
-    throw Error(
-      `missing property 'jobs.build_and_deploy_job' in the SWA workflow file "${githubActionFile}". Make sure it's a valid SWA workflow file.`
-    );
+    throw Error(`missing property "jobs.build_and_deploy_job" in the SWA workflow file "${githubActionFile}".`);
   }
 
   if (!swaYaml.jobs.build_and_deploy_job.steps) {
-    throw Error(
-      `missing property 'jobs.build_and_deploy_job.steps' in the SWA workflow file "${githubActionFile}". Make sure it's a valid SWA workflow file.`
-    );
+    throw Error(`missing property "jobs.build_and_deploy_job.steps" in the SWA workflow file "${githubActionFile}".`);
   }
 
   // hacking this to have an `any` on the type in .find, mainly because a typescript definition for the YAML file is painful...
   const swaBuildConfig = swaYaml.jobs.build_and_deploy_job.steps.find((step: any) => step.uses && step.uses.includes("static-web-apps-deploy"));
 
   if (!swaBuildConfig) {
-    throw Error(
-      `invalid property 'jobs.build_and_deploy_job.steps[]' in the SWA workflow file "${githubActionFile}". Make sure it's a valid SWA workflow file.`
-    );
+    throw Error(`invalid property "jobs.build_and_deploy_job.steps[]" in the SWA workflow file "${githubActionFile}".`);
   }
 
   if (!swaBuildConfig.with) {
-    throw Error(
-      `missing property 'jobs.build_and_deploy_job.steps[].with' in the SWA workflow file "${githubActionFile}". Make sure it's a valid SWA workflow file.`
-    );
+    throw Error(`missing property "jobs.build_and_deploy_job.steps[].with" in the SWA workflow file "${githubActionFile}".`);
   }
 
   // extract the user's config and set defaults