fix: narrowing platform to be either win or mac (#5707)

Co-authored-by: Marin Sokol <[email protected]>

Author: marinsokol5

src/commands/command_manager.js

@@ -10,7 +10,7 @@ var EventEmitter = require("../lib/event_emitter").EventEmitter;
 class CommandManager extends MultiHashHandler{
     /**
      * new CommandManager(platform, commands)
-     * @param {String} platform Identifier for the platform; must be either `"mac"` or `"win"`
+     * @param {import("../keyboard/hash_handler").Platform} platform Identifier for the platform; must be either `"mac"` or `"win"`
      * @param {any[]} commands A list of commands
      **/
     constructor(platform, commands) {

src/keyboard/hash_handler.js

@@ -9,18 +9,22 @@
 var useragent = require("../lib/useragent");
 var KEY_MODS = keyUtil.KEY_MODS;
 
+/**
+ * @typedef {"win" | "mac"} Platform
+ */
+
 class MultiHashHandler {
     /**
      * @param {Record<string, CommandLike> | Command[]} [config]
-     * @param {string} [platform]
+     * @param {Platform} [platform]
      */
     constructor(config, platform) {
         this.$init(config, platform, false);
     }
 
     /**
      * @param {Record<string, CommandLike> | Command[]} config
-     * @param {string} [platform]
+     * @param {Platform} [platform]
      * @param {boolean} [$singleCommand]
      */
     $init(config, platform, $singleCommand) {
@@ -281,7 +285,7 @@ function getPosition(command) {
 class HashHandler extends MultiHashHandler {
     /**
      * @param {Record<string, CommandLike> | Command[]} [config]
-     * @param {string} [platform]
+     * @param {Platform} [platform]
      */
     constructor(config, platform) {
         super(config, platform);

types/ace-modules.d.ts

@@ -1847,14 +1847,15 @@ declare module "ace-code/src/search" {
 declare module "ace-code/src/keyboard/hash_handler" {
     export type Command = import("ace-code").Ace.Command;
     export type CommandLike = import("ace-code").Ace.CommandLike;
+    export type Platform = "win" | "mac";
     export class HashHandler extends MultiHashHandler {
     }
     export namespace HashHandler {
         function call(thisArg: any, config: any, platform: any): void;
     }
     export class MultiHashHandler {
-        constructor(config?: Record<string, CommandLike> | Command[], platform?: string);
-        platform: string;
+        constructor(config?: Record<string, CommandLike> | Command[], platform?: Platform);
+        platform: Platform;
         commands: Record<string, Command>;
         commandKeyBinding: {};
         addCommand(command: Command): void;
@@ -1890,10 +1891,10 @@ declare module "ace-code/src/commands/command_manager" {
     export class CommandManager extends MultiHashHandler {
         /**
          * new CommandManager(platform, commands)
-         * @param {String} platform Identifier for the platform; must be either `"mac"` or `"win"`
+         * @param {import("ace-code/src/keyboard/hash_handler").Platform} platform Identifier for the platform; must be either `"mac"` or `"win"`
          * @param {any[]} commands A list of commands
          **/
-        constructor(platform: string, commands: any[]);
+        constructor(platform: import("ace-code/src/keyboard/hash_handler").Platform, commands: any[]);
         byName: Record<string, import("ace-code").Ace.Command>;
         exec(command: string | string[] | import("ace-code").Ace.Command, editor: Editor, args: any): boolean;
         canExecute(command: string | import("ace-code").Ace.Command, editor: Editor): boolean;