epicshop 6.89.0 → 6.89.2

package/dist/commands/start.d.ts

@@ -8,6 +8,14 @@ export type StartResult = {
     message?: string;
     error?: Error;
 };
+type WorkshopAppAttempt = {
+    source: string;
+    dir: string;
+};
+type WorkshopAppResolution = {
+    appDir: string | null;
+    attempts: Array<WorkshopAppAttempt>;
+};
 /**
  * Display help information about environment variables and debug logging
  */
@@ -16,3 +24,10 @@ export declare function displayHelp(): void;
  * Start the workshop application
  */
 export declare function start(options?: StartOptions): Promise<StartResult>;
+export declare function formatWorkshopAppResolutionErrorMessage(attempts: Array<WorkshopAppAttempt>): string;
+export declare function findGlobalWorkshopApp(options?: {
+    env?: NodeJS.ProcessEnv;
+    homeDir?: string;
+    npmRoot?: string;
+}): Promise<WorkshopAppResolution>;
+export {};

package/dist/commands/start.js

@@ -61,11 +61,20 @@ export function displayHelp() {
 export async function start(options = {}) {
     try {
         // Find workshop-app directory using new resolution order
-        const appDir = await findWorkshopAppDir(options.appLocation);
-        if (!appDir) {
-            const errorMessage = 'Could not locate workshop-app directory. Please ensure the workshop app is installed or specify its location using:\n  - Environment variable: EPICSHOP_APP_LOCATION\n  - Command line flag: --app-location\n  - Global installation: npm install -g @epic-web/workshop-app';
+        const resolution = await findWorkshopAppDir(options.appLocation);
+        if (!resolution.appDir) {
+            const errorMessage = formatWorkshopAppResolutionErrorMessage(resolution.attempts);
             if (!options.silent) {
                 console.error(chalk.red('❌ Could not locate workshop-app directory'));
+                console.error(chalk.yellow('Tried these directories:'));
+                if (resolution.attempts.length > 0) {
+                    for (const attempt of resolution.attempts) {
+                        console.error(chalk.yellow(`  - ${attempt.source}: ${attempt.dir}`));
+                    }
+                }
+                else {
+                    console.error(chalk.yellow('  - No candidate directories were tried'));
+                }
                 console.error(chalk.yellow('Please ensure the workshop app is installed or specify its location using:'));
                 console.error(chalk.yellow('  - Environment variable: EPICSHOP_APP_LOCATION'));
                 console.error(chalk.yellow('  - Command line flag: --app-location'));
@@ -77,6 +86,7 @@ export async function start(options = {}) {
                 error: new Error(errorMessage),
             };
         }
+        const appDir = resolution.appDir;
         const isPublished = await appIsPublished(appDir);
         const isProd = process.env.NODE_ENV === 'production' || isPublished;
         const isDeployed = process.env.EPICSHOP_DEPLOYED === 'true' ||
@@ -453,6 +463,35 @@ export async function start(options = {}) {
         };
     }
 }
+const workshopAppHelpLines = [
+    'Please ensure the workshop app is installed or specify its location using:',
+    '  - Environment variable: EPICSHOP_APP_LOCATION',
+    '  - Command line flag: --app-location',
+    '  - Global installation: npm install -g @epic-web/workshop-app',
+];
+export function formatWorkshopAppResolutionErrorMessage(attempts) {
+    const lines = [
+        'Could not locate workshop-app directory.',
+        'Tried these directories:',
+    ];
+    if (attempts.length > 0) {
+        lines.push(...attempts.map((attempt) => `  - ${attempt.source}: ${attempt.dir}`));
+    }
+    else {
+        lines.push('  - No candidate directories were tried');
+    }
+    lines.push(...workshopAppHelpLines);
+    return lines.join('\n');
+}
+async function resolveWorkshopAppCandidate(candidate) {
+    try {
+        await fs.promises.access(path.join(candidate.dir, 'package.json'));
+        return candidate.dir;
+    }
+    catch {
+        return null;
+    }
+}
 // Helper functions
 async function killChild(child) {
     if (!child)
@@ -500,43 +539,49 @@ async function killChild(child) {
     });
 }
 async function findWorkshopAppDir(appLocation) {
+    const attempts = [];
     // 1. Check process.env.EPICSHOP_APP_LOCATION
     if (process.env.EPICSHOP_APP_LOCATION) {
-        const envDir = path.resolve(process.env.EPICSHOP_APP_LOCATION);
-        try {
-            await fs.promises.access(path.join(envDir, 'package.json'));
-            return envDir;
-        }
-        catch {
-            // Continue to next step
-        }
+        const candidate = {
+            source: 'EPICSHOP_APP_LOCATION',
+            dir: path.resolve(process.env.EPICSHOP_APP_LOCATION),
+        };
+        attempts.push(candidate);
+        const envDir = await resolveWorkshopAppCandidate(candidate);
+        if (envDir)
+            return { appDir: envDir, attempts };
     }
     // 2. Check command line flag --app-location
     if (appLocation) {
-        const flagDir = path.resolve(appLocation);
-        try {
-            await fs.promises.access(path.join(flagDir, 'package.json'));
-            return flagDir;
-        }
-        catch {
-            // Continue to next step
-        }
+        const candidate = {
+            source: '--app-location',
+            dir: path.resolve(appLocation),
+        };
+        attempts.push(candidate);
+        const flagDir = await resolveWorkshopAppCandidate(candidate);
+        if (flagDir)
+            return { appDir: flagDir, attempts };
     }
     // 3. Node's resolution process
     try {
-        const workshopAppPath = import.meta
-            .resolve('@epic-web/workshop-app/package.json');
-        const packagePath = fileURLToPath(workshopAppPath);
-        return path.dirname(packagePath);
+        const candidate = {
+            source: 'node module resolution',
+            dir: path.dirname(fileURLToPath(import.meta.resolve('@epic-web/workshop-app/package.json'))),
+        };
+        attempts.push(candidate);
+        const packagePath = await resolveWorkshopAppCandidate(candidate);
+        if (packagePath)
+            return { appDir: packagePath, attempts };
     }
     catch {
         // Continue to next step
     }
     // 4. Global installation lookup
     try {
-        const globalDir = await findGlobalWorkshopApp();
-        if (globalDir) {
-            return globalDir;
+        const globalResolution = await findGlobalWorkshopApp();
+        attempts.push(...globalResolution.attempts);
+        if (globalResolution.appDir) {
+            return { appDir: globalResolution.appDir, attempts };
         }
     }
     catch {
@@ -546,53 +591,70 @@ async function findWorkshopAppDir(appLocation) {
     try {
         const cliPkgPath = import.meta.resolve('epicshop/package.json');
         const cliPkgDir = path.dirname(fileURLToPath(cliPkgPath));
-        const relativePath = path.resolve(cliPkgDir, '..', '..', 'workshop-app');
-        try {
-            await fs.promises.access(path.join(relativePath, 'package.json'));
-            return relativePath;
-        }
-        catch {
-            // Continue to final return
-        }
+        const candidate = {
+            source: 'monorepo fallback',
+            dir: path.resolve(cliPkgDir, '..', '..', 'workshop-app'),
+        };
+        attempts.push(candidate);
+        const relativePath = await resolveWorkshopAppCandidate(candidate);
+        if (relativePath)
+            return { appDir: relativePath, attempts };
     }
     catch {
         // Continue to final return
     }
-    return null;
+    return { appDir: null, attempts };
 }
-async function findGlobalWorkshopApp() {
-    // Try to find globally installed workshop app
-    try {
-        const npmRoot = execSync('npm root -g', { encoding: 'utf-8' }).trim();
-        const globalAppPath = path.join(npmRoot, '@epic-web/workshop-app');
-        try {
-            await fs.promises.access(path.join(globalAppPath, 'package.json'));
-            return globalAppPath;
-        }
-        catch {
-            // Continue to common global locations
+function getGlobalNodeModulesPathFromPrefix(prefix) {
+    return path.join(path.resolve(prefix), process.platform === 'win32' ? 'node_modules' : 'lib', 'node_modules');
+}
+function getGlobalWorkshopAppCandidatePaths(env, homeDir, npmRoot) {
+    const candidatePaths = new Map();
+    const addCandidate = (source, dir) => {
+        const resolvedDir = path.resolve(dir);
+        if (!candidatePaths.has(resolvedDir)) {
+            candidatePaths.set(resolvedDir, { source, dir: resolvedDir });
         }
+    };
+    const addCandidateFromPrefix = (source, prefix) => {
+        if (!prefix)
+            return;
+        addCandidate(source, path.join(getGlobalNodeModulesPathFromPrefix(prefix), '@epic-web/workshop-app'));
+    };
+    // When `epicshop` is started through `npx --prefix`, npm rewrites
+    // `npm root -g` to that local prefix. The original global prefix can still
+    // be available via the uppercase env var, so prefer it first.
+    addCandidateFromPrefix('NPM_CONFIG_PREFIX', env.NPM_CONFIG_PREFIX);
+    if (npmRoot) {
+        addCandidate('npm root -g', path.join(npmRoot, '@epic-web/workshop-app'));
     }
-    catch {
-        // If npm root -g fails, try common global locations
-    }
-    // Try common global locations
-    const commonGlobalPaths = [
-        path.join(os.homedir(), '.npm-global/lib/node_modules/@epic-web/workshop-app'),
-        path.join(os.homedir(), '.npm-packages/lib/node_modules/@epic-web/workshop-app'),
-        '/usr/local/lib/node_modules/@epic-web/workshop-app',
-        '/usr/lib/node_modules/@epic-web/workshop-app',
-    ];
-    for (const globalPath of commonGlobalPaths) {
+    addCandidateFromPrefix('npm_config_prefix', env.npm_config_prefix);
+    addCandidate('~/.npm-global', path.join(homeDir, '.npm-global/lib/node_modules/@epic-web/workshop-app'));
+    addCandidate('~/.npm-packages', path.join(homeDir, '.npm-packages/lib/node_modules/@epic-web/workshop-app'));
+    addCandidate('system global (/usr/local)', '/usr/local/lib/node_modules/@epic-web/workshop-app');
+    addCandidate('system global (/usr)', '/usr/lib/node_modules/@epic-web/workshop-app');
+    return [...candidatePaths.values()];
+}
+export async function findGlobalWorkshopApp(options) {
+    const env = options?.env ?? process.env;
+    const homeDir = options?.homeDir ?? os.homedir();
+    let npmRoot = options?.npmRoot;
+    if (!npmRoot) {
         try {
-            await fs.promises.access(path.join(globalPath, 'package.json'));
-            return globalPath;
+            npmRoot = execSync('npm root -g', { encoding: 'utf-8' }).trim();
         }
         catch {
-            // Continue to next path
+            // If npm root -g fails, continue with env-derived and common locations.
+        }
+    }
+    const attempts = getGlobalWorkshopAppCandidatePaths(env, homeDir, npmRoot);
+    for (const globalPath of attempts) {
+        const resolvedPath = await resolveWorkshopAppCandidate(globalPath);
+        if (resolvedPath) {
+            return { appDir: resolvedPath, attempts };
         }
     }
-    return null;
+    return { appDir: null, attempts };
 }
 async function appIsPublished(appDir) {
     if (process.env.EPICSHOP_IS_PUBLISHED) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "epicshop",
-  "version": "6.89.0",
+  "version": "6.89.2",
   "publishConfig": {
     "access": "public"
   },
@@ -105,7 +105,7 @@
     "build:watch": "nx watch --projects=epicshop -- nx run \\$NX_PROJECT_NAME:build"
   },
   "dependencies": {
-    "@epic-web/workshop-utils": "6.89.0",
+    "@epic-web/workshop-utils": "6.89.2",
     "@inquirer/prompts": "^8.2.0",
     "@sentry/node": "^10.38.0",
     "chalk": "^5.6.2",