Add initial translation support

Attempt to add support for translations, with an initial pseudo-language translation

Uses l10n, which is the recommended latest tooling for VS Code localization

package.json

@@ -51,6 +51,7 @@
     "ms-python.python"
   ],
   "main": "./dist/extension.cjs",
+  "l10n": "./l10n",
   "markdown": "github",
   "minimumNodeVersion": 20,
   "capabilities": {

scripts/genTranslations.py

@@ -0,0 +1,23 @@
+import shutil
+import subprocess
+import os
+
+
+def copyMtsToTs(src, dst):
+    # Copy but change mts to ts
+    dst = dst.replace(".mts", ".ts")
+    shutil.copyfile(src, dst)
+
+
+dir_path = os.path.dirname(os.path.realpath(__file__))
+os.chdir(f"{dir_path}/..")
+
+shutil.copytree("./src", "./tmp-translate", copy_function=copyMtsToTs)
+
+os.system("vscode-l10n-dev export --debug --verbose --outDir ./l10n ./tmp-translate")
+
+os.system(
+    "vscode-l10n-dev generate-pseudo --debug --verbose --outDir ./l10n ./l10n/bundle.l10n.json ./package.nls.json"
+)
+
+shutil.rmtree("./tmp-translate")

src/commands/clearGithubApiCache.mts

@@ -1,7 +1,7 @@
 import { Command } from "./command.mjs";
 import Logger from "../logger.mjs";
 import GithubApiCache from "../utils/githubApiCache.mjs";
-import { window } from "vscode";
+import { window, l10n } from "vscode";
 
 export default class ClearGithubApiCacheCommand extends Command {
   private _logger: Logger = new Logger("ClearGithubApiCacheCommand");
@@ -17,6 +17,6 @@ export default class ClearGithubApiCacheCommand extends Command {
 
     await GithubApiCache.getInstance().clear();
 
-    await window.showInformationMessage("Github API cache cleared.");
+    await window.showInformationMessage(l10n.t("Github API cache cleared."));
   }
 }

src/commands/compileProject.mts

@@ -1,4 +1,4 @@
-import { commands, tasks, window } from "vscode";
+import { commands, tasks, window, l10n } from "vscode";
 import { EventEmitter } from "events";
 import { CommandWithResult } from "./command.mjs";
 import Logger from "../logger.mjs";
@@ -72,7 +72,7 @@ export default class CompileProjectCommand extends CommandWithResult<boolean> {
     } else {
       // Task not found
       this._logger.error("Task 'Compile Project' not found.");
-      void window.showErrorMessage("Task 'Compile Project' not found.");
+      void window.showErrorMessage(l10n.t("Task {0} not found.", 'Compile Project'));
 
       return false;
     }

src/commands/configureCmake.mts

@@ -1,6 +1,6 @@
 import { Command } from "./command.mjs";
 import Logger from "../logger.mjs";
-import { window, workspace } from "vscode";
+import { window, workspace, l10n } from "vscode";
 import { configureCmakeNinja } from "../utils/cmakeUtil.mjs";
 import Settings, { SettingsKey } from "../settings.mjs";
 import { join } from "path";
@@ -22,7 +22,7 @@ export default class ConfigureCmakeCommand extends Command {
     // check if is a pico project
     if (workspaceFolder === undefined) {
       this._logger.warn("No workspace folder found.");
-      void window.showWarningMessage("No workspace folder found.");
+      void window.showWarningMessage(l10n.t("No workspace folder found."));
 
       return;
     }
@@ -34,17 +34,16 @@ export default class ConfigureCmakeCommand extends Command {
       settings.getBoolean(SettingsKey.useCmakeTools)
     ) {
       void window.showErrorMessage(
-        "You must use the CMake Tools extension to configure your build. " +
-          "To use this extension instead, change the useCmakeTools setting."
+        l10n.t("You must use the CMake Tools extension to configure your build. To use this extension instead, change the useCmakeTools setting.")
       );
 
       return;
     }
 
     if (await configureCmakeNinja(workspaceFolder.uri)) {
-      void window.showInformationMessage("CMake has configured your build.");
+      void window.showInformationMessage(l10n.t("CMake has configured your build."));
     } else {
-      void window.showWarningMessage("CMake failed to configure your build.");
+      void window.showWarningMessage(l10n.t("CMake failed to configure your build."));
     }
   }
 }
@@ -63,7 +62,7 @@ export class CleanCMakeCommand extends Command {
 
     if (workspaceFolder === undefined) {
       this._logger.warn("No workspace folder found.");
-      void window.showWarningMessage("No workspace folder found.");
+      void window.showWarningMessage(l10n.t("No workspace folder found."));
 
       return;
     }
@@ -75,8 +74,7 @@ export class CleanCMakeCommand extends Command {
       settings.getBoolean(SettingsKey.useCmakeTools)
     ) {
       void window.showErrorMessage(
-        "You must use the CMake Tools extension to clean your build. " +
-          "To use this extension instead, change the useCmakeTools setting."
+        l10n.t("You must use the CMake Tools extension to clean your build. To use this extension instead, change the useCmakeTools setting.")
       );
 
       return;
@@ -91,18 +89,18 @@ export class CleanCMakeCommand extends Command {
         "Error cleaning build directory.",
         unknownErrorToString(error)
       );
-      void window.showErrorMessage("Error cleaning build directory.");
+      void window.showErrorMessage(l10n.t("Error cleaning build directory."));
 
       return;
     }
 
     if (await configureCmakeNinja(workspaceFolder.uri)) {
       void window.showInformationMessage(
-        "CMake has been cleaned and reconfigured."
+        l10n.t("CMake has been cleaned and reconfigured.")
       );
     } else {
       void window.showWarningMessage(
-        "CMake could not be reconfigured. See log for details."
+        l10n.t("CMake could not be reconfigured. See log for details.")
       );
     }
   }

src/commands/flashProjectSwd.mts

@@ -1,6 +1,6 @@
 import { CommandWithResult } from "./command.mjs";
 import Logger from "../logger.mjs";
-import { tasks, window } from "vscode";
+import { tasks, window, l10n } from "vscode";
 import { EventEmitter } from "stream";
 
 export default class FlashProjectSWDCommand extends CommandWithResult<boolean> {
@@ -62,7 +62,7 @@ export default class FlashProjectSWDCommand extends CommandWithResult<boolean> {
     } else {
       // Task not found
       this._logger.error("Task 'Flash' not found.");
-      void window.showErrorMessage("Task 'Flash' not found.");
+      void window.showErrorMessage(l10n.t("Task {0} not found.", 'Flash'));
 
       return false;
     }

src/commands/launchTargetPath.mts

@@ -1,6 +1,6 @@
 import { readFileSync } from "fs";
 import { CommandWithResult } from "./command.mjs";
-import { commands, window, workspace } from "vscode";
+import { commands, window, workspace, l10n } from "vscode";
 import { join } from "path";
 import Settings, { SettingsKey } from "../settings.mjs";
 
@@ -31,9 +31,9 @@ export default class LaunchTargetPathCommand extends CommandWithResult<string> {
 
       if (matchBg && matchPoll) {
         // For examples with both background and poll, let user pick which to run
-        const quickPickItems = ["Threadsafe Background", "Poll"];
+        const quickPickItems = [l10n.t("Threadsafe Background"), l10n.t("Poll")];
         const backgroundOrPoll = await window.showQuickPick(quickPickItems, {
-          placeHolder: "Select PicoW Architecture",
+          placeHolder: l10n.t("Select PicoW Architecture"),
         });
         if (backgroundOrPoll === undefined) {
           return projectName;

src/commands/newProject.mts

@@ -1,6 +1,6 @@
 import { CommandWithArgs } from "./command.mjs";
 import Logger from "../logger.mjs";
-import { window, type Uri } from "vscode";
+import { window, type Uri, l10n } from "vscode";
 import { NewProjectPanel } from "../webview/newProjectPanel.mjs";
 // eslint-disable-next-line max-len
 import { NewMicroPythonProjectPanel } from "../webview/newMicroPythonProjectPanel.mjs";
@@ -44,10 +44,10 @@ export default class NewProjectCommand extends CommandWithArgs {
       (await window.showQuickPick(
         [NewProjectCommand.cCppOption, NewProjectCommand.micropythonOption],
         {
-          placeHolder: "Select which language to use for your new project",
+          placeHolder: l10n.t("Select which language to use for your new project"),
           canPickMany: false,
           ignoreFocusOut: false,
-          title: "New Pico Project",
+          title: l10n.t("New Pico Project"),
         }
       ));
 

src/commands/openSdkDocumentation.mts

@@ -7,6 +7,7 @@ import {
   window,
   Uri,
   type WebviewPanel,
+  l10n
 } from "vscode";
 import { readFileSync } from "fs";
 
@@ -18,10 +19,10 @@ export enum DocumentationId {
 }
 
 export const DOCUMENTATION_LABEL_BY_ID: string[] = [
-  "Hardware APIs",
-  "High Level APIs",
-  "Networking Libraries",
-  "Runtime Infrastructure",
+  l10n.t("Hardware APIs"),
+  l10n.t("High Level APIs"),
+  l10n.t("Networking Libraries"),
+  l10n.t("Runtime Infrastructure"),
 ];
 
 // eslint-disable-next-line @typescript-eslint/no-unused-vars
@@ -65,7 +66,7 @@ export default class OpenSdkDocumentationCommand extends CommandWithArgs {
       );
 
       const result = await window.showQuickPick(options, {
-        placeHolder: "Select Category",
+        placeHolder: l10n.t("Select Category"),
         canPickMany: false,
         ignoreFocusOut: false,
       });
@@ -83,7 +84,7 @@ export default class OpenSdkDocumentationCommand extends CommandWithArgs {
       Logger.log("New panel");
       this._panel = window.createWebviewPanel(
         "pico-sdk-documentation",
-        "Pico SDK Documentation",
+        l10n.t("Pico SDK Documentation"),
         { viewColumn: ViewColumn.Two, preserveFocus: false },
         {
           enableScripts: true,

src/commands/runProject.mts

@@ -1,4 +1,4 @@
-import { tasks, window } from "vscode";
+import { tasks, window, l10n } from "vscode";
 import { EventEmitter } from "events";
 import { CommandWithResult } from "./command.mjs";
 import Logger from "../logger.mjs";
@@ -60,7 +60,7 @@ export default class RunProjectCommand extends CommandWithResult<boolean> {
     } else {
       // Task not found
       this._logger.error("Task 'Run Project' not found.");
-      void window.showErrorMessage("Task 'Run Project' not found.");
+      void window.showErrorMessage(l10n.t("Task {0} not found.", 'Run Project'));
 
       return false;
     }

src/commands/switchBoard.mts

@@ -1,7 +1,7 @@
 import { Command } from "./command.mjs";
 import Logger from "../logger.mjs";
 import {
-  commands, ProgressLocation, window, workspace, type Uri
+  commands, ProgressLocation, window, workspace, type Uri, l10n
 } from "vscode";
 import { existsSync, readdirSync, readFileSync } from "fs";
 import {
@@ -108,7 +108,7 @@ export default class SwitchBoardCommand extends Command {
 
     // show quick pick for board type
     const board = await window.showQuickPick(quickPickItems, {
-      placeHolder: "Select Board",
+      placeHolder: l10n.t("Select Board"),
     });
 
     if (board === undefined) {
@@ -124,8 +124,8 @@ export default class SwitchBoardCommand extends Command {
       return [board, false];
     }
 
-    const useRiscV = await window.showQuickPick(["No", "Yes"], {
-      placeHolder: "Use Risc-V?",
+    const useRiscV = await window.showQuickPick([l10n.t("No"), l10n.t("Yes")], {
+      placeHolder: l10n.t("Use Risc-V?"),
     });
 
     if (useRiscV === undefined) {
@@ -153,7 +153,7 @@ export default class SwitchBoardCommand extends Command {
 
     if (versions === null) {
       void window.showErrorMessage(
-        "Failed to get sdk version - cannot update board"
+        l10n.t("Failed to get sdk version - cannot update board")
       );
 
       return;
@@ -178,7 +178,9 @@ export default class SwitchBoardCommand extends Command {
 
     if (versionBundle === undefined) {
       void window.showErrorMessage(
-        `Cannot switch board automatically with SDK version ${versions[0]}`
+        l10n.t(
+          "Cannot switch board automatically with SDK version {0}", versions[0]
+        )
       );
 
       return;
@@ -196,8 +198,8 @@ export default class SwitchBoardCommand extends Command {
         // internet is not required if locally cached version bundles are available
         // but in this case a use shouldn't see this message
         void window.showErrorMessage(
-          "Failed to get supported toolchain versions. " +
-            "Make sure you are connected to the internet."
+          l10n.t("Failed to get supported toolchain versions.") + " " +
+          l10n.t("Make sure you are connected to the internet.")
         );
 
         return;
@@ -209,7 +211,7 @@ export default class SwitchBoardCommand extends Command {
 
       if (selectedToolchain === undefined) {
         void window.showErrorMessage(
-          "Error switching to Risc-V toolchain"
+          l10n.t("Error switching to Risc-V toolchain")
         );
 
         return;
@@ -218,7 +220,7 @@ export default class SwitchBoardCommand extends Command {
       await window.withProgress(
           {
             title:
-              `Installing toolchain ${selectedToolchain.version} `,
+              l10n.t("Installing toolchain {0}", selectedToolchain.version),
             location: ProgressLocation.Notification,
           },
         async progress => {
@@ -248,7 +250,9 @@ export default class SwitchBoardCommand extends Command {
 
             if (!cmakeUpdateResult) {
               void window.showWarningMessage(
-                "Failed to update CMakeLists.txt for new toolchain version."
+                l10n.t(
+                  "Failed to update CMakeLists.txt for new toolchain version."
+                )
               );
             }
           }
@@ -260,12 +264,13 @@ export default class SwitchBoardCommand extends Command {
     if (success) {
       this._ui.updateBoard(board);
 
-      const reloadWindowBtn = "Reload Window";
+      const reloadWindowBtn = l10n.t("Reload Window");
       // notify user that reloading the window is
       // recommended to update intellisense
       const reload = await window.showInformationMessage(
-        "It is recommended to reload the window to update intellisense " +
-          "with the new board.",
+        l10n.t(
+          "Reload the window to update intellisense with the new board."
+        ),
         reloadWindowBtn
       );