aiot-toolkit 2.0.1-alpha.9 → 2.0.2-beta.2

package/README.md

@@ -1,41 +1,44 @@
-# `aiot-toolkit`
+# 项目介绍
 
-> aiot-toolkit 命令行工具
+aiot-toolkit 2.0 是将 **源码项目** 转换为 **目标代码项目** 并生成 **目标代码应用** 的命令行工具，同时配备了 **模拟器** 相关功能供开发者使用。
 
-## 使用
+aiot-toolkit2.0目前支持的打包格式如下：
 
-## 贡献代码
+- ux：vela 平台下的应用，目前大量使用于小米手表、音箱等智能穿戴及物联网设备
 
-### 增加打包支持的项目
+## 安装使用
 
-1. 在`./src/builder` 中新增类文件 XBuilder，并实现 IBuilder接口
+- 全局安装
 
-```js
-import ParamType from '@aiot-toolkit/commander/lib/interface/IParam'
-import IBuild from './IBuild'
+  `npm i aiot-toolkit -g`
 
-class XBuilder implements IBuild {
-  params: ParamType[] = []
-  build(projectPath: string, options: any): void {
-    throw new Error('Method not implemented.')
-  }
-  match(projectPath: string): boolean {
-    throw new Error('Method not implemented.')
-  }
-}
-export default XBuilder
+  `npm i create-aiot -g`
 
-```
+- 创建项目
 
-2. 实现对应的方法
-3. 新增静态属性：
+  1. `create-aiot ux`
+  2. 在项目根目录执行：`npm i`
 
-```js
-static readonly PROJECT_TYPE = '项目类型的名称'
-```
+- 本机运行项目
 
-4. 在`./src/bin.ts` 的 `builderTypeList`中添加 XBuilder
+  在项目根目录执行 `aiot start`，此会启动模拟器，并运行项目
 
-```js
-const builderTypeList = [UxBuild, XtsBuild, XBuilder]
-```
+* 打包项目
+
+  在项目根目录执行 `aiot release`
+
+## 常用命令
+
+| 命令                     | 说明                     |
+| ------------------------ | ------------------------ |
+| npm create aiot          | 创建并手动选择项目       |
+| npm create aiot xts      | 创建xts项目              |
+| npm create aiot ux       | 创建ux项目               |
+| aiot build               | 构建项目                 |
+| aiot release             | 构建项目-release模式     |
+| aiot start               | 构建项目并运行到模拟器   |
+| aiot getConnectedDevices | 获取已连接设备列表       |
+| aiot getPlatforms        | 获取设置平台             |
+| aiot installDbgAndMkp    | 在真机上安装快应用调试器 |
+| aiot createVelaAvd       | 创建 vela 模拟器         |
+| aiot deleteVelaAvd       | 删除 vela 模拟器         |

package/lib/bin.js

@@ -13,22 +13,46 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-const commander_1 = require("@aiot-toolkit/commander");
-const shared_utils_1 = require("@aiot-toolkit/shared-utils");
+const semver_1 = __importDefault(require("semver"));
 const ColorConsole_1 = __importDefault(require("@aiot-toolkit/shared-utils/lib/ColorConsole"));
-const create_aiot_1 = require("create-aiot");
+// 支持的最低node版本
+const NODE_MINIMUM_VERSION = '16.0.0';
+checkVersion();
+const CompileMode_1 = __importDefault(require("@aiot-toolkit/aiotpack/lib/compiler/enum/CompileMode"));
+const commander_1 = require("@aiot-toolkit/commander");
+const fs_1 = __importDefault(require("fs"));
+const path_1 = __importDefault(require("path"));
+const UxBuilder_1 = __importDefault(require("./builder/UxBuilder"));
 const XtsBuilder_1 = __importDefault(require("./builder/XtsBuilder"));
-const GoldfishStarter_1 = __importDefault(require("./starter/GoldfishStarter"));
+const UxStarter_1 = __importDefault(require("./starter/UxStarter"));
+const XtsStarter_1 = __importDefault(require("./starter/XtsStarter"));
 const DeviceUtil_1 = __importDefault(require("./utils/DeviceUtil"));
 const VelaAvdUtils_1 = __importDefault(require("./utils/VelaAvdUtils"));
-const waiter_1 = __importDefault(require("./waiter"));
-// 配置支持的 builder 类型，新增的项目类型，只需在此处加上类型
-function findBuilder(projectPath) {
-    return new XtsBuilder_1.default();
+// 校验当前环境中的node
+function checkVersion() {
+    const currentVersion = process.versions.node;
+    if (semver_1.default.lt(currentVersion, NODE_MINIMUM_VERSION)) {
+        ColorConsole_1.default.throw('It is detected that the current NodeJS version ', { word: currentVersion }, ' is too low, please upgrade to NodeJS version higher than ', { word: NODE_MINIMUM_VERSION });
+        process.exit();
+    }
+}
+// 配置支持的 builder 类型，新增的项目类型，需在此处加上类型
+const projectMapper = {
+    ux: {
+        builder: UxBuilder_1.default,
+        starter: UxStarter_1.default
+    },
+    xts: {
+        builder: XtsBuilder_1.default,
+        starter: XtsStarter_1.default
+    }
+};
+function findBuilder() {
+    const projectType = getProjectType();
+    return new projectMapper[projectType].builder();
 }
 function build(command, description) {
-    const projectPath = process.cwd();
-    const builder = findBuilder(projectPath);
+    const builder = findBuilder();
     const paramList = builder === null || builder === void 0 ? void 0 : builder.params;
     return {
         name: command,
@@ -36,48 +60,60 @@ function build(command, description) {
         paramList,
         action: (option) => __awaiter(this, void 0, void 0, function* () {
             // 获取对应的 build；如果存在，执行 build 函数，不存在，提示
+            option.mode = command === 'release' ? CompileMode_1.default.PRODUCTION : CompileMode_1.default.DEVELOPMENT;
             const projectPath = process.cwd();
-            const builder = findBuilder(projectPath);
-            if (builder) {
-                const { watch } = option;
-                yield builder.build(projectPath, option);
-                if (watch) {
-                    waiter_1.default.describe();
-                    waiter_1.default.start();
-                }
-            }
-            else {
-                ColorConsole_1.default.log({
-                    message: `This type of project is not currently supported. The supported projects : xts`,
-                    level: shared_utils_1.LOG_LEVEL.Error,
-                    isOnlyPrintError: true
-                });
-            }
+            yield builder.build(projectPath, option);
         })
     };
 }
+function getProjectType() {
+    const projectPath = process.cwd();
+    const isXts = fs_1.default.existsSync(path_1.default.resolve(projectPath, 'app/app.xts'));
+    const isUx = fs_1.default.existsSync(path_1.default.resolve(projectPath, 'src/app.ux'));
+    if (isUx) {
+        return "ux" /* ProjectType.UX */;
+    }
+    else if (isXts) {
+        return "xts" /* ProjectType.XTS */;
+    }
+    return "ux" /* ProjectType.UX */;
+}
+function findStarter(command, description) {
+    const projectType = getProjectType();
+    return new projectMapper[projectType].starter(command, description);
+}
 function main() {
     return __awaiter(this, void 0, void 0, function* () {
-        const aiotCreate = yield (0, create_aiot_1.getAiotCreateCommand)();
         const config = {
             name: 'aiot-toolkit',
             description: 'contains build, dev, release, etc. commands for aiot toolkit',
-            version: '2.0.1',
+            version: require('../package.json').version,
             commandList: [
                 build('build', 'build project'),
-                new GoldfishStarter_1.default('start', 'start project').getParamList(),
+                build('release', 'release the project'),
+                findStarter('start', 'start project').getCommond(),
+                {
+                    name: 'watch',
+                    description: 'recompile project while file changes',
+                    action: (option) => __awaiter(this, void 0, void 0, function* () {
+                        const projectPath = process.cwd();
+                        const builder = findBuilder();
+                        option.watch = true;
+                        yield builder.build(projectPath, option);
+                        // waiter.describe()
+                        // waiter.start()
+                    })
+                },
                 {
                     name: 'getConnectedDevices',
                     description: 'get all connected devices',
-                    action: (option) => __awaiter(this, void 0, void 0, function* () {
+                    action: () => __awaiter(this, void 0, void 0, function* () {
                         try {
                             const connectedDevices = yield DeviceUtil_1.default.getAllConnectedDevices();
-                            ColorConsole_1.default.log({
-                                message: `The connected devices are: ${connectedDevices ? connectedDevices.join(', ') : 'null'}`
-                            });
+                            ColorConsole_1.default.info(`The connected devices are: ${connectedDevices ? connectedDevices.join(', ') : 'null'}`);
                         }
                         catch (error) {
-                            ColorConsole_1.default.log({ message: error.message, level: shared_utils_1.LOG_LEVEL.Error });
+                            ColorConsole_1.default.throw(`Error: getConnectedDevices failed`);
                         }
                     })
                 },
@@ -126,26 +162,44 @@ function main() {
                     action: (option) => __awaiter(this, void 0, void 0, function* () {
                         try {
                             const successMessage = yield DeviceUtil_1.default.installDbgAndMkp(option);
-                            ColorConsole_1.default.log({ message: successMessage, level: shared_utils_1.LOG_LEVEL.Success });
+                            ColorConsole_1.default.success(`${successMessage}`);
                         }
                         catch (error) {
-                            ColorConsole_1.default.log({ message: error.message, level: shared_utils_1.LOG_LEVEL.Error });
+                            ColorConsole_1.default.throw(`installDbgAndMkp failed, errorMessage: ${(error === null || error === void 0 ? void 0 : error.toString()) || 'unknown error'}'}`);
                         }
                     })
                 },
                 {
-                    name: 'createVelaAvd',
-                    description: 'create a vela avd instance',
+                    name: 'createVVD',
+                    description: 'create a vela virtual device',
                     action: () => __awaiter(this, void 0, void 0, function* () {
                         VelaAvdUtils_1.default.createVelaAvdByInquire();
                     })
                 },
-                Object.assign(Object.assign({}, aiotCreate), { name: 'create', description: 'create aiot project' })
+                {
+                    name: 'deleteVVD',
+                    description: 'delete vela virtual device(s)',
+                    paramList: [
+                        {
+                            name: 'avdNames',
+                            description: 'avd names to delete',
+                            enableInquirer: true,
+                            type: 'checkbox',
+                            choices: VelaAvdUtils_1.default.velaAvdCls.getVelaAvdList().map((item) => {
+                                return { name: item.avdName, value: item.avdName };
+                            })
+                        }
+                    ],
+                    action: (option) => __awaiter(this, void 0, void 0, function* () {
+                        const { avdNames } = option;
+                        avdNames.forEach((avdName) => {
+                            VelaAvdUtils_1.default.velaAvdCls.deleteVelaAvd(avdName);
+                        });
+                    })
+                }
             ]
         };
         commander_1.Command.registeProgram(config);
     });
 }
 main();
-
-//# sourceMappingURL=bin.js.map

package/lib/builder/IBuilder.js

@@ -1,4 +1,2 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-
-//# sourceMappingURL=IBuilder.js.map

package/lib/builder/UxBuilder.d.ts

@@ -5,6 +5,7 @@ import IBuilder from './IBuilder';
 interface IUxBuilderOption extends Dictionary {
     watch?: boolean;
     mode: CompileMode;
+    disabledJsc: boolean;
 }
 /**
  * UxBuilder

package/lib/builder/UxBuilder.js

@@ -8,6 +8,17 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         step((generator = generator.apply(thisArg, _arguments || [])).next());
     });
 };
+var __rest = (this && this.__rest) || function (s, e) {
+    var t = {};
+    for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
+        t[p] = s[p];
+    if (s != null && typeof Object.getOwnPropertySymbols === "function")
+        for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
+            if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
+                t[p[i]] = s[p[i]];
+        }
+    return t;
+};
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
@@ -15,11 +26,13 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const CompileMode_1 = __importDefault(require("@aiot-toolkit/aiotpack/lib/compiler/enum/CompileMode"));
 const JavascriptDefaultCompileOption_1 = __importDefault(require("@aiot-toolkit/aiotpack/lib/compiler/javascript/JavascriptDefaultCompileOption"));
 const UxConfig_1 = __importDefault(require("@aiot-toolkit/aiotpack/lib/config/UxConfig"));
-const ColorConsole2_1 = __importDefault(require("@aiot-toolkit/shared-utils/lib/ColorConsole2"));
+const shared_utils_1 = require("@aiot-toolkit/shared-utils");
+const ColorConsole_1 = __importDefault(require("@aiot-toolkit/shared-utils/lib/ColorConsole"));
 const file_lane_1 = require("file-lane");
 const fs_extra_1 = __importDefault(require("fs-extra"));
 const lodash_1 = __importDefault(require("lodash"));
 const path_1 = __importDefault(require("path"));
+const UxBuilderUtils_1 = __importDefault(require("../utils/UxBuilderUtils"));
 /**
  * UxBuilder
  */
@@ -32,6 +45,7 @@ class UxBuilder {
                 description: 'inject test-suite for current project'
             },
             {
+                type: 'string',
                 name: 'devtool',
                 description: 'source map config'
             },
@@ -43,8 +57,13 @@ class UxBuilder {
                 type: 'confirm',
                 name: 'disabled-jsc',
                 description: 'disabled jsc bundle',
-                defaultValue: true,
-                enableInquirer: true
+                defaultValue: false
+            },
+            {
+                name: 'enable-protobuf',
+                description: 'enable protobuf',
+                type: 'confirm',
+                defaultValue: false
             }
         ];
     }
@@ -56,24 +75,32 @@ class UxBuilder {
      */
     build(projectPath, options) {
         return __awaiter(this, void 0, void 0, function* () {
-            const { watch } = options;
+            const watch = options.watch || false;
             // 读取项目中文件的配置
             const quickappConfig = this.readQuickAppConfig(projectPath);
-            options = lodash_1.default.merge({}, options, quickappConfig === null || quickappConfig === void 0 ? void 0 : quickappConfig.cli);
+            const _a = quickappConfig || {}, { cli } = _a, otherConfig = __rest(_a, ["cli"]);
+            options = lodash_1.default.merge({}, options, cli);
             // 项目配置
             const uxProjectConfig = new UxConfig_1.default(projectPath);
             // 编译配置
+            const compileMode = options.mode || CompileMode_1.default.DEVELOPMENT;
             const compilerOption = lodash_1.default.merge({
                 projectPath: path_1.default.join(projectPath, uxProjectConfig.output),
-                mode: CompileMode_1.default.DEVELOPMENT,
-                disabledJSC: options.disabledJsc
-            }, JavascriptDefaultCompileOption_1.default, quickappConfig === null || quickappConfig === void 0 ? void 0 : quickappConfig.webpack);
-            ColorConsole2_1.default.info({
+                mode: compileMode,
+                disabledJSC: options.disabledJsc,
+                enableProtobuf: options.enableProtobuf,
+                devtool: UxBuilderUtils_1.default.getDevtoolValue(compileMode, options.devtool || false)
+            }, JavascriptDefaultCompileOption_1.default, otherConfig);
+            ColorConsole_1.default.info('start build: ', {
+                style: ColorConsole_1.default.getStyle(shared_utils_1.LOG_LEVEL.Info),
                 word: JSON.stringify({
-                    step: 'build ux',
                     projectPath,
                     options,
-                    watch
+                    watch,
+                    node: process.version,
+                    platform: process.platform,
+                    arch: process.arch,
+                    toolkit: require('../../package.json').version
                 }, null, 2)
             });
             // 开始编译项目
@@ -84,10 +111,11 @@ class UxBuilder {
         const path = path_1.default.join(projectPath, this.QUICKAPP_CONFIG);
         if (fs_extra_1.default.existsSync(path)) {
             try {
-                return fs_extra_1.default.readJsonSync(path);
+                const data = require(path);
+                return data;
             }
             catch (error) {
-                ColorConsole2_1.default.throw((error === null || error === void 0 ? void 0 : error.toString()) || '');
+                ColorConsole_1.default.throw((error === null || error === void 0 ? void 0 : error.toString()) || '');
             }
         }
         return;
@@ -98,5 +126,3 @@ class UxBuilder {
 }
 UxBuilder.PROJECT_TYPE = 'ux quick app';
 exports.default = UxBuilder;
-
-//# sourceMappingURL=UxBuilder.js.map

package/lib/builder/XtsBuilder.js

@@ -18,6 +18,7 @@ const shared_utils_1 = require("@aiot-toolkit/shared-utils");
 const ColorConsole_1 = __importDefault(require("@aiot-toolkit/shared-utils/lib/ColorConsole"));
 const StringUtil_1 = __importDefault(require("@aiot-toolkit/shared-utils/lib/utils/StringUtil"));
 const file_lane_1 = require("file-lane");
+const FileLaneUtil_1 = __importDefault(require("file-lane/lib/utils/FileLaneUtil"));
 const fs_1 = __importDefault(require("fs"));
 const path_1 = __importDefault(require("path"));
 /**
@@ -29,7 +30,7 @@ class XtsBuilder {
             {
                 name: 'skip',
                 type: 'string',
-                description: 'Can configure skip steps, comma separated, optional values: install (skip install pre-dependencies),ts2wasm (skip compilation), package (skip packaging)',
+                description: `Can configure skip steps, comma separated, optional values: ${ICompileOptions_1.skipList.join(',')}`,
                 validate(value) {
                     // TODO: validate 不起作用
                     const res = StringUtil_1.default.string2arrayByComma(value);
@@ -49,24 +50,41 @@ class XtsBuilder {
         return fs_1.default.existsSync(path_1.default.resolve(projectPath, 'app/app.xts'));
     }
     build(projectPath, options) {
+        var _a;
         return __awaiter(this, void 0, void 0, function* () {
-            const { watch } = options;
-            ColorConsole_1.default.log({
-                message: JSON.stringify({
-                    projectPath,
-                    options
-                }, undefined, 2),
-                level: shared_utils_1.LOG_LEVEL.Success
-            });
+            const watch = options.watch || false;
+            ColorConsole_1.default.success('Start build...\n', { word: 'ProjectPath: ', style: ColorConsole_1.default.getStyle(shared_utils_1.LOG_LEVEL.Success) }, projectPath, '\n', { word: 'buildOptions: ', style: ColorConsole_1.default.getStyle(shared_utils_1.LOG_LEVEL.Success) }, JSON.stringify(options));
             const compilerOptions = {
                 skip: StringUtil_1.default.string2arrayByComma(options.skip)
             };
             const config = new aiotpack_1.XtsConfig();
-            return new file_lane_1.FileLane(config, projectPath, compilerOptions).start({ watch });
+            if ((_a = compilerOptions.skip) === null || _a === void 0 ? void 0 : _a.includes('xts2ts')) {
+                ColorConsole_1.default.info("### skip compile xts to ts due to --skip ${compilerOptions?.skip.join(',')}");
+                const context = FileLaneUtil_1.default.createContext(config.output, projectPath);
+                const preWorks = config.preWorks || [];
+                for (let item of preWorks) {
+                    try {
+                        yield item(context, [], config, compilerOptions);
+                    }
+                    catch (error) {
+                        // 报错 prework的item error
+                    }
+                }
+                const follWorks = config.followWorks || [];
+                for (let item of follWorks) {
+                    try {
+                        yield item.worker(context, config, compilerOptions);
+                    }
+                    catch (error) {
+                        // 报错 prework的item error
+                    }
+                }
+            }
+            else {
+                return new file_lane_1.FileLane(config, projectPath, compilerOptions).start({ watch });
+            }
         });
     }
 }
 XtsBuilder.PROJECT_TYPE = 'xts quick app';
 exports.default = XtsBuilder;
-
-//# sourceMappingURL=XtsBuilder.js.map

package/lib/interface/CommandInterface.js

@@ -1,4 +1,2 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-
-//# sourceMappingURL=CommandInterface.js.map

package/lib/interface/VelaEmulatorInterface.d.ts

@@ -1,7 +1,12 @@
+export interface ISystemImagesVersionInfo {
+    release: string;
+    dev: string;
+}
+export type ISystemImagesType = keyof ISystemImagesVersionInfo;
 export interface IGoldfishVersionInfo {
     name: string;
     emulator: string;
-    'system-images': string;
+    'system-images': ISystemImagesVersionInfo;
     qa: string;
     skins: string;
     tools: string;

package/lib/interface/VelaEmulatorInterface.js

@@ -1,4 +1,2 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-
-//# sourceMappingURL=VelaEmulatorInterface.js.map

package/lib/starter/IStarter.d.ts

@@ -0,0 +1,23 @@
+import { ICommand, IParam } from '@aiot-toolkit/commander';
+/**
+ * IStarter
+ */
+export default abstract class IStarter<O = any> {
+    protected name: string;
+    protected description: string;
+    /**
+     * start 的参数列表
+     */
+    readonly params: IParam[];
+    constructor(name: string, description: string);
+    /**
+     * start 的命令
+     */
+    getCommond(): ICommand;
+    /**
+     * 运行项目
+     * @param projectPath 项目路径
+     * @param options 命令参数
+     */
+    abstract start(projectPath: string, options: O): void | Promise<void>;
+}

package/lib/starter/IStarter.js

@@ -0,0 +1,39 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+/**
+ * IStarter
+ */
+class IStarter {
+    constructor(name, description) {
+        this.name = name;
+        this.description = description;
+        /**
+         * start 的参数列表
+         */
+        this.params = [];
+    }
+    /**
+     * start 的命令
+     */
+    getCommond() {
+        return {
+            name: this.name,
+            description: this.description,
+            paramList: this.params,
+            action: (option) => __awaiter(this, void 0, void 0, function* () {
+                const projectPath = process.cwd();
+                this.start(projectPath, option);
+            })
+        };
+    }
+}
+exports.default = IStarter;

package/lib/starter/UxStarter.d.ts

@@ -0,0 +1,10 @@
+import ParamType from '@aiot-toolkit/commander/lib/interface/IParam';
+import { IStartOptions } from '@aiot-toolkit/emulator';
+import UxBuilder from '../builder/UxBuilder';
+import IStarter from './IStarter';
+declare class UxStarter extends IStarter<IStartOptions> {
+    builder: UxBuilder;
+    params: ParamType[];
+    start(projectPath: string, options: any): Promise<void>;
+}
+export default UxStarter;