fix: properly quote paths

Author: coolyuantao

.gitignore

@@ -20,6 +20,9 @@ test/fixtures/ts/node_modules/aliyun-egg/
 !test/fixtures/test-demo-app/node_modules/
 !test/fixtures/test-demo-app-esm/node_modules/
 
+!test/fixtures/test-postinstall/node_modules/
+!test/fixtures/test path with space/**/node_modules/
+
 .mochawesome-reports
 run
 .tmp
@@ -36,6 +39,7 @@ yarn.lock
 dist
 test/fixtures/example-declarations/typings/
 !test/fixtures/example-declarations/node_modules
+!test/fixtures/test path with space/example-declarations/node_modules/egg-ts-helper/dist/
 .package-lock.json
 .tshy*
 .eslintcache

scripts/postinstall.mjs

@@ -52,7 +52,7 @@ async function main() {
       // https://github.com/eggjs/egg-ts-helper/pull/104
       process.env.ETS_SCRIPT_FRAMEWORK = frameworkPackageName;
       console.log('[@eggjs/bin/postinstall] run %s on %s', etsBinFile, npmRunRoot);
-      runScript(`node ${etsBinFile}`);
+      runScript(`node "${etsBinFile}"`);
     }
   }
 }

src/baseCommand.ts

@@ -1,6 +1,7 @@
 import { debuglog } from 'node:util';
 import { pathToFileURL } from 'node:url';
 import path from 'node:path';
+import os from 'node:os';
 import { fork, ForkOptions, ChildProcess } from 'node:child_process';
 import { Command, Flags, Interfaces } from '@oclif/core';
 import { importResolve } from '@eggjs/utils';
@@ -261,7 +262,7 @@ export abstract class BaseCommand<T extends typeof Command> extends Command {
         paths: findPaths,
       });
       debug('run ets first: %o', etsBin);
-      await runScript(`node ${etsBin}`);
+      await runScript(`node "${etsBin}"`);
     }
 
     if (this.pkgEgg.revert) {
@@ -327,9 +328,12 @@ export abstract class BaseCommand<T extends typeof Command> extends Command {
 
   protected formatImportModule(modulePath: string) {
     if (this.isESM) {
-      return `--import ${pathToFileURL(modulePath).href}`;
+      return `--import "${pathToFileURL(modulePath).href}"`;
     }
-    return `--require ${modulePath}`;
+    if (os.platform() === 'win32') {
+      return `--require "${path.win32.normalize(modulePath).replace(/\\/g, '\\\\')}"`;
+    }
+    return `--require "${modulePath}"`;
   }
 
   protected addNodeOptions(options: string) {

src/commands/dev.ts

@@ -44,8 +44,14 @@ export default class Dev<T extends typeof Dev> extends BaseCommand<T> {
     const requires = await this.formatRequires();
     const execArgv: string[] = [];
     for (const r of requires) {
-      const imports = this.formatImportModule(r).split(' ');
-      execArgv.push(...imports);
+      const module = this.formatImportModule(r);
+      const splitIndex = module.indexOf(' ');
+      if (splitIndex !== -1) {
+        // Remove the quotes from the path
+        // --require "module path" -> ['--require', 'module path']
+        // --import "module path" -> ['--import', 'module path']
+        execArgv.push(module.slice(0, splitIndex), module.slice(splitIndex + 2, -1));
+      }
     }
     await this.forkNode(serverBin, args, { execArgv });
   }

test/commands/cov.test.ts

@@ -147,7 +147,15 @@ describe('test/commands/cov.test.ts', () => {
         // .debug()
         .expect('stdout', /1\) should fail/)
         .expect('stdout', /1 failing/)
-        .expect('stderr', /exit with code 1/)
+        // The formatted coverage report will automatically wrap when output.
+        // There is a certain probability that it will be truncated.
+        // For example:
+        // ==== Coverage Summary ====
+        // Error: xxxxxxxxx.js exit
+        // with code 1
+        // Code: 1
+
+        // .expect('stderr', /exit with code 1/)
         .expect('code', 1)
         .end();
     });

test/commands/dev.test.ts

@@ -231,4 +231,58 @@ describe('test/commands/dev.test.ts', () => {
       .expect('code', 0)
       .end();
   });
+
+  describe('work on special path', () => {
+    it('should work with space in path', () => {
+      return coffee.fork(eggBin, [ 'dev' ], {
+        cwd: getFixtures('test path with space/example-app'),
+      })
+        // .debug()
+        .expect('stdout', /Hello, world!/)
+        .expect('code', 0)
+        .end();
+    });
+
+    it('should support declarations with space in path', () => {
+      return coffee.fork(eggBin, [ 'dev' ], {
+        cwd: getFixtures('test path with space/example-declarations'),
+      })
+        // .debug()
+        .expect('stdout', /Hi, I am Egg TS helper!/)
+        .expect('code', 0)
+        .end();
+    });
+
+    it('should support egg.require with space in path', () => {
+      return coffee.fork(eggBin, [ 'dev' ], {
+        cwd: getFixtures('test path with space/example-egg-require'),
+      })
+        // .debug()
+        .expect('stdout', /hey, you require me by --require/)
+        .expect('code', 0)
+        .end();
+    });
+
+    it('should support --require with space in path', () => {
+      return coffee.fork(eggBin, [ 'dev', '--require', getFixtures('test path with space/require script.cjs') ], {
+        cwd: getFixtures('test path with space/example-require-script'),
+      })
+        // .debug()
+        .expect('stdout', /hey, you require me by --require/)
+        .expect('code', 0)
+        .end();
+    });
+
+    it('should support --import with space in path', () => {
+      return coffee.fork(eggBin, [ 'dev', '--import', getFixtures('test path with space/require script.mjs') ], {
+        cwd: getFixtures('test path with space/example-import-script'),
+      })
+        // .debug()
+        .expect('stdout', /hey, you require me by --import/)
+        .expect('code', 0)
+        .end();
+    });
+
+  });
+
 });

test/commands/test.test.ts

@@ -394,4 +394,16 @@ describe('test/commands/test.test.ts', () => {
         .end();
     });
   });
+
+  describe('work on special path', () => {
+    it('should work with space in path', () => {
+      return coffee.fork(eggBin, [ 'test' ], {
+        cwd: getFixtures('test path with space/test-files'),
+      })
+        // .debug()
+        .expect('stdout', /should success/)
+        .expect('code', 0)
+        .end();
+    });
+  });
 });

test/fixtures/example-ts-error-stack/node_modules/egg/index.js

@@ -0,0 +1,4 @@
+
+export default function () {
+    console.log('Hello, world!');
+}