@epic-web/workshop-utils 6.75.0 → 6.76.0

package/dist/launch-editor.server.d.ts

@@ -1,3 +1,10 @@
+export type EditorChoice = {
+    command: string;
+    label: string;
+};
+export declare function formatEditorLabel(command: string): string;
+export declare function getAvailableEditors(): EditorChoice[];
+export declare function getDefaultEditorCommand(): string | null;
 export type Result = {
     status: 'success';
 } | {

package/dist/launch-editor.server.js

@@ -96,6 +96,34 @@ const COMMON_EDITORS_WIN = [
     'rider64.exe',
     'zed.exe',
 ];
+// Map Windows executable names to their CLI commands
+const WINDOWS_CLI_COMMANDS = {
+    'Code.exe': 'code',
+    'Cursor.exe': 'cursor',
+    'Code - Insiders.exe': 'code-insiders',
+    'VSCodium.exe': 'vscodium',
+    'atom.exe': 'atom',
+    'Brackets.exe': 'brackets',
+    'sublime_text.exe': 'subl',
+    'notepad++.exe': 'notepad++',
+    'clion.exe': 'clion',
+    'clion64.exe': 'clion',
+    'idea.exe': 'idea',
+    'idea64.exe': 'idea',
+    'phpstorm.exe': 'phpstorm',
+    'phpstorm64.exe': 'phpstorm',
+    'pycharm.exe': 'pycharm',
+    'pycharm64.exe': 'pycharm',
+    'rubymine.exe': 'rubymine',
+    'rubymine64.exe': 'rubymine',
+    'webstorm.exe': 'webstorm',
+    'webstorm64.exe': 'webstorm',
+    'goland.exe': 'goland',
+    'goland64.exe': 'goland',
+    'rider.exe': 'rider',
+    'rider64.exe': 'rider',
+    'zed.exe': 'zed',
+};
 // Transpiled version of: /^([A-Za-z]:[/\\])?[\p{L}0-9/.\-_\\]+$/u
 // Non-transpiled version requires support for Unicode property regex. Allows
 // alphanumeric characters, periods, dashes, slashes, and underscores.
@@ -256,6 +284,100 @@ function guessEditor() {
     }
     return [null];
 }
+const EDITOR_LABELS = {
+    atom: 'Atom',
+    brackets: 'Brackets',
+    cursor: 'Cursor',
+    code: 'Visual Studio Code',
+    'code-insiders': 'Visual Studio Code - Insiders',
+    vscodium: 'VSCodium',
+    emacs: 'Emacs',
+    gvim: 'GVim',
+    vim: 'Vim',
+    mvim: 'MacVim',
+    subl: 'Sublime Text',
+    sublime_text: 'Sublime Text',
+    'notepad++': 'Notepad++',
+    clion: 'CLion',
+    idea: 'IntelliJ IDEA',
+    phpstorm: 'PhpStorm',
+    pycharm: 'PyCharm',
+    rubymine: 'RubyMine',
+    webstorm: 'WebStorm',
+    goland: 'GoLand',
+    rider: 'Rider',
+    appcode: 'AppCode',
+    zed: 'Zed',
+};
+function normalizeEditorCommand(command) {
+    const base = path.basename(command).replace(/\.(exe|cmd|bat)$/i, '');
+    return base.trim().toLowerCase();
+}
+export function formatEditorLabel(command) {
+    const normalized = normalizeEditorCommand(command);
+    return EDITOR_LABELS[normalized] ?? command;
+}
+function isCommandAvailable(command) {
+    if (!command)
+        return false;
+    if (path.isAbsolute(command)) {
+        return fs.existsSync(command);
+    }
+    if (command.includes(path.sep)) {
+        return fs.existsSync(command);
+    }
+    return commandExistsInPath(command);
+}
+function commandExistsInPath(command) {
+    const pathValue = process.env.PATH ?? '';
+    if (!pathValue)
+        return false;
+    const pathExt = process.platform === 'win32'
+        ? (process.env.PATHEXT ?? '.EXE;.CMD;.BAT;.COM').split(';')
+        : [''];
+    const hasExtension = Boolean(path.extname(command));
+    for (const dir of pathValue.split(path.delimiter)) {
+        if (!dir)
+            continue;
+        for (const ext of pathExt) {
+            const suffix = hasExtension ? '' : ext;
+            const fullPath = path.join(dir, `${command}${suffix}`);
+            if (fs.existsSync(fullPath))
+                return true;
+        }
+    }
+    return false;
+}
+function getSupportedEditorCommands() {
+    if (process.platform === 'darwin') {
+        return Array.from(new Set(Object.values(COMMON_EDITORS_OSX)));
+    }
+    if (process.platform === 'win32') {
+        return Array.from(new Set(COMMON_EDITORS_WIN.map((exe) => WINDOWS_CLI_COMMANDS[exe] ?? exe)));
+    }
+    return Array.from(new Set(Object.values(COMMON_EDITORS_LINUX)));
+}
+export function getAvailableEditors() {
+    const available = [];
+    const seen = new Set();
+    for (const command of getSupportedEditorCommands()) {
+        if (!isCommandAvailable(command))
+            continue;
+        if (seen.has(command))
+            continue;
+        seen.add(command);
+        available.push({
+            command,
+            label: formatEditorLabel(command),
+        });
+    }
+    return available.sort((a, b) => a.label.localeCompare(b.label));
+}
+export function getDefaultEditorCommand() {
+    const editorInfo = guessEditor();
+    const editor = editorInfo[0];
+    return editor ? String(editor) : null;
+}
 let _childProcess = null;
 export async function launchEditor(pathList, lineNumber = 1, colNumber = 1) {
     // Sanitize lineNumber to prevent malicious use on win32

package/dist/workshops.server.d.ts

@@ -3,6 +3,7 @@ export declare const PACKAGE_MANAGERS: readonly ["npm", "pnpm", "yarn", "bun"];
 export type PackageManager = (typeof PACKAGE_MANAGERS)[number];
 declare const ConfigSchema: z.ZodObject<{
     reposDirectory: z.ZodOptional<z.ZodString>;
+    preferredEditor: z.ZodOptional<z.ZodString>;
 }, z.core.$strip>;
 export type Workshop = {
     name: string;
@@ -19,6 +20,9 @@ export declare function getReposDirectory(): Promise<string>;
 export declare function isReposDirectoryConfigured(): Promise<boolean>;
 export declare function getDefaultReposDir(): string;
 export declare function setReposDirectory(directory: string): Promise<void>;
+export declare function getPreferredEditor(): Promise<string | undefined>;
+export declare function setPreferredEditor(editor: string): Promise<void>;
+export declare function clearPreferredEditor(): Promise<void>;
 export type ReposDirectoryStatus = {
     accessible: true;
 } | {

package/dist/workshops.server.js

@@ -23,6 +23,7 @@ export const PACKAGE_MANAGERS = ['npm', 'pnpm', 'yarn', 'bun'];
 // Schema for workshop configuration (stored settings only)
 const ConfigSchema = z.object({
     reposDirectory: z.string().optional(),
+    preferredEditor: z.string().optional(),
 });
 function getDefaultReposDirectory() {
     return path.join(os.homedir(), 'epic-workshops');
@@ -87,6 +88,20 @@ export async function setReposDirectory(directory) {
     config.reposDirectory = path.resolve(directory);
     await saveConfig(config);
 }
+export async function getPreferredEditor() {
+    const config = await loadConfig();
+    return config.preferredEditor;
+}
+export async function setPreferredEditor(editor) {
+    const config = await loadConfig();
+    config.preferredEditor = editor;
+    await saveConfig(config);
+}
+export async function clearPreferredEditor() {
+    const config = await loadConfig();
+    delete config.preferredEditor;
+    await saveConfig(config);
+}
 /**
  * Verify that the configured repos directory exists and is accessible.
  * If the directory doesn't exist, attempts to create it.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@epic-web/workshop-utils",
-  "version": "6.75.0",
+  "version": "6.76.0",
   "publishConfig": {
     "access": "public"
   },