@zhennann/common-bin 3.0.0 → 4.0.0

package/README.md

@@ -1,6 +1,7 @@
 # common-bin
 
 [![NPM version][npm-image]][npm-url]
+[![Node.js CI](https://github.com/node-modules/common-bin/actions/workflows/nodejs.yml/badge.svg)](https://github.com/node-modules/common-bin/actions/workflows/nodejs.yml)
 [![Test coverage][codecov-image]][codecov-url]
 [![Known Vulnerabilities][snyk-image]][snyk-url]
 [![npm download][download-image]][download-url]
@@ -14,7 +15,7 @@
 [download-image]: https://img.shields.io/npm/dm/common-bin.svg?style=flat-square
 [download-url]: https://npmjs.org/package/common-bin
 
-Abstraction bin tool wrap [yargs](http://yargs.js.org/), to provide more convenient usage, support async / generator.
+Abstraction bin tool wrap [yargs](http://yargs.js.org/), to provide more convenient usage, support async / await style.
 
 ---
 
@@ -106,7 +107,7 @@ class CloneCommand extends Command {
     };
   }
 
-  * run({ argv }) {
+  async run({ argv }) {
     console.log('git clone %s to %s with depth %d', argv._[0], argv._[1], argv.depth);
   }
 
@@ -134,8 +135,8 @@ Define the main logic of command
 
 **Method:**
 
-- `start()` - start your program, only use once in your bin file.
-- `run(context)`
+- `async start()` - start your program, only use once in your bin file.
+- `async run(context)`
   - should implement this to provide command handler, will exec when not found sub command.
   - Support generator / async function / normal function which return promise.
   - `context` is `{ cwd, env, argv, rawArgv }`
@@ -194,10 +195,10 @@ get version() {
 
 ### Helper
 
-- `forkNode(modulePath, args, opt)` - fork child process, wrap with promise and gracefull exit
-- `spawn(cmd, args, opt)` - spawn a new process, wrap with promise and gracefull exit
-- `npmInstall(npmCli, name, cwd)` - install node modules, wrap with promise
-- `* callFn(fn, args, thisArg)` - call fn, support gernerator / async / normal function return promise
+- `async forkNode(modulePath, args, opt)` - fork child process, wrap with promise and gracefull exit
+- `async spawn(cmd, args, opt)` - spawn a new process, wrap with promise and gracefull exit
+- `async npmInstall(npmCli, name, cwd)` - install node modules, wrap with promise
+- `async callFn(fn, args, thisArg)` - call fn, support gernerator / async / normal function return promise
 - `unparseArgv(argv, opts)` - unparse argv and change it to array style
 
 **Extend Helper**
@@ -237,7 +238,7 @@ class MainCommand extends Command {
     };
   }
 
-  * run(context) {
+  async run(context) {
     console.log('run default command at %s', context.argv.baseDir);
   }
 }
@@ -257,7 +258,7 @@ class RemoteCommand extends Command {
     this.load(path.join(__dirname, 'remote'));
   }
 
-  * run({ argv }) {
+  async run({ argv }) {
     console.log('run remote command with %j', argv._);
   }
 
@@ -281,7 +282,7 @@ class AddCommand extends Command {
 
   }
 
-  * run({ argv }) {
+  async run({ argv }) {
     console.log('git remote add %s to %s with tags=%s', argv.name, argv.url, argv.tags);
   }
 
@@ -298,7 +299,6 @@ see [remote.js](test/fixtures/my-git/command/remote.js) for more detail.
 
 ```js
 class SleepCommand extends Command {
-
   async run() {
     await sleep('1s');
     console.log('sleep 1s');
@@ -316,7 +316,6 @@ function sleep(ms) {
 
 see [async-bin](test/fixtures/async-bin) for more detail.
 
-
 ### Bash-Completions
 
 ```bash
@@ -329,7 +328,7 @@ $ my-git completion >> ~/.bashrc
 ![Bash-Completions](https://cloud.githubusercontent.com/assets/227713/23980327/0a00e1a0-0a3a-11e7-81be-23b4d54d91ad.gif)
 
 
-## Migrating from v1 to v2
+## Migrating from v1 to v3
 
 ### bin
 
@@ -340,7 +339,7 @@ $ my-git completion >> ~/.bashrc
 const run = require('common-bin').run;
 run(require('../lib/my_program'));
 
-// 2.x
+// 3.x
 // require a main Command
 const Command = require('..');
 new Command().start();
@@ -356,7 +355,7 @@ new Command().start();
 // 1.x
 this.addCommand('test', path.join(__dirname, 'test_command.js'));
 
-// 2.x
+// 3.x
 const Command = require('common-bin');
 const pkg = require('./package.json');
 
@@ -375,7 +374,7 @@ class MainCommand extends Command {
 
 - `help()` is not use anymore.
 - should provide `name`, `description`, `options`.
-- `* run()` arguments had change to object, recommand to use destructuring style - `{ cwd, env, argv, rawArgv }`
+- `async run()` arguments had change to object, recommand to use destructuring style - `{ cwd, env, argv, rawArgv }`
   - `argv` is an object parse by `yargs`, **not `args`.**
   - `rawArgv` is equivalent to old `args`
 
@@ -387,7 +386,7 @@ class TestCommand extends Command {
   }
 }
 
-// 2.x
+// 3.x
 class TestCommand extends Command {
   constructor() {
     super();
@@ -399,7 +398,7 @@ class TestCommand extends Command {
     };
   }
 
-  * run({ cwd, env, argv, rawArgv }) {
+  async run({ cwd, env, argv, rawArgv }) {
     console.log('run mocha test at %s with %j', cwd, argv);
   }
 
@@ -425,6 +424,6 @@ class TestCommand extends Command {
 | :---: | :---: | :---: | :---: | :---: | :---: |
 [<img src="https://avatars.githubusercontent.com/u/7477670?v=4" width="100px;"/><br/><sub><b>tenpend</b></sub>](https://github.com/tenpend)<br/>|[<img src="https://avatars.githubusercontent.com/u/6399899?v=4" width="100px;"/><br/><sub><b>hacke2</b></sub>](https://github.com/hacke2)<br/>|[<img src="https://avatars.githubusercontent.com/u/11896359?v=4" width="100px;"/><br/><sub><b>liuqipeng417</b></sub>](https://github.com/liuqipeng417)<br/>|[<img src="https://avatars.githubusercontent.com/u/36788851?v=4" width="100px;"/><br/><sub><b>Jarvis2018</b></sub>](https://github.com/Jarvis2018)<br/>
 
-This project follows the git-contributor [spec](https://github.com/xudafeng/git-contributor), auto updated at `Wed Feb 09 2022 22:35:03 GMT+0800`.
+This project follows the git-contributor [spec](https://github.com/xudafeng/git-contributor), auto updated at `Sat Jun 04 2022 00:31:29 GMT+0800`.
 
-<!-- GITCONTRIBUTOR_END -->
+<!-- GITCONTRIBUTOR_END -->

package/index.d.ts

@@ -81,7 +81,7 @@ declare class CommonBin {
    * @param {String|Class} target - special file path (must contains ext) or Command Class
    * @example `add('test', path.join(__dirname, 'test_command.js'))`
    */
-  add(name: string, target: string | CommonBin): void;
+  add(name: string, target: string | typeof CommonBin): void;
 
   /**
    * alias an existing command

package/lib/command.js

@@ -1,7 +1,6 @@
 'use strict';
 
 const debug = require('debug')('common-bin');
-const co = require('co');
 const yargs = require('yargs');
 const parser = require('yargs-parser');
 const helper = require('./helper');
@@ -9,7 +8,7 @@ const assert = require('assert');
 const fs = require('fs');
 const path = require('path');
 const semver = require('semver');
-const changeCase = require('change-case');
+const { camelCase } = require('change-case');
 const chalk = require('chalk');
 
 const DISPATCH = Symbol.for('eb:Command#dispatch');
@@ -128,16 +127,18 @@ class CommonBin {
   /**
    * start point of bin process
    */
-  start() {
-    co(function* () {
+  async start() {
+    try {
       // replace `--get-yargs-completions` to our KEY, so yargs will not block our DISPATCH
       const index = this.rawArgv.indexOf('--get-yargs-completions');
       if (index !== -1) {
         // bash will request as `--get-yargs-completions my-git remote add`, so need to remove 2
         this.rawArgv.splice(index, 2, `--AUTO_COMPLETIONS=${this.rawArgv.join(',')}`);
       }
-      yield this[DISPATCH]();
-    }.bind(this)).catch(this.errorHandler.bind(this));
+      await this[DISPATCH]();
+    } catch (err) {
+      this.errorHandler(err);
+    }
   }
 
   /**
@@ -203,7 +204,7 @@ class CommonBin {
    * @param {Array} context.rawArgv - the raw argv, `[ "--baseDir=simple" ]`
    * @private
    */
-  * [DISPATCH]() {
+  async [DISPATCH]() {
     // define --help and --version by default
     const _yargs = this.yargs
       // .reset()
@@ -220,7 +221,7 @@ class CommonBin {
     }
 
     // get parsed argument without handling helper and version
-    const parsed = yield this[PARSE](this.rawArgv);
+    const parsed = await this[PARSE](this.rawArgv);
     const commandName = parsed._[0];
 
     if (parsed.version && this.version) {
@@ -237,7 +238,7 @@ class CommonBin {
       debug('[%s] dispatch to subcommand `%s` -> `%s` with %j', this.constructor.name, commandName, Command.name, rawArgv);
       const command = this.getSubCommandInstance(Command, rawArgv);
       this.subCommand = command; // by zhennann
-      yield command[DISPATCH]();
+      await command[DISPATCH]();
       return;
     }
 
@@ -253,12 +254,11 @@ class CommonBin {
     if (context.argv.AUTO_COMPLETIONS) {
       // slice to remove `--AUTO_COMPLETIONS=` which we append
       this.yargs.getCompletion(this.rawArgv.slice(1), completions => {
-        // console.log('%s', completions)
         completions.forEach(x => console.log(x));
       });
     } else {
       // handle by self
-      yield this.helper.callFn(this.run, [ context ], this);
+      await this.helper.callFn(this.run, [ context ], this);
     }
   }
 
@@ -299,7 +299,7 @@ class CommonBin {
     if (this.parserOptions.removeCamelCase) {
       for (const key of Object.keys(argv)) {
         if (key.includes('-')) {
-          argv[changeCase.camel(key)] = undefined;
+          argv[camelCase(key)] = undefined;
         }
       }
     }
@@ -328,7 +328,7 @@ class CommonBin {
       // remove from origin argv
       for (const key of Object.keys(execArgvObj)) {
         argv[key] = undefined;
-        argv[changeCase.camel(key)] = undefined;
+        argv[camelCase(key)] = undefined;
       }
 
       // exports execArgv

package/lib/helper.js

@@ -106,7 +106,7 @@ exports.spawn = (cmd, args = [], options = {}) => {
  * @param {String} cwd - target directory
  * @return {Promise} err or undefined
  */
-exports.npmInstall = (npmCli, name, cwd) => {
+exports.npmInstall = async (npmCli, name, cwd) => {
   const options = {
     stdio: 'inherit',
     env: process.env,
@@ -116,25 +116,25 @@ exports.npmInstall = (npmCli, name, cwd) => {
   const args = [ 'i', name ];
   console.log('[common-bin] `%s %s` to %s ...', npmCli, args.join(' '), options.cwd);
 
-  return exports.spawn(npmCli, args, options);
+  return await exports.spawn(npmCli, args, options);
 };
 
 /**
  * call fn
  * @function helper#callFn
- * @param {Function} fn - support generator / async / normal function return promise
+ * @param {Function} fn - support async / normal function return promise
  * @param {Array} [args] - fn args
  * @param {Object} [thisArg] - this
  * @return {Object} result
  */
-exports.callFn = function* (fn, args = [], thisArg) {
+exports.callFn = async (fn, args = [], thisArg) => {
   if (!is.function(fn)) return;
   if (is.generatorFunction(fn)) {
-    return yield fn.apply(thisArg, args);
+    throw new TypeError('helper.callFn don\'t support generator function');
   }
   const r = fn.apply(thisArg, args);
   if (is.promise(r)) {
-    return yield r;
+    return await r;
   }
   return r;
 };

package/package.json

@@ -1,33 +1,27 @@
 {
   "name": "@zhennann/common-bin",
-  "version": "3.0.0",
+  "version": "4.0.0",
   "description": "Abstraction bin tool",
   "main": "index.js",
   "dependencies": {
-    "@types/dargs": "^5.1.0",
-    "@types/node": "^10.12.18",
-    "@types/yargs": "^12.0.4",
-    "chalk": "^3.0.0",
-    "change-case": "^3.0.2",
-    "co": "^4.6.0",
-    "dargs": "^6.0.0",
-    "debug": "^4.1.0",
+    "chalk": "^4.1.2",
+    "change-case": "^4.1.2",
+    "dargs": "^7.0.0",
+    "debug": "^4.3.4",
     "is-type-of": "^1.2.1",
-    "semver": "^5.5.1",
+    "semver": "^7.3.7",
     "yargs": "^13.3.0",
     "yargs-parser": "^13.1.2"
   },
   "devDependencies": {
-    "autod": "^3.0.1",
-    "coffee": "^5.1.0",
-    "egg-bin": "^4.17.0",
-    "egg-ci": "^1.19.0",
-    "eslint": "^5.6.1",
-    "eslint-config-egg": "^7.1.0",
-    "git-contributor": "^1.0.10",
-    "mm": "^2.4.1",
-    "rimraf": "^2.6.2",
-    "typescript": "^3.2.2"
+    "@types/node": "^18.15.3",
+    "coffee": "^5.4.0",
+    "egg-bin": "^5.12.2",
+    "eslint": "^8.31.0",
+    "eslint-config-egg": "^12.1.0",
+    "git-contributor": "2",
+    "mm": "^3.2.1",
+    "typescript": "^4.7.2"
   },
   "repository": {
     "type": "git",
@@ -38,29 +32,19 @@
   "license": "MIT",
   "scripts": {
     "contributor": "git-contributor",
-    "autod": "autod",
-    "clean": "rimraf coverage",
     "lint": "eslint .",
     "test": "npm run lint -- --fix && npm run test-local",
     "test-local": "egg-bin test",
     "cov": "egg-bin cov",
-    "ci": "npm run clean && npm run lint && egg-bin cov"
+    "ci": "npm run lint && egg-bin cov"
   },
   "engines": {
-    "node": ">= 6.0.0"
+    "node": ">= 14.0.0"
   },
   "files": [
     "lib",
     "index.d.ts",
     "index.js"
   ],
-  "types": "index.d.ts",
-  "ci": {
-    "version": "8, 10, 12, 14, 16",
-    "type": "github",
-    "license": {
-      "year": "2017",
-      "fullname": "node-modules and other contributors"
-    }
-  }
+  "types": "index.d.ts"
 }