feat: init package structure

aprilandjan · aprilandjan · commit e9e486925819 · 2019-11-17T17:44:54.000+08:00
diff --git a/README.md b/README.md
@@ -9,3 +9,4 @@ This module helps to ensure using of [npm](https://github.com/npm/cli) or [yarn]
 - <https://github.com/timoxley/npm-which>
 - <https://github.com/npm/cli/issues/481>
 - <https://stackoverflow.com/questions/46725374/how-to-run-a-script-before-installing-any-npm-module>
+- <https://github.com/yarnpkg/yarn/issues/5063>
diff --git a/bin/cli.js b/bin/cli.js
@@ -0,0 +1,41 @@
+#!/usr/bin/env node
+
+const chalk = require('chalk');
+const { debug } = 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('Example')}
+  $ check-npm-client
+  $ check-npm-client --npm-only
+  $ check-npm-client --yarn-only
+`;
+
+const args = process.argv.slice(2);
+const script = args[0];
+
+debug('cmd:', process.cwd());
+debug('script:', script);
+
+//  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')();
+    break;
+  //  allow yarn to run script only
+  case '--yarn-only':
+  case 'yarnOnly':
+    require('../lib/check-yarn')();
+    break;
+  //  auto detect if yarn or npm is more suitable according to lock files
+  default:
+    if (script !== undefined) {
+      console.log(
+        `${chalk.yellow('Unrecognized Command')} "${chalk.red(script)}"`
+      );
+    }
+    console.log(helpText);
+}
diff --git a/check.js b/check.js
diff --git a/lib/check-npm.js b/lib/check-npm.js
@@ -0,0 +1,3 @@
+//  check if the current client is npm
+
+const { debug } = require('./utils');
diff --git a/lib/check-yarn.js b/lib/check-yarn.js
@@ -0,0 +1,5 @@
+//  check if the current client is yarn
+
+const { debug } = require('./utils');
+
+// TODO: to be implemented
diff --git a/lib/utils.js b/lib/utils.js
@@ -1,6 +1,8 @@
+const debug = require('debug')('check-npm-client');
 const findProcess = require('find-process');
 
-(async (pid) => {
+/** find all ancestor process info by pid. If failed to failed to found ppid, then exit. */
+async function findAncestorProcessInfo (pid) {
   let id = pid;
   let finished = false;
   let iteration = 1;
@@ -17,4 +19,6 @@ const findProcess = require('find-process');
       // TODO: check npm client here
     }
   }
-})(process.pid);
+}
+
+exports.debug = debug;
diff --git a/package.json b/package.json
@@ -1,14 +1,25 @@
 {
   "name": "check-npm-client",
   "version": "1.0.0",
-  "main": "index.js",
   "author": "aprilandjan",
   "license": "MIT",
+  "files": [
+    "bin"
+  ],
+  "engines": {
+    "node": ">=7.6.0"
+  },
+  "bin": {
+    "check-npm-client": "./bin/cli.js"
+  },
   "scripts": {
-    "preinstall": "node check.js",
     "check": "node check.js"
   },
   "dependencies": {
+    "chalk": "^3.0.0",
+    "debug": "^4.1.1",
     "find-process": "^1.4.2"
+  },
+  "devDependencies": {
   }
 }
diff --git a/test-process.js b/test-process.js
diff --git a/test/fixture/auto/package.json b/test/fixture/auto/package.json
@@ -0,0 +1,7 @@
+{
+  "name": "check-npm-client-auto",
+  "version": "1.0.0",
+  "scripts": {
+    "preinstall": "../../../bin/cli"
+  }
+}
diff --git a/test/fixture/npm-only/package.json b/test/fixture/npm-only/package.json
@@ -0,0 +1,7 @@
+{
+  "name": "check-npm-client-npm-only",
+  "version": "1.0.0",
+  "scripts": {
+    "preinstall": "../../../bin/cli --npm-only"
+  }
+}
diff --git a/test/fixture/yarn-only/package.json b/test/fixture/yarn-only/package.json
@@ -0,0 +1,7 @@
+{
+  "name": "check-npm-client-yarn-only",
+  "version": "1.0.0",
+  "scripts": {
+    "preinstall": "../../../bin/cli --yarn-only"
+  }
+}
diff --git a/tested-child.js b/tested-child.js
diff --git a/utils.js b/utils.js
diff --git a/yarn.lock b/yarn.lock
@@ -2,12 +2,25 @@
 # yarn lockfile v1
 
 
+"@types/color-name@^1.1.1":
+  version "1.1.1"
+  resolved "https://registry.npm.taobao.org/@types/color-name/download/@types/color-name-1.1.1.tgz#1c1261bbeaa10a8055bbc5d8ab84b7b2afc846a0"
+  integrity sha1-HBJhu+qhCoBVu8XYq4S3sq/IRqA=
+
 ansi-styles@^3.2.1:
   version "3.2.1"
   resolved "https://registry.npm.taobao.org/ansi-styles/download/ansi-styles-3.2.1.tgz?cache=0&sync_timestamp=1573557628456&other_urls=https%3A%2F%2Fregistry.npm.taobao.org%2Fansi-styles%2Fdownload%2Fansi-styles-3.2.1.tgz#41fbb20243e50b12be0f04b8dedbf07520ce841d"
   dependencies:
     color-convert "^1.9.0"
 
+ansi-styles@^4.1.0:
+  version "4.2.0"
+  resolved "https://registry.npm.taobao.org/ansi-styles/download/ansi-styles-4.2.0.tgz?cache=0&sync_timestamp=1573557674483&other_urls=https%3A%2F%2Fregistry.npm.taobao.org%2Fansi-styles%2Fdownload%2Fansi-styles-4.2.0.tgz#5681f0dcf7ae5880a7841d8831c4724ed9cc0172"
+  integrity sha1-VoHw3PeuWICnhB2IMcRyTtnMAXI=
+  dependencies:
+    "@types/color-name" "^1.1.1"
+    color-convert "^2.0.1"
+
 chalk@^2.0.1:
   version "2.4.2"
   resolved "https://registry.npm.taobao.org/chalk/download/chalk-2.4.2.tgz?cache=0&sync_timestamp=1573282918610&other_urls=https%3A%2F%2Fregistry.npm.taobao.org%2Fchalk%2Fdownload%2Fchalk-2.4.2.tgz#cd42541677a54333cf541a49108c1432b44c9424"
@@ -16,16 +29,36 @@ chalk@^2.0.1:
     escape-string-regexp "^1.0.5"
     supports-color "^5.3.0"
 
+chalk@^3.0.0:
+  version "3.0.0"
+  resolved "https://registry.npm.taobao.org/chalk/download/chalk-3.0.0.tgz?cache=0&sync_timestamp=1573282918610&other_urls=https%3A%2F%2Fregistry.npm.taobao.org%2Fchalk%2Fdownload%2Fchalk-3.0.0.tgz#3f73c2bf526591f574cc492c51e2456349f844e4"
+  integrity sha1-P3PCv1JlkfV0zEksUeJFY0n4ROQ=
+  dependencies:
+    ansi-styles "^4.1.0"
+    supports-color "^7.1.0"
+
 color-convert@^1.9.0:
   version "1.9.3"
   resolved "https://registry.npm.taobao.org/color-convert/download/color-convert-1.9.3.tgz?cache=0&sync_timestamp=1566248870121&other_urls=https%3A%2F%2Fregistry.npm.taobao.org%2Fcolor-convert%2Fdownload%2Fcolor-convert-1.9.3.tgz#bb71850690e1f136567de629d2d5471deda4c1e8"
   dependencies:
     color-name "1.1.3"
 
+color-convert@^2.0.1:
+  version "2.0.1"
+  resolved "https://registry.npm.taobao.org/color-convert/download/color-convert-2.0.1.tgz#72d3a68d598c9bdb3af2ad1e84f21d896abd4de3"
+  integrity sha1-ctOmjVmMm9s68q0ehPIdiWq9TeM=
+  dependencies:
+    color-name "~1.1.4"
+
 color-name@1.1.3:
   version "1.1.3"
   resolved "https://registry.npm.taobao.org/color-name/download/color-name-1.1.3.tgz#a7d0558bd89c42f795dd42328f740831ca53bc25"
 
+color-name@~1.1.4:
+  version "1.1.4"
+  resolved "https://registry.npm.taobao.org/color-name/download/color-name-1.1.4.tgz#c2a09a87acbde69543de6f63fa3995c826c536a2"
+  integrity sha1-wqCah6y95pVD3m9j+jmVyCbFNqI=
+
 commander@^2.11.0:
   version "2.20.3"
   resolved "https://registry.npm.taobao.org/commander/download/commander-2.20.3.tgz?cache=0&sync_timestamp=1573464028535&other_urls=https%3A%2F%2Fregistry.npm.taobao.org%2Fcommander%2Fdownload%2Fcommander-2.20.3.tgz#fd485e84c03eb4881c20722ba48035e8531aeb33"
@@ -36,6 +69,13 @@ debug@^2.6.8:
   dependencies:
     ms "2.0.0"
 
+debug@^4.1.1:
+  version "4.1.1"
+  resolved "https://registry.npm.taobao.org/debug/download/debug-4.1.1.tgz#3b72260255109c6b589cee050f1d516139664791"
+  integrity sha1-O3ImAlUQnGtYnO4FDx1RYTlmR5E=
+  dependencies:
+    ms "^2.1.1"
+
 escape-string-regexp@^1.0.5:
   version "1.0.5"
   resolved "https://registry.npm.taobao.org/escape-string-regexp/download/escape-string-regexp-1.0.5.tgz#1b61c0562190a8dff6ae3bb2cf0200ca130b86d4"
@@ -52,12 +92,29 @@ has-flag@^3.0.0:
   version "3.0.0"
   resolved "https://registry.npm.taobao.org/has-flag/download/has-flag-3.0.0.tgz#b5d454dc2199ae225699f3467e5a07f3b955bafd"
 
+has-flag@^4.0.0:
+  version "4.0.0"
+  resolved "https://registry.npm.taobao.org/has-flag/download/has-flag-4.0.0.tgz#944771fd9c81c81265c4d6941860da06bb59479b"
+  integrity sha1-lEdx/ZyByBJlxNaUGGDaBrtZR5s=
+
 ms@2.0.0:
   version "2.0.0"
   resolved "https://registry.npm.taobao.org/ms/download/ms-2.0.0.tgz?cache=0&other_urls=https%3A%2F%2Fregistry.npm.taobao.org%2Fms%2Fdownload%2Fms-2.0.0.tgz#5608aeadfc00be6c2901df5f9861788de0d597c8"
 
+ms@^2.1.1:
+  version "2.1.2"
+  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=
+
 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"
   dependencies:
     has-flag "^3.0.0"
+
+supports-color@^7.1.0:
+  version "7.1.0"
+  resolved "https://registry.npm.taobao.org/supports-color/download/supports-color-7.1.0.tgz?cache=0&other_urls=https%3A%2F%2Fregistry.npm.taobao.org%2Fsupports-color%2Fdownload%2Fsupports-color-7.1.0.tgz#68e32591df73e25ad1c4b49108a2ec507962bfd1"
+  integrity sha1-aOMlkd9z4lrRxLSRCKLsUHliv9E=
+  dependencies:
+    has-flag "^4.0.0"

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+// check if the current client is npm`
	`2`	`+`
	`3`	`+const { debug } = require('./utils');`