Merge pull request #4111 from github/robertbrignull/typescript-eslint/restrict-template-expressions

Enable the @typescript-eslint/restrict-template-expressions rule

Author: robertbrignull

extensions/ql-vscode/eslint.config.mjs

@@ -69,7 +69,6 @@ export default tseslint.config(
 
       // Rules disabled during eslint 9 migration
       "github/filenames-match-regex": "off",
-      "@typescript-eslint/restrict-template-expressions": "off",
       "@typescript-eslint/no-unsafe-assignment": "off",
       "@typescript-eslint/no-unsafe-argument": "off",
       "@typescript-eslint/no-unsafe-member-access": "off",

extensions/ql-vscode/src/codeql-cli/cli.ts

@@ -314,7 +314,7 @@ export class CodeQLCliServer implements Disposable {
       } catch (e) {
         // We are probably fine here, the process has already closed stdin.
         void this.logger.log(
-          `Shutdown request failed: process stdin may have already closed. The error was ${e}`,
+          `Shutdown request failed: process stdin may have already closed. The error was ${getErrorMessage(e)}`,
         );
         void this.logger.log("Stopping the process anyway.");
       }
@@ -748,7 +748,7 @@ export class CodeQLCliServer implements Disposable {
           } else {
             reject(
               new Error(
-                `${command} ${commandArgs.join(" ")} failed with code ${code}`,
+                `${command.join(" ")} ${commandArgs.join(" ")} failed with code ${code}`,
               ),
             );
           }

extensions/ql-vscode/src/codeql-cli/distribution.ts

@@ -385,7 +385,7 @@ class ExtensionSpecificDistributionManager {
       } catch (e) {
         void extLogger.log(
           "WARNING: Tried to remove corrupted CodeQL CLI at " +
-            `${this.getDistributionStoragePath()} but encountered an error: ${e}.`,
+            `${this.getDistributionStoragePath()} but encountered an error: ${getErrorMessage(e)}.`,
         );
       }
     }
@@ -457,7 +457,7 @@ class ExtensionSpecificDistributionManager {
     } catch (e) {
       void extLogger.log(
         `Tried to clean up old version of CLI at ${this.getDistributionStoragePath()} ` +
-          `but encountered an error: ${e}.`,
+          `but encountered an error: ${getErrorMessage(e)}.`,
       );
     }
 

extensions/ql-vscode/src/codeql-cli/query-language.ts

@@ -89,7 +89,7 @@ export async function askForLanguage(
   if (!isQueryLanguage(language)) {
     void showAndLogErrorMessage(
       extLogger,
-      `Language '${language}' is not supported. Only languages ${Object.values(
+      `Language '${language as string}' is not supported. Only languages ${Object.values(
         QueryLanguage,
       ).join(", ")} are supported.`,
     );

extensions/ql-vscode/src/codeql-cli/query-metadata.ts

@@ -1,6 +1,7 @@
 import type { CodeQLCliServer } from "./cli";
 import type { QueryMetadata } from "../common/interface-types";
 import { extLogger } from "../common/logging/vscode";
+import { getErrorMessage } from "../common/helpers-pure";
 
 /**
  * Gets metadata for a query, if it exists.
@@ -16,7 +17,9 @@ export async function tryGetQueryMetadata(
     return await cliServer.resolveMetadata(queryPath);
   } catch (e) {
     // Ignore errors and provide no metadata.
-    void extLogger.log(`Couldn't resolve metadata for ${queryPath}: ${e}`);
+    void extLogger.log(
+      `Couldn't resolve metadata for ${queryPath}: ${getErrorMessage(e)}`,
+    );
     return;
   }
 }

extensions/ql-vscode/src/common/short-paths.ts

@@ -92,12 +92,12 @@ async function expandShortPathComponent(
         }
       } catch (e) {
         // Can't read stats for the child, so skip it.
-        void logger.log(`Error reading stats for child: ${e}`);
+        void logger.log(`Error reading stats for child: ${getErrorMessage(e)}`);
       }
     }
   } catch (e) {
     // Can't read the directory, so we won't be able to find this in the directory listing.
-    void logger.log(`Error reading directory: ${e}`);
+    void logger.log(`Error reading directory: ${getErrorMessage(e)}`);
     return shortBase;
   }
 

extensions/ql-vscode/src/common/vscode/archive-filesystem-provider.ts

@@ -135,7 +135,7 @@ const sourceArchiveUriAuthorityPattern = /^(\d+)-(\d+)$/;
 class InvalidSourceArchiveUriError extends Error {
   constructor(uri: Uri) {
     super(
-      `Can't decode uri ${uri}: authority should be of the form startIndex-endIndex (where both indices are integers).`,
+      `Can't decode uri ${uri.toString()}: authority should be of the form startIndex-endIndex (where both indices are integers).`,
     );
   }
 }

extensions/ql-vscode/src/common/vscode/webview-html.ts

@@ -89,7 +89,7 @@ export function getHtmlForWebview(
   <body>
     <div id=root data-view="${view}">
     </div>
-      <script nonce="${nonce}" src="${scriptWebviewUri}">
+      <script nonce="${nonce}" src="${scriptWebviewUri.toString()}">
     </script>
   </body>
 </html>`;
@@ -101,9 +101,9 @@ function getNonce(): string {
 }
 
 function createStylesLinkWithNonce(nonce: string, uri: Uri): string {
-  return `<link nonce="${nonce}" rel="stylesheet" href="${uri}">`;
+  return `<link nonce="${nonce}" rel="stylesheet" href="${uri.toString()}">`;
 }
 
 function createStylesLinkWithoutNonce(uri: Uri): string {
-  return `<link rel="stylesheet" href="${uri}">`;
+  return `<link rel="stylesheet" href="${uri.toString()}">`;
 }

extensions/ql-vscode/src/databases/local-databases-ui.ts

@@ -380,7 +380,7 @@ export class DatabaseUI extends DisposableObject {
             // This specifically refers to the database folder in
             // https://github.com/github/codespaces-codeql
             const uri = Uri.parse(
-              `${workspace.workspaceFolders[0].uri}/.tours/codeql-tutorial-database`,
+              `${workspace.workspaceFolders[0].uri.toString()}/.tours/codeql-tutorial-database`,
             );
 
             const databaseItem = this.databaseManager.findDatabaseItem(uri);
@@ -1062,14 +1062,14 @@ export class DatabaseUI extends DisposableObject {
 
       if (!validFileTypes.includes(entry[1])) {
         void this.app.logger.log(
-          `Skipping import for '${entry}', invalid file type: ${entry[1]}`,
+          `Skipping import for '${entry[0]}', invalid file type: ${entry[1]}`,
         );
         continue;
       }
 
       try {
         const databaseUri = Uri.joinPath(uri, entry[0]);
-        void this.app.logger.log(`Importing from ${databaseUri}`);
+        void this.app.logger.log(`Importing from ${databaseUri.toString()}`);
 
         const database = await this.importDatabase(
           databaseUri,

extensions/ql-vscode/src/databases/local-databases/database-manager.ts

@@ -64,12 +64,13 @@ const DB_LIST = "databaseList";
  */
 function eventFired<T>(
   event: vscode.Event<T>,
+  eventName: string,
   timeoutMs = 1000,
 ): Promise<T | undefined> {
   return new Promise((res, _rej) => {
     const timeout = setTimeout(() => {
       void extLogger.log(
-        `Waiting for event ${event} timed out after ${timeoutMs}ms`,
+        `Waiting for event '${eventName}' timed out after ${timeoutMs}ms`,
       );
       res(undefined);
       dispose();
@@ -256,7 +257,7 @@ export class DatabaseManager extends DisposableObject {
   private async reimportTestDatabase(databaseUri: vscode.Uri): Promise<void> {
     const dbItem = this.findDatabaseItem(databaseUri);
     if (dbItem === undefined || dbItem.origin?.type !== "testproj") {
-      throw new Error(`Database ${databaseUri} is not a testproj.`);
+      throw new Error(`Database ${databaseUri.toString()} is not a testproj.`);
     }
 
     await this.removeDatabaseItem(dbItem);
@@ -474,7 +475,10 @@ export class DatabaseManager extends DisposableObject {
       });
       // vscode api documentation says we must to wait for this event
       // between multiple `updateWorkspaceFolders` calls.
-      await eventFired(vscode.workspace.onDidChangeWorkspaceFolders);
+      await eventFired(
+        vscode.workspace.onDidChangeWorkspaceFolders,
+        "vscode.workspace.onDidChangeWorkspaceFolders",
+      );
     }
   }
 
@@ -561,7 +565,7 @@ export class DatabaseManager extends DisposableObject {
             // When loading from persisted state, leave invalid databases in the list. They will be
             // marked as invalid, and cannot be set as the current database.
             void this.logger.log(
-              `Error loading database ${database.uri}: ${e}.`,
+              `Error loading database ${database.uri}: ${getErrorMessage(e)}.`,
             );
           }
         }