feat: run scripts on background by default (#459)

closes #458

Author: fengmk2

bin/install.js

@@ -56,6 +56,8 @@ Object.assign(argv, parseArgs(originalArgv, {
     'save-exact',
     'china',
     'ignore-scripts',
+    // run scripts on foreground, default is background
+    'foreground-scripts',
     // install ignore optionalDependencies
     'optional',
     'detail',
@@ -134,8 +136,9 @@ Options:
   --workspaces: install new package on all workspaces, e.g: npminstall foo --workspaces
   --trace: show memory and cpu usages traces of installation
   --ignore-scripts: ignore all preinstall / install and postinstall scripts during the installation
+  --foreground-scripts: scripts run in the background by default, to see the output, run with: --foreground-scripts
   --no-optional: ignore all optionalDependencies during the installation
-  --forbidden-licenses: forbit install packages which used these licenses
+  --forbidden-licenses: forbidden install packages which used these licenses
   --engine-strict: refuse to install (or even consider installing) any package that claims to not be compatible with the current Node.js version.
   --flatten: flatten dependencies by matching ancestors' dependencies
   --registry-only: make sure all packages install from registry. Any package is installed from remote(e.g.: git, remote url) cause install fail.
@@ -309,6 +312,7 @@ debug('argv: %j, env: %j', argv, env);
   // get config from npm settings instead of following user's specification,
   // should migrate to ?? or typeof.
   config.ignoreScripts = argv['ignore-scripts'] || getIgnoreScripts();
+  config.foregroundScripts = argv['foreground-scripts'];
   config.ignoreOptionalDependencies = !argv.optional;
   config.detail = argv.detail;
   config.forceLinkLatest = !!argv['force-link-latest'];

lib/lifecycle_scripts.js

@@ -24,25 +24,27 @@ exports.DEFAULT_DEP_SCRIPTS = [
   'postinstall',
 ];
 
-exports.runLifecycleScripts = async function runLifecycleScripts(pkg, root, originPkg, displayName, options) {
+exports.runLifecycleScripts = async function runLifecycleScripts(pkg, root, originPkg, displayName, globalOptions) {
   const scripts = pkg.scripts || {};
 
   // https://docs.npmjs.com/misc/scripts#default-values
   // "install": "node-gyp rebuild"
   // If there is a binding.gyp file in the root of your package,
   // npm will default the install command to compile using node-gyp.
   if (!scripts.install && (await utils.exists(path.join(root, 'binding.gyp')))) {
-    options.console.warn(
+    globalOptions.console.warn(
       '[npminstall:runscript] %s found binding.gyp file, auto run "node-gyp rebuild", root: %j',
       displayName, root
     );
     scripts.install = 'node-gyp rebuild';
   }
 
   let scriptList = exports.DEFAULT_DEP_SCRIPTS;
-
-  if ((root === options.root && !options.global) || LOCAL_TYPES.includes(npa(`${originPkg.name}@${originPkg.version}`).type)) {
+  let runInForeground = !!globalOptions.foregroundScripts;
+  if ((root === globalOptions.root && !globalOptions.global)
+    || LOCAL_TYPES.includes(npa(`${originPkg.name}@${originPkg.version}`).type)) {
     scriptList = exports.DEFAULT_ROOT_SCRIPTS;
+    runInForeground = true;
   }
 
   for (const script of scriptList) {
@@ -51,7 +53,7 @@ exports.runLifecycleScripts = async function runLifecycleScripts(pkg, root, orig
       continue;
     }
 
-    console.info(
+    runInForeground && console.info(
       '> %s %s %s %s> %s',
       displayName,
       script,
@@ -61,26 +63,26 @@ exports.runLifecycleScripts = async function runLifecycleScripts(pkg, root, orig
     );
     const startTime = Date.now();
     try {
-      await utils.runScript(root, cmd, options);
+      await utils.runScript(root, cmd, globalOptions, runInForeground);
     } catch (error) {
-      options.console.warn('[npminstall:runscript:error] %s run %s %s error: %s', chalk.red(displayName), script, cmd, error);
+      globalOptions.console.warn('[npminstall:runscript:error] %s run %s %s error: %s', chalk.red(displayName), script, cmd, error);
       // If post install execute error, make sure this package won't be skipped during next installation.
       try {
         await utils.unsetInstallDone(root);
       } catch (e) {
-        options.console.warn(chalk.yellow(`unsetInstallDone: ${root} error: ${e}, ignore it`));
+        globalOptions.console.warn(chalk.yellow(`unsetInstallDone: ${root} error: ${e}, ignore it`));
       }
       if (originPkg.optional) {
-        options.console.warn(chalk.red('%s optional error: %s'), displayName, error.stack);
+        globalOptions.console.warn(chalk.red('%s optional error: %s'), displayName, error.stack);
         continue;
       }
       error.message = `run ${script} error, please remove node_modules before retry!\n${error.message}`;
       throw error;
     } finally {
       const ts = Date.now() - startTime;
-      console.info('> %s %s, finished in %s', displayName, script, ms(ts));
-      options.runscriptCount += 1;
-      options.runscriptTime += ts;
+      runInForeground && console.info('> %s %s, finished in %s', displayName, script, ms(ts));
+      globalOptions.runscriptCount += 1;
+      globalOptions.runscriptTime += ts;
     }
   }
 };

lib/utils.js

@@ -204,8 +204,7 @@ exports.parseTarballUrls = tarball => {
 /*
  * Runs an npm script.
  */
-
-exports.runScript = async (pkgDir, script, options) => {
+exports.runScript = async (pkgDir, script, globalOptions, runInForeground = false) => {
   // merge config.env <= process.env <= options.env
   const env = {};
 
@@ -221,12 +220,12 @@ exports.runScript = async (pkgDir, script, options) => {
     env[key] = process.env[key];
   }
 
-  for (const key in options.env) {
+  for (const key in globalOptions.env) {
     // ignore `Path` env on Windows
     if (/^path$/i.test(key)) {
       continue;
     }
-    env[key] = options.env[key];
+    env[key] = globalOptions.env[key];
   }
 
   // set npm_package_* env from package.json
@@ -237,7 +236,7 @@ exports.runScript = async (pkgDir, script, options) => {
 
   env.PATH = [
     path.join(__dirname, '../node-gyp-bin'),
-    path.join(options.root, 'node_modules', '.bin'),
+    path.join(globalOptions.root, 'node_modules', '.bin'),
     path.join(pkgDir, 'node_modules', '.bin'),
     process.env.PATH,
   ].join(path.delimiter);
@@ -247,7 +246,7 @@ exports.runScript = async (pkgDir, script, options) => {
   if (NPM_INSTALL_RE.test(script)) {
     const npminstall = path.join(__dirname, '../bin/install.js');
     const newScript = script.replace(NPM_INSTALL_RE, `${process.execPath} ${npminstall} `);
-    options.console.info('[npminstall:runScript] replace %j to %j', script, newScript);
+    globalOptions.console.info('[npminstall:runScript] replace %j to %j', script, newScript);
     script = newScript;
   }
 
@@ -262,12 +261,12 @@ exports.runScript = async (pkgDir, script, options) => {
     return await command(script, {
       cwd: pkgDir,
       env,
-      stdio: 'inherit',
+      stdio: runInForeground ? 'inherit' : 'ignore',
       shell: true,
     });
   } catch (err) {
     if (ignoreError) {
-      options.console.info('[npminstall:runScript] ignore runscript error: %s', err);
+      globalOptions.console.info('[npminstall:runScript] ignore runscript error: %s', err);
     } else {
       throw err;
     }

test/fixtures/postinstall/package.json

@@ -9,6 +9,7 @@
     "prepare": "node index.js prepare"
   },
   "dependencies": {
+    "postinstall-hello": "1.0.0",
     "utility": "1.6.0",
     "a-dep-b": "*"
   }

test/postinstall.test.js

@@ -18,6 +18,35 @@ describe('test/postinstall.test.js', () => {
       await coffee.fork(helper.npminstall, [], { cwd: root })
         .debug()
         .expect('code', 0)
+        // should run deps scripts on background by default
+        .notExpect('stdout', /run on postinstall-hello/)
+        .notExpect('stdout', /postinstall-hello@1.0.0 postinstall/)
+        .expect('stdout', /node index.js preinstall/)
+        .end();
+      const pkg = await readJSON(path.join(root, 'node_modules', 'utility', 'package.json'));
+      assert.equal(pkg.name, 'utility');
+      assert.equal(pkg.version, '1.6.0');
+
+      // preinstall pass
+      assert.equal(fs.readFileSync(path.join(root, '.preinstall.txt'), 'utf8'), 'success: preinstall');
+      // install pass
+      assert.equal(fs.readFileSync(path.join(root, 'node_modules', '.install.txt'), 'utf8'), 'success: install');
+      // postinstall pass
+      assert.equal(fs.readFileSync(path.join(root, 'node_modules', '.postinstall.txt'), 'utf8'), 'success: postinstall');
+      // prepublish pass
+      assert.equal(fs.readFileSync(path.join(root, 'node_modules', '.prepublish.txt'), 'utf8'), 'success: prepublish');
+      // prepare pass
+      assert.equal(fs.readFileSync(path.join(root, 'node_modules', '.prepare.txt'), 'utf8'), 'success: prepare');
+    });
+
+    it('should run preinstall, install, postinstall and prepublish --foreground-scripts', async () => {
+      await coffee.fork(helper.npminstall, [ '--foreground-scripts' ], { cwd: root })
+        .debug()
+        .expect('code', 0)
+        // should run deps scripts on foreground
+        .expect('stdout', /run on postinstall-hello/)
+        .expect('stdout', /postinstall-hello@1.0.0 postinstall/)
+        .expect('stdout', /node index.js preinstall/)
         .end();
       const pkg = await readJSON(path.join(root, 'node_modules', 'utility', 'package.json'));
       assert.equal(pkg.name, 'utility');

test/runscript.test.js

@@ -9,7 +9,7 @@ describe('test/runscript.test.js', () => {
   const cleanup = helper.cleanup(root);
 
   beforeEach(cleanup);
-  // afterEach(cleanup);
+  afterEach(cleanup);
 
   it('should run preinstall and postinstall', async () => {
     // ignore windows