refactor: use environments to check the current client

Author: aprilandjan

bin/cli.js

@@ -1,10 +1,12 @@
 #!/usr/bin/env node
 
 const chalk = require('chalk');
-const { debug } = require('../lib/utils');
+const { debug, ensureNpm, ensureYarn } = require('../lib/utils');
 
 const helpText = `
-Add the script as the pre-script in your package.json to ensure that your script is executed by specific npm client (${chalk.green('npm')} or ${chalk.red('yarn')}).
+${chalk.green('Usage')}
+  add check script as the pre-hook script in your package.json
+  to ensure that your script is executed by specific npm client (${chalk.green('npm')} or ${chalk.green('yarn')}).
 
 ${chalk.green('Example')}
   $ check-npm-client
@@ -17,18 +19,19 @@ const script = args[0];
 
 debug('cmd:', process.cwd());
 debug('script:', script);
+debug('npm user agent', process.env.npm_config_user_agent);
 
 //  check only for the first params to decide which to use
 switch (script) {
   //  allow npm to run script only
   case '--npm-only':
   case 'npmOnly':
-    require('../lib/check-npm')();
+    ensureNpm();
     break;
   //  allow yarn to run script only
   case '--yarn-only':
   case 'yarnOnly':
-    require('../lib/check-yarn')();
+    ensureYarn();
     break;
   //  auto detect if yarn or npm is more suitable according to lock files
   default:
@@ -37,5 +40,6 @@ switch (script) {
         `${chalk.yellow('Unrecognized Command')} "${chalk.red(script)}"`
       );
     }
+    console.log(process.env.npm_config_user_agent);
     console.log(helpText);
 }

lib/utils.js

@@ -1,5 +1,7 @@
 const debug = require('debug')('check-npm-client');
+const chalk = require('chalk');
 const findProcess = require('find-process');
+const parseNpmUserAgent = require('npm-config-user-agent-parser');
 
 /** find all ancestor process info by pid. If failed to failed to found ppid, then exit. */
 async function findAncestorProcessInfo (pid) {
@@ -10,15 +12,49 @@ async function findAncestorProcessInfo (pid) {
     const [info] = await findProcess('pid', id, true);
     //  cannot found this process info, or process is not invoked by node
     if (!info) {
-      console.log(`cannot found process info by id ${id}.`)
+      debug(`cannot found process info by id ${id}.`)
       finished = true;
     } else {
-      console.log(`====> round ${iteration++}`);
-      console.log(`pid = ${info.pid}, cmd = ${info.cmd}`, info);
+      debug(`round ${iteration++}`);
+      debug(`pid = ${info.pid}, cmd = ${info.cmd}`, info);
       id = info.ppid;
       // TODO: check npm client here
     }
   }
 }
 
-exports.debug = debug;
+/** get current npm client */
+function checkNpmClient (client) {
+  const current = parseNpmUserAgent(process.env.npm_config_user_agent);
+  // debug('parsed npm user agent:', current);
+  if (client === 'yarn' && !current.yarn
+    || client === 'npm' && !current.npm
+  ) {
+    return false;
+  }
+  return true;
+}
+
+function ensureYarn () {
+  if (!checkNpmClient('yarn')) {
+    console.error(`[check-npm-client] please use ${chalk.green('yarn')} instead of ${chalk.red('npm')}`);
+    process.exit(-1);
+  }
+  debug('the script is executed by yarn');
+}
+
+function ensureNpm () {
+  if (!checkNpmClient('npm')) {
+    console.error(`[check-npm-client] please use ${chalk.green('npm')} instead of ${chalk.red('yarn')}`);
+    process.exit(-1);
+  }
+  debug('the script is executed by npm');
+}
+
+module.exports = {
+  debug,
+  findAncestorProcessInfo,
+  checkNpmClient,
+  ensureYarn,
+  ensureNpm,
+};

package.json

@@ -18,8 +18,8 @@
   "dependencies": {
     "chalk": "^3.0.0",
     "debug": "^4.1.1",
-    "find-process": "^1.4.2"
+    "find-process": "^1.4.2",
+    "npm-config-user-agent-parser": "^1.0.0"
   },
-  "devDependencies": {
-  }
+  "devDependencies": {}
 }

test/fixture/auto/package.json

@@ -0,0 +1,12 @@
+{
+  "name": "check-npm-client-auto",
+  "version": "1.0.0",
+  "scripts": {
+    "precheckYarn": "../../../bin/cli --yarn-only",
+    "checkYarn": "node index.js",
+    "precheckNpm": "../../../bin/cli --npm-only",
+    "checkNpm": "node index.js",
+    "precheck":  "../../../bin/cli",
+    "check": "node index.js"
+  }
+}

test/fixture/npm-only/package.json

@@ -106,6 +106,18 @@ ms@^2.1.1:
   resolved "https://registry.npm.taobao.org/ms/download/ms-2.1.2.tgz?cache=0&other_urls=https%3A%2F%2Fregistry.npm.taobao.org%2Fms%2Fdownload%2Fms-2.1.2.tgz#d09d1f357b443f493382a8eb3ccd183872ae6009"
   integrity sha1-0J0fNXtEP0kzgqjrPM0YOHKuYAk=
 
+npm-config-user-agent-parser@^1.0.0:
+  version "1.0.0"
+  resolved "https://registry.npm.taobao.org/npm-config-user-agent-parser/download/npm-config-user-agent-parser-1.0.0.tgz#09d6a2fb3ab5c59af4135c6ee2da9c13ba7007d7"
+  integrity sha1-Cdai+zq1xZr0E1xu4tqcE7pwB9c=
+  dependencies:
+    semver "^5.5.0"
+
+semver@^5.5.0:
+  version "5.7.1"
+  resolved "https://registry.npm.taobao.org/semver/download/semver-5.7.1.tgz?cache=0&sync_timestamp=1565627380363&other_urls=https%3A%2F%2Fregistry.npm.taobao.org%2Fsemver%2Fdownload%2Fsemver-5.7.1.tgz#a954f931aeba508d307bbf069eff0c01c96116f7"
+  integrity sha1-qVT5Ma66UI0we78Gnv8MAclhFvc=
+
 supports-color@^5.3.0:
   version "5.5.0"
   resolved "https://registry.npm.taobao.org/supports-color/download/supports-color-5.5.0.tgz?cache=0&other_urls=https%3A%2F%2Fregistry.npm.taobao.org%2Fsupports-color%2Fdownload%2Fsupports-color-5.5.0.tgz#e2e69a44ac8772f78a1ec0b35b689df6530efc8f"