@shun-js/shun-cli 0.3.2 → 1.0.0

package/README.md

@@ -2,18 +2,18 @@
 
 shun.js cli tool
 
-## 安装
+## Install
 
 ```shell
 npm i -g @shun-js/shun-cli
 ```
 
-## 启动服务
+## Start servers
 
 ```shell
-# 启动，在feishu-grafana-alert.json所在目录下
-shunjs start @shun-js/feishu-grafana-alert
+# start a server (version is required), run in the directory containing config json files
+shunjs start @shun-js/feishu-bot@0.3.1
 
-# 可以启动多个服务
-shunjs start @shun-js/feishu-grafana-alert @shun-js/xxx
+# start multiple servers
+shunjs start @shun-js/feishu-bot@0.3.1 @shun-js/aitubiao-server@0.3.8
 ```

package/bin/log.js

@@ -0,0 +1,17 @@
+'use strict';
+
+const pc = require('picocolors');
+
+function info(msg) {
+  console.log(pc.gray(msg));
+}
+
+function success(msg) {
+  console.log(pc.green(msg));
+}
+
+function error(msg) {
+  console.log(pc.red(msg));
+}
+
+module.exports = { info, success, error };

package/bin/npm.js

@@ -0,0 +1,28 @@
+'use strict';
+
+const { execSync } = require('child_process');
+const log = require('./log.js');
+
+function installGlobal(pkgWithVersion) {
+  log.info(`npm i -g ${pkgWithVersion} ...`);
+  try {
+    const output = execSync(`npm i -g ${pkgWithVersion}`, { encoding: 'utf-8' });
+    console.log(output);
+  } catch (e) {
+    log.error(`npm global install failed: ${pkgWithVersion}`);
+    console.log(e.message);
+    process.exit(1);
+  }
+}
+
+function getGlobalPath() {
+  try {
+    return execSync('npm root -g', { encoding: 'utf-8' }).trim();
+  } catch (e) {
+    log.error('failed to get npm global path');
+    console.log(e.message);
+    process.exit(1);
+  }
+}
+
+module.exports = { installGlobal, getGlobalPath };

package/bin/parse.js

@@ -0,0 +1,25 @@
+'use strict';
+
+/**
+ * parseServer
+ * parse @shun-js/aitubiao-server@0.3.8
+ * return { pkg, version, name }
+ */
+function parseServer(input) {
+  const lastAt = input.lastIndexOf('@');
+
+  let pkg, version;
+  if (lastAt <= 0 || input.indexOf('@') === lastAt) {
+    return null;
+  } else {
+    pkg = input.slice(0, lastAt);
+    version = input.slice(lastAt + 1);
+  }
+
+  // pm2 process name: extract aitubiao-server from @shun-js/aitubiao-server
+  const name = pkg.split('/')[1] || pkg;
+
+  return { pkg, version, name };
+}
+
+module.exports = { parseServer };

package/bin/pm2.js

@@ -1,29 +1,71 @@
-// pm2
-const pm2 = require('pm2');
-
-// qiao
-const cli = require('qiao-cli');
+'use strict';
 
-/**
- * pm2Start
- * @param {*} options
- * @returns
- */
-exports.pm2Start = (options) => {
-  return new Promise((resolve, reject) => {
-    pm2.connect((error) => {
-      if (error) {
-        console.log(cli.colors.red('连接PM2失败。'));
-        console.log();
-        console.log(error);
+const pm2 = require('pm2');
+const { execSync } = require('child_process');
+const log = require('./log.js');
 
+function connect() {
+  return new Promise((resolve) => {
+    pm2.connect((err) => {
+      if (err) {
+        log.error('failed to connect pm2');
+        console.log(err);
         process.exit(2);
       }
+      resolve();
+    });
+  });
+}
+
+function disconnect() {
+  pm2.disconnect();
+}
+
+function isRunning(name) {
+  return new Promise((resolve) => {
+    pm2.list((err, list) => {
+      if (err) return resolve(false);
+      resolve(list.some((p) => p.name === name));
+    });
+  });
+}
 
-      pm2.start(options, function (error) {
-        pm2.disconnect();
-        return error ? reject(error) : resolve();
-      });
+function start(config) {
+  return new Promise((resolve, reject) => {
+    pm2.start(config, (err) => {
+      return err ? reject(err) : resolve();
     });
   });
-};
+}
+
+function reload(name) {
+  return new Promise((resolve, reject) => {
+    pm2.reload(name, (err) => {
+      return err ? reject(err) : resolve();
+    });
+  });
+}
+
+async function startOrReload(config) {
+  const running = await isRunning(config.name);
+  if (running) {
+    log.info(`process exists, reloading: ${config.name}`);
+    await reload(config.name);
+  } else {
+    log.info(`starting new process: ${config.name}`);
+    await start(config);
+  }
+}
+
+function save() {
+  try {
+    log.info('pm2 saving...');
+    execSync('pm2 save', { encoding: 'utf-8' });
+    log.success('pm2 saved');
+  } catch (e) {
+    log.error('pm2 save failed');
+    console.log(e.message);
+  }
+}
+
+module.exports = { connect, disconnect, startOrReload, save };

package/bin/shun.js

@@ -1,11 +1,85 @@
 #!/usr/bin/env node
 
-// qiao
-const cli = require('qiao-cli');
+'use strict';
 
-// cmds
-require('./shun-start.js');
-require('./shun-version.js');
+const path = require('path');
+const fs = require('fs');
+const { program } = require('commander');
 
-// parse
-cli.cmd.parse(process.argv);
+const { parseServer } = require('./parse.js');
+const log = require('./log.js');
+const npm = require('./npm.js');
+const pm2 = require('./pm2.js');
+
+// version
+program.version(require('../package.json').version, '-v, --version');
+
+// start
+program
+  .command('start <servers...>')
+  .description('install and start servers, e.g. @shun-js/xxx@1.0.0')
+  .action(async (servers) => {
+    try {
+      await pm2.connect();
+
+      for (const server of servers) {
+        await startServer(server);
+      }
+
+      pm2.save();
+    } catch (e) {
+      log.error('failed to start servers');
+      console.log(e);
+    } finally {
+      pm2.disconnect();
+    }
+  });
+
+async function startServer(input) {
+  const parsed = parseServer(input);
+  if (!parsed) {
+    log.error(`version is required: ${input}, e.g. ${input}@1.0.0`);
+    console.log();
+    return;
+  }
+
+  const { pkg, version, name } = parsed;
+  const pkgWithVersion = `${pkg}@${version}`;
+
+  log.info(`starting server: ${pkgWithVersion}`);
+
+  // 1. npm install -g
+  npm.installGlobal(pkgWithVersion);
+
+  // 2. 定位 app.js
+  const globalPath = npm.getGlobalPath();
+  const serverRoot = path.resolve(globalPath, pkg);
+  const appPath = path.resolve(serverRoot, 'app.js');
+
+  if (!fs.existsSync(appPath)) {
+    log.error(`app.js not found: ${appPath}`);
+    console.log();
+    return;
+  }
+
+  // 3. 查找配置文件
+  const configPath = path.resolve(process.cwd(), `${name}.json`);
+  if (!fs.existsSync(configPath)) {
+    log.error(`config not found: ${configPath}`);
+    console.log();
+    return;
+  }
+
+  // 4. pm2 startOrReload
+  await pm2.startOrReload({
+    name,
+    cwd: serverRoot,
+    script: appPath,
+    args: configPath,
+  });
+
+  log.success(`server started: ${pkgWithVersion}`);
+  console.log();
+}
+
+program.parse(process.argv);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@shun-js/shun-cli",
-  "version": "0.3.2",
+  "version": "1.0.0",
   "description": "shun.js cli",
   "keywords": [
     "shun.js",
@@ -23,14 +23,13 @@
     "bin"
   ],
   "dependencies": {
-    "debug": "^4.4.3",
-    "pm2": "^6.0.14",
-    "qiao-cli": "^5.0.0",
-    "qiao-file": "^5.0.6"
+    "commander": "^13.0.0",
+    "picocolors": "^1.1.0",
+    "pm2": "^6.0.14"
   },
   "publishConfig": {
     "access": "public",
     "registry": "https://registry.npmjs.org/"
   },
-  "gitHead": "4fa47fe5cf1b00acfe54f47af836101291093f06"
+  "gitHead": "4d325ef9b9573b53a35c857d237b91f9a3666353"
 }

package/bin/shun-start.js

@@ -1,94 +0,0 @@
-// path
-const path = require('path');
-
-// qiao
-const cli = require('qiao-cli');
-const { isExists } = require('qiao-file');
-
-// util
-const { getNPMGlobalPath } = require('./util.js');
-const { pm2Start } = require('./pm2.js');
-
-// debug
-const debug = require('debug')('@shun-js/shun-cli');
-
-// cmd
-cli.cmd
-  .command('start <servers...>')
-  .description('待启动的服务名')
-  .option('-m, --max', '使用集群模式，CPU核心数最大化')
-  .action(startServers);
-
-// start servers
-async function startServers(servers, options) {
-  try {
-    for (let i = 0; i < servers.length; i++) {
-      await startServer(servers[i], options);
-    }
-  } catch (error) {
-    console.log(cli.colors.red('启动服务出错。'));
-    console.log();
-    console.log(error);
-  }
-}
-
-// start servers
-async function startServer(serverName, options) {
-  const methodName = 'startServer';
-  console.log(cli.colors.gray(`开始启动服务：${serverName}`));
-
-  // check
-  if (!serverName.startsWith('@shun-js')) {
-    console.log(cli.colors.red(`非法服务：${serverName}`));
-    console.log();
-    return;
-  }
-
-  // check package
-  const npmGlobalPath = getNPMGlobalPath();
-  const serverRootPath = path.resolve(npmGlobalPath, `./${serverName}`);
-  const serverAppPath = path.resolve(serverRootPath, './app.js');
-  const serverAppPathIsExists = await isExists(serverAppPath);
-  debug(methodName, 'serverRootPath', serverRootPath);
-  debug(methodName, 'serverAppPath', serverAppPath);
-  debug(methodName, 'serverAppPathIsExists', serverAppPathIsExists);
-  if (!serverAppPathIsExists) {
-    console.log(cli.colors.red(`服务未安装：${serverName}`));
-    console.log();
-    return;
-  }
-
-  // check config
-  const workDir = process.cwd();
-  const serverConfigPrefix = serverName.split('/')[1];
-  const serverConfigPath = path.resolve(workDir, `./${serverConfigPrefix}.json`);
-  const serverConfigPathIsExists = await isExists(serverConfigPath);
-  debug(methodName, 'serverConfigPath', serverConfigPath);
-  debug(methodName, 'serverConfigPathIsExists', serverConfigPathIsExists);
-
-  // pm2
-  try {
-    const pm2Config = {
-      name: serverConfigPrefix,
-      cwd: serverRootPath,
-      script: serverAppPath,
-      args: serverConfigPath,
-    };
-
-    // 集群模式
-    if (options && options.max) {
-      pm2Config.instances = 'max';
-      pm2Config.exec_mode = 'cluster';
-    }
-
-    await pm2Start(pm2Config);
-  } catch (error) {
-    console.log(cli.colors.red(`服务启动失败：${serverName}`));
-    console.log();
-    console.log(error);
-  }
-
-  // r
-  console.log(cli.colors.green(`服务启动成功：${serverName}`));
-  console.log();
-}

package/bin/shun-version.js

@@ -1,5 +0,0 @@
-// qiao
-const cli = require('qiao-cli');
-
-// cmd
-cli.cmd.version(require('../package.json').version, '-v, --version').description('shun.js').usage('<command>');

package/bin/util.js

@@ -1,27 +0,0 @@
-// qiao
-const cli = require('qiao-cli');
-
-// cp
-const { execSync } = require('child_process');
-
-// debug
-const debug = require('debug')('shun.js');
-
-/**
- * getNPMGlobalPath
- * @returns
- */
-exports.getNPMGlobalPath = () => {
-  const methodName = 'getNPMRootPath';
-
-  try {
-    const npmGlobalPath = execSync('npm root -g').toString().trim();
-    debug(methodName, 'npmGlobalPath', npmGlobalPath);
-
-    return npmGlobalPath;
-  } catch (error) {
-    console.log(cli.colors.red('获取NPM全局路径出错。'));
-    console.log();
-    console.log(error);
-  }
-};