wechatdevtools-cli.js

const path = require('path');
const fs = require('fs');

const Table = require('cli-table3');

const {
    consoleSeparator,
    findProcessPathFromCurrentProcessList,
    executeCmd
} = require('./util.js');

// 微信开发者工具默认安装目录
const DEFAULT_WECHATDEVTOOLS_INSTALL_PATH_WINDOWS = 'D:/Program Files (x86)/Tencent/微信web开发者工具';
const DEFAULT_WECHATDEVTOOLS_INSTALL_PATH_MacOs = '/Applications/wechatwebdevtools.app';

class WechatdevtoolsCli {
    /**
     * 微信开发者工具命令行
     * 
     * @param {string} cliPath 微信小程序开发者工具 CLI 的路径, 默认从当前进程中查找
     */
    constructor(cliPath) {
        this.cliPath = cliPath;

        this.processName = 'wechatdevtools';
        this.cliBin = (process.platform === 'win32') ? 'cli.bat' : 'cli';
    }

    /**
     * 尝试从当前进程中查找"微信Web开发者工具" cli 可执行文件的路径
     * 
     * @return {Promise<string>} cli 可执行文件的路径
     */
    tryFindCliPathFromCurrentProcessList() {
        return findProcessPathFromCurrentProcessList(this.processName).then((processPath) => {
            return path.resolve(path.dirname(processPath), this.cliBin);
        });
    }

    /**
     * 执行"微信Web开发者工具"的命令行工具
     * 
     * 也可以通过 HTTP 请求指示工具进行操作, 实现思路: http 服务在工具启动后自动开启，HTTP 服务端口号在用户目录下记录，可通过检查用户目录、检查用户目录下是否有端口文件及尝试连接来判断工具是否安装/启动。端口号文件位置：
     * - macOS : ~/Library/Application Support/微信web开发者工具/Default/.ide
     * - Windows : ~/AppData/Local/微信web开发者工具/User Data/Default/.ide
     * - require('os').homedir()
     * - https://github.com/pandolajs/pandora-boilerplate-wechat/blob/master/.pandora/scripts/utils/index.js
     * - https://github.com/pandolajs/pandora-boilerplate-wechat/blob/master/.pandora/scripts/release.js
     * 
     * @param {string} args 命令参数
     * @return {Promise}
     * @see https://developers.weixin.qq.com/miniprogram/dev/devtools/cli.html
     * @see https://developers.weixin.qq.com/miniprogram/dev/devtools/http.html
     */
    execute(args) {
        if (this.cliPath) {
            return this._executeCli(args);
        } else {
            return this.tryFindCliPathFromCurrentProcessList().then((cliPath) => {
                if (cliPath) {
                    this.cliPath = cliPath;
                } else {
                    console.log('Not find cliPath from process list, try use default cliPath');
                    this.cliPath = this._getDefaultCliPath();
                }

                return this._executeCli(args);
            }, (error) => {
                console.log('Find cliPath from process list fail', error);
                console.log('try use default cliPath');
                this.cliPath = this._getDefaultCliPath();

                return this._executeCli(args);
            });
        }
    }

    _executeCli(args) {
        if (this.cliPath) {
            console.log(consoleSeparator);
            console.log(`Use wechatdevtools cli: ${this.cliPath}`);
            console.log(consoleSeparator);

            return executeCmd(`"./${path.basename(this.cliPath)}" ${args}`, {
                cwd: path.dirname(this.cliPath)
            }).then(function(stout) {
                return stout;
            }, function(stderr) {
                return stderr;
            });
        } else {
            return Promise.reject('none cliPath');
        }
    }

    _getDefaultCliPath() {
        var cliPath = '';
        if (process.platform === 'win32') {
            cliPath = path.resolve(DEFAULT_WECHATDEVTOOLS_INSTALL_PATH_WINDOWS, this.cliBin);
        } else {
            cliPath = path.resolve(DEFAULT_WECHATDEVTOOLS_INSTALL_PATH_MacOs, 'Contents/MacOS', this.cliBin);
        }
        return cliPath;
    }

    /**
     * 提交预览
     * 
     * @param {string} projectRoot 项目根路径
     * @return {Promise} 预览的额外信息
     */
    preview(projectRoot) {
        var previewInfoOutput = path.resolve(process.cwd(), 'preview-info.json');
        var args = `-p ${path.resolve(projectRoot)} --preview-info-output "${previewInfoOutput}"`;

        return this.execute(args).then(function() {
            var previewInfo = {};
            try {
                if (fs.existsSync(previewInfoOutput)) {
                    previewInfo = JSON.parse(fs.readFileSync(previewInfoOutput));
                    console.log(consoleSeparator);
                    console.log(`本次预览的额外信息: ${JSON.stringify(previewInfo)}`);

                    fs.unlink(previewInfoOutput, function() {});
                }
            } catch (error) {
                console.error('Read preview info fail :(', error);
            }
            return previewInfo;
        });
    }

    /**
     * 上传代码
     * 
     * @param {string} projectRoot 项目根路径
     * @param {string} version 版本号
     * @param {string} desc 备注
     * @return {Promise} 上传的额外信息
     */
    upload(projectRoot, version, desc) {
        var uploadInfoOutput = path.resolve(process.cwd(), 'upload-info.json');
        var _projectRoot = path.resolve(projectRoot);
        var args = `-u ${version}@${_projectRoot} --upload-desc "${desc}" --upload-info-output "${uploadInfoOutput}"`;

        return this.execute(args).then(function() {
            var uploadInfo = {};
            try {
                if (fs.existsSync(uploadInfoOutput)) {
                    console.log(consoleSeparator);
                    var table = new Table({
                        head: ['时间', '项目', '版本号', '项目备注']
                    });
                    table.push([new Date().toLocaleString(), _projectRoot, version, desc]);
                    console.log(table.toString());

                    uploadInfo = JSON.parse(fs.readFileSync(uploadInfoOutput));
                    console.log(consoleSeparator);
                    console.log(`本次上传的额外信息: ${JSON.stringify(uploadInfo)}`);

                    fs.unlink(uploadInfoOutput, function() {});
                }
            } catch (error) {
                console.error('Read upload info fail :(', error);
            }

            return uploadInfo;
        });
    }
}

module.exports = WechatdevtoolsCli;