[.github] Update tseslint.configs from recommended to recommendedTypeChecked (#38673)

Author: mikeharder

.github/eslint.config.js

@@ -8,9 +8,19 @@ import tseslint from "typescript-eslint";
 /** @type {import('eslint').Linter.Config[]} */
 export default defineConfig(
   eslint.configs.recommended,
-  tseslint.configs.recommended,
+  tseslint.configs.recommendedTypeChecked,
   {
-    languageOptions: { globals: globals.node },
+    languageOptions: {
+      // we only run in node, not browser
+      globals: globals.node,
+      // required to use tseslint.configs.recommendedTypeChecked
+      parserOptions: {
+        projectService: true,
+        // ensures the tsconfig path resolves relative to this file
+        // default is process.cwd() when running eslint, which may be incorrect
+        tsconfigRootDir: import.meta.dirname,
+      },
+    },
   },
   {
     ignores: ["coverage/**", "shared/coverage/**"],

.github/shared/test/examples.js

@@ -1,6 +1,6 @@
 export const fullGitSha = "abc123abc123abc123abc123abc123abc123abc1";
 
-export const swaggerHandWritten = JSON.stringify("foo");
+export const swaggerHandWritten = JSON.stringify({});
 
 export const swaggerTypeSpecGenerated = JSON.stringify({
   info: {

.github/workflows/src/arm-auto-signoff.js

@@ -1,3 +1,4 @@
+import { inspect } from "util";
 import { CommitStatusState, PER_PAGE_MAX } from "../../shared/src/github.js";
 import { equals } from "../../shared/src/set.js";
 import { byDate, invert } from "../../shared/src/sort.js";
@@ -69,7 +70,7 @@ export async function getLabelActionImpl({ owner, repo, issue_number, head_sha,
     ? labelActions[LabelAction.Remove]
     : labelActions[LabelAction.None];
 
-  core.info(`Labels: ${labelNames}`);
+  core.info(`Labels: ${inspect(labelNames)}`);
 
   // permissions: { actions: read }
   const workflowRuns = await github.paginate(github.rest.actions.listWorkflowRunsForRepo, {
@@ -125,7 +126,9 @@ export async function getLabelActionImpl({ owner, repo, issue_number, head_sha,
         // Continue checking other requirements
       } else {
         // If workflow succeeded, it should have one workflow or the other
-        throw `Workflow artifacts did not contain 'incremental-typespec': ${JSON.stringify(artifactNames)}`;
+        throw new Error(
+          `Workflow artifacts did not contain 'incremental-typespec': ${JSON.stringify(artifactNames)}`,
+        );
       }
     } else {
       core.info(`Workflow '${wfName}' is still in-progress: status='${run.status}'`);
@@ -181,7 +184,7 @@ export async function getLabelActionImpl({ owner, repo, issue_number, head_sha,
       (matchingStatus.state === CommitStatusState.ERROR ||
         matchingStatus.state === CommitStatusState.FAILURE)
     ) {
-      core.info(`Status '${matchingStatus}' did not succeed`);
+      core.info(`Status '${matchingStatus.context}' did not succeed`);
       return removeAction;
     }
 

.github/workflows/src/arm-incremental-typespec.js

@@ -10,6 +10,7 @@ import {
   swagger,
 } from "../../shared/src/changed-files.js";
 import { Readme } from "../../shared/src/readme.js";
+import { Swagger } from "../../shared/src/swagger.js";
 import { CoreLogger } from "./core-logger.js";
 
 // Enable simple-git debug logging to improve console output
@@ -55,19 +56,17 @@ export default async function incrementalTypeSpec({ core }) {
       }
     }
 
-    let swaggerObj;
     try {
-      swaggerObj = JSON.parse(swaggerText);
+      const swagger = new Swagger(file, { content: swaggerText });
+      if (!(await swagger.getTypeSpecGenerated())) {
+        core.info(`File "${file}" does not contain "info.x-typespec-generated"`);
+        return false;
+      }
     } catch {
       // If swagger cannot be parsed as JSON, it's not "incremental typespec"
       core.info(`File "${file}" cannot be parsed as JSON`);
       return false;
     }
-
-    if (!swaggerObj["info"]?.["x-typespec-generated"]) {
-      core.info(`File "${file}" does not contain "info.x-typespec-generated"`);
-      return false;
-    }
   }
 
   /** @type Set<string> */
@@ -142,9 +141,9 @@ export default async function incrementalTypeSpec({ core }) {
     let containsTypeSpecGeneratedSwagger = false;
     // TODO: Add lint rule to prevent using "for...in" instead of "for...of"
     for (const file of specRmSwaggerFilesBaseBranch) {
-      const baseSwagger = await git.show([`HEAD^:${file}`]);
-      const baseSwaggerObj = JSON.parse(baseSwagger);
-      if (baseSwaggerObj["info"]?.["x-typespec-generated"]) {
+      const baseSwaggerContent = await git.show([`HEAD^:${file}`]);
+      const baseSwagger = new Swagger(file, { content: baseSwaggerContent });
+      if (await baseSwagger.getTypeSpecGenerated()) {
         core.info(
           `Spec folder '${changedSpecDir}' in base branch contains typespec-generated swagger: '${file}'`,
         );

.github/workflows/src/avocado-code.js

@@ -1,4 +1,5 @@
 import { readFile } from "fs/promises";
+import { inspect } from "util";
 import {
   generateMarkdownTable,
   MessageLevel,
@@ -29,7 +30,7 @@ export default async function generateJobSummary({ core }) {
   } catch (error) {
     // If we can't read the file, the previous step must have failed catastrophically.
     // generateJobSummary() should never fail, so just log the error and return
-    core.info(`Error reading '${avocadoOutputFile}': ${error}`);
+    core.info(`Error reading '${avocadoOutputFile}': ${inspect(error)}`);
     return;
   }
 
@@ -51,6 +52,6 @@ export default async function generateJobSummary({ core }) {
     core.summary.addRaw(generateMarkdownTable(messages));
   }
 
-  core.summary.write();
+  await core.summary.write();
   core.setOutput("summary", process.env.GITHUB_STEP_SUMMARY);
 }

.github/workflows/src/context.js

@@ -1,3 +1,4 @@
+import { inspect } from "util";
 import { isFullGitSha } from "../../shared/src/git.js";
 import { PER_PAGE_MAX } from "../../shared/src/github.js";
 import { CoreLogger } from "./core-logger.js";
@@ -22,7 +23,15 @@ export async function extractInputs(github, context, core) {
   core.info("extractInputs()");
   core.info(`  eventName: ${context.eventName}`);
   core.info(`  payload.action: ${context.payload.action}`);
-  core.info(`  payload.workflow_run.event: ${context.payload.workflow_run?.event || "undefined"}`);
+
+  let workflowRunEvent = "undefined";
+  if (context.eventName === "workflow_run") {
+    const payload = /** @type {import("@octokit/webhooks-types").WorkflowRunEvent} */ (
+      context.payload
+    );
+    workflowRunEvent = payload.workflow_run?.event;
+  }
+  core.info(`  payload.workflow_run.event: ${workflowRunEvent}`);
 
   // Log full context when debug is enabled.  Most workflows should be idempotent and can be re-run
   // with debug enabled to replay the previous context.
@@ -164,7 +173,7 @@ export async function extractInputs(github, context, core) {
           core.info(`Error: ${error instanceof Error ? error.message : "unknown"}`);
 
           // Long message only in debug
-          core.debug(`Error: ${error}`);
+          core.debug(`Error: ${inspect(error)}`);
         }
 
         if (pullRequests.length === 0) {
@@ -270,10 +279,10 @@ export async function extractInputs(github, context, core) {
       run_id: payload.workflow_run.id,
     };
   } else if (context.eventName === "check_run") {
-    let checkRun = context.payload.check_run;
     const payload = /** @type {import("@octokit/webhooks-types").CheckRunEvent} */ (
       context.payload
     );
+    const checkRun = payload.check_run;
     const repositoryInfo = getRepositoryInfo(payload.repository);
     inputs = {
       owner: repositoryInfo.owner,

.github/workflows/src/doc-preview.js

@@ -1,3 +1,5 @@
+import { inspect } from "util";
+
 const DOCS_NAMESPACE = "_swagger_specs";
 const SPEC_FILE_REGEX =
   "(specification/)+(.*)/(resourcemanager|resource-manager|dataplane|data-plane|control-plane)/(.*)/(preview|stable|privatepreview)/(.*?)/(example)?(.*)";
@@ -141,7 +143,7 @@ export function getSwaggersToProcess(swaggerFiles) {
       const parsed = parseSwaggerFilePath(file);
       swaggerFileObjs.push(parsed);
     } catch (error) {
-      console.log(`Skipping file "${file}" due to parsing error: ${error}`);
+      console.log(`Skipping file "${file}" due to parsing error: ${inspect(error)}`);
       continue;
     }
   }

.github/workflows/src/github-test.js

@@ -30,7 +30,7 @@ export default async function importAllModules({ core }) {
     const fileUrl = pathToFileURL(fullPath).href;
 
     // if import fails, throws error which causes step to fail
-    const module = await import(fileUrl);
+    const module = /** @type {unknown} */ (await import(fileUrl));
 
     core.info(inspect(module));
     core.info("");

.github/workflows/src/github.js

@@ -1,3 +1,4 @@
+import { inspect } from "util";
 import { toPercent } from "../../shared/src/math.js";
 import { Duration, formatDuration, getDuration, subtract } from "../../shared/src/time.js";
 
@@ -18,7 +19,7 @@ export async function writeToActionsSummary(content, core) {
     await core.summary.addRaw(content).write();
     core.info("Successfully wrote to the GitHub Actions summary");
   } catch (error) {
-    throw new Error(`Failed to write to the GitHub Actions summary: ${error}`);
+    throw new Error(`Failed to write to the GitHub Actions summary: ${inspect(error)}`);
   }
 }
 
@@ -33,8 +34,9 @@ export function createLogHook(endpoint, logger) {
    */
   function logHook(options) {
     const request = endpoint(options);
-    const { method, url, body } = request;
-    logger.info(`[github] ${method.toUpperCase()} ${url} ${body ? JSON.stringify(body) : ""}`);
+    logger.info(
+      `[github] ${request.method.toUpperCase()} ${request.url} ${request.body ? JSON.stringify(request.body) : ""}`,
+    );
   }
 
   return logHook;

.github/workflows/src/issues.js

@@ -1,3 +1,5 @@
+import { inspect } from "util";
+
 /**
  * Retrieves the PR number associated with a specific commit SHA
  * @param {import('@actions/github-script').AsyncFunctionArguments["github"]} github - GitHub API client
@@ -38,7 +40,7 @@ export async function getIssueNumber(github, head_sha, logger) {
       logger?.info(`No open PRs found for commit ${head_sha}`);
     }
   } catch (error) {
-    logger?.error(`Error searching for PRs with commit ${head_sha}: ${error}`);
+    logger?.error(`Error searching for PRs with commit ${head_sha}: ${inspect(error)}`);
     throw error;
   }