:feat: 增强 git 功能

Author: zyao89

.circleci/config.yml

@@ -2,7 +2,7 @@
 
 module.exports = {
     disabled: false,
-    git: '[email protected]:MicroAppJS/MicroApp-Plugin-Deploy-Command.git',
+    git: '[email protected]:MicroAppJS/MicroApp-Plugin-Deploy-Command.git', // repository,repo
     branch: {
         name: 'gh-pages',
         // extends: true,

micro-app.deploy.config.js

@@ -1,6 +1,6 @@
 {
     "name": "@micro-app/plugin-deploy-command",
-    "version": "0.1.1",
+    "version": "0.1.2",
     "description": "[Plugin] auto deploy command plugin.",
     "main": "src/index.js",
     "scripts": {
@@ -30,11 +30,10 @@
     },
     "license": "MIT",
     "peerDependencies": {
-        "@micro-app/core": ">=0.2.2"
+        "@micro-app/cli": ">=0.3.0"
     },
     "devDependencies": {
-        "@micro-app/cli": "0.2.0",
-        "@micro-app/core": "0.2.2",
+        "@micro-app/cli": "^0.3.0-alpha.2",
         "@types/jest": "^24.0.18",
         "babel-eslint": "^10.0.3",
         "coveralls": "^3.0.6",

package.json

@@ -2,7 +2,7 @@
 
 /* global expect */
 
-process.env.NODE_ENV = 'MICRO_APP_TEST';
+process.env.MICRO_APP_TEST = 'true';
 
 const path = require('path');
 

src/commands/deploy/deploy.test.js

@@ -9,6 +9,7 @@ module.exports = function(api, opts = {}) {
         usage: 'micro-app deploy [options]',
         options: {
             '-': 'deploy last commit',
+            '--type': '部署方式类型. (default: github)',
             '--message': 'git commit message.',
             '--name': 'git commit user name.',
             '--email': 'git commit user email.',
@@ -42,30 +43,49 @@ Config:
         cname: '', ${chalk.gray('// 如果是发布到自定义域名, default: false')}
     }
           `.trim(),
-    }, async args => {
+    }, args => {
         const _ = require('lodash');
         const logger = api.logger;
 
         const parseConfig = require('./parseConfig');
         const deployConfig = parseConfig(api, args, opts);
 
         if (_.isEmpty(deployConfig)) {
-            logger.error('无法加载到 Deploy 配置信息...');
+            logger.error('[Deploy]', '无法加载到 Deploy 配置信息...');
             return;
         }
 
         if (deployConfig && deployConfig.disabled) {
-            logger.info('已禁用命令行 Deploy...');
+            logger.info('[Deploy]', '已禁用命令行 Deploy...');
             return;
         }
 
-        api.applyPluginHooks('beforeCommandDeploy', { args, config: deployConfig });
+        // default: github
+        args.type = args.type || 'git';
 
-        const deployCommit = require('./deployCommit');
-        const result = await deployCommit(api, args, deployConfig);
+        let chain = Promise.resolve();
 
-        api.applyPluginHooks('afterCommandDeploy', { args, config: deployConfig });
-        return result;
+        chain = chain.then(() => api.applyPluginHooks('beforeCommandDeploy', { args, config: deployConfig }));
+
+        const type = args.type;
+        switch (type) {
+            case 'git':
+            case 'github':
+            {
+                const gitCMD = require('../git');
+                chain = chain.then(() => gitCMD(api, args, deployConfig));
+                break;
+            }
+            default:
+                chain = chain.then(() => {
+                    logger.warn('[Deploy]', `Not Found type: ${type}!`);
+                });
+                break;
+        }
+
+        chain = chain.then(() => api.applyPluginHooks('afterCommandDeploy', { args, config: deployConfig }));
+
+        return chain;
     });
 
 };

src/commands/deploy/index.js

@@ -46,7 +46,10 @@ function parseConfig(deployConfig, api, args) {
     const userEmail = args.email || args.userEmail || _.get(deployConfig, 'user.email') || '';
 
     const cname = deployConfig.cname || false;
-    const dist = args.dist || deployConfig.dist || false;
+
+    // dest，dist 相同
+    const dest = args.dest || deployConfig.dest || false;
+    const dist = dest || args.dist || deployConfig.dist || false;
 
     const _otherConfig = {
         type, disabled,

src/commands/deploy/parseConfig.js

@@ -2,7 +2,7 @@
 
 const shelljs = require('shelljs');
 const path = require('path');
-const { fs, _, chalk, tryRequire } = require('@micro-app/shared-utils');
+const { fs, _, chalk } = require('@micro-app/shared-utils');
 const CONSTANTS = require('../../constants');
 
 function execJS(execStr, options = {}) {
@@ -54,40 +54,6 @@ function createCNAMEFile({ deployConfig, deployDir }) {
     }
 }
 
-function modifyFile(api, { args, deployConfig, deployDir, gitURL, gitBranch, commitHash, gitUser, gitMessage }) {
-    const logger = api.logger;
-    const microAppConfig = api.self;
-
-    const pkgPath = path.resolve(deployDir, 'package.json');
-    const pkg = tryRequire(pkgPath) || {};
-    const { dependencies = {}, devDependencies = {} } = pkg;
-    const deps = Object.assign({}, dependencies, devDependencies);
-
-    const MICRO_APP_CONFIG_NAME = microAppConfig.packageName;
-    if (deps[MICRO_APP_CONFIG_NAME]) {
-        const gitp = deps[MICRO_APP_CONFIG_NAME];
-        // update
-        const ngitp = gitp.replace(/#[-_\d\w]+$/igm, `#${commitHash}`);
-
-        if (gitp === ngitp) { // not change
-            return false;
-        }
-        if (ngitp) {
-            if (dependencies[MICRO_APP_CONFIG_NAME]) {
-                dependencies[MICRO_APP_CONFIG_NAME] = ngitp;
-            }
-            if (devDependencies[MICRO_APP_CONFIG_NAME]) {
-                devDependencies[MICRO_APP_CONFIG_NAME] = ngitp;
-            }
-            fs.writeFileSync(pkgPath, JSON.stringify(pkg, null, 4), 'utf8');
-
-            return true;
-        }
-    }
-
-    return false;
-}
-
 async function clone(api, { deployDir, gitURL, gitBranch }) {
     const execStr = `git clone "${gitURL}" -b ${gitBranch} "${deployDir}"`;
     return await execJS(execStr);
@@ -115,7 +81,7 @@ async function push(api, { args, deployConfig, deployDir, gitURL, gitBranch, com
         throw new Error('modifyCommandDeployMessage() must be retrun { message } !!!');
     }
 
-    if (process.env.NODE_ENV === 'MICRO_APP_TEST') {
+    if (process.env.MICRO_APP_TEST) {
         api.logger.debug('MICRO_APP_TEST --> Exit!!!');
         return;
     }
@@ -126,9 +92,7 @@ async function push(api, { args, deployConfig, deployDir, gitURL, gitBranch, com
 }
 
 async function setup(deployDir) {
-    if (!fs.existsSync(deployDir)) {
-        fs.mkdirpSync(deployDir);
-    }
+    await fs.ensureDir(deployDir);
     await fs.emptyDir(deployDir);
 
     const execStr = 'git init';
@@ -152,10 +116,11 @@ async function runDeploy(api, { args, deployConfig, deployDir, gitURL, gitBranch
         await setup(deployDir);
         const hasDist = deployConfig.dist;
         let bModify = false;
-        if (!hasDist) { // 需要 clone
+        if (!hasDist) { // 需要 clone, 且自动修改 package.json
             spinner.text = 'Cloning...';
             await clone(api, { args, deployConfig, deployDir, gitURL, gitBranch, commitHash, gitUser });
             spinner.text = 'Modify files...';
+            const modifyFile = require('./modifyFile');
             bModify = modifyFile(api, { args, deployConfig, deployDir, gitURL, gitBranch, commitHash, gitUser, gitMessage });
         } else { // copy dist to deployDir
             const opts = {};
@@ -233,10 +198,11 @@ module.exports = async function deployCommit(api, args, deployConfigs) {
             if (!bSuccessful) {
                 logger.error(`Fail [${index}]! Check your config, please!`);
             }
-            // 清空
-            if (fs.existsSync(deployDir)) {
-                fs.removeSync(deployDir);
-            }
+        }
+
+        // 清空
+        if (fs.existsSync(deployDir)) {
+            fs.removeSync(deployDir);
         }
 
         return params;

src/commands/deploy/deployCommit.js src/commands/git/index.jssrc/commands/deploy/deployCommit.js renamed to src/commands/git/index.js

@@ -0,0 +1,43 @@
+'use strict';
+
+const path = require('path');
+const { fs, tryRequire } = require('@micro-app/shared-utils');
+
+module.exports = modifyFile;
+
+// TODO 需要匹配新版本
+function modifyFile(api, { args, deployConfig, deployDir, gitURL, gitBranch, commitHash, gitUser, gitMessage }) {
+    const logger = api.logger;
+    const microAppConfig = api.self;
+
+    const pkgPath = path.resolve(deployDir, 'package.json');
+    logger.info('[Deploy]', `modify file "${pkgPath}"`);
+
+    const pkg = tryRequire(pkgPath) || {};
+    const { dependencies = {}, devDependencies = {} } = pkg;
+    const deps = Object.assign({}, dependencies, devDependencies);
+
+    const MICRO_APP_CONFIG_NAME = microAppConfig.packageName;
+    if (deps[MICRO_APP_CONFIG_NAME]) {
+        const gitp = deps[MICRO_APP_CONFIG_NAME];
+        // update
+        const ngitp = gitp.replace(/#[-_\d\w]+$/igm, `#${commitHash}`);
+
+        if (gitp === ngitp) { // not change
+            return false;
+        }
+        if (ngitp) {
+            if (dependencies[MICRO_APP_CONFIG_NAME]) {
+                dependencies[MICRO_APP_CONFIG_NAME] = ngitp;
+            }
+            if (devDependencies[MICRO_APP_CONFIG_NAME]) {
+                devDependencies[MICRO_APP_CONFIG_NAME] = ngitp;
+            }
+            fs.writeFileSync(pkgPath, JSON.stringify(pkg, null, 4), 'utf8');
+
+            return true;
+        }
+    }
+
+    return false;
+}

src/commands/git/modifyFile.js

@@ -1,7 +1,6 @@
 'use strict';
 
 const commands = [
-    'version',
     'deploy',
 ];