Merge pull request #2 from zyao89/develop

🐛 fixed show env.

Author: zyao89

README.md

@@ -1,4 +1,14 @@
-# Micro APP
+# Micro APP CLI
+
+Pluggable application framework.
+
+[![NPM Version][npm-img]][npm-url]
+[![NPM Download][download-img]][download-url]
+
+[npm-img]: https://img.shields.io/npm/v/@micro-app/cli.svg?style=flat-square
+[npm-url]: https://npmjs.org/package/@micro-app/cli
+[download-img]: https://img.shields.io/npm/dm/@micro-app/cli.svg?style=flat-square
+[download-url]: https://npmjs.org/package/@micro-app/cli
 
 ## Install
 
@@ -35,11 +45,13 @@ module.exports = {
         // },
     },
 
-    entry: {
+    staticPath: [], // String | Array
+
+    entry: { // 入口
         main: './test/index.js',
     },
 
-    htmls: [
+    htmls: [ // 输出模版配置
         {
             template: './test/index.js',
         },
@@ -51,7 +63,7 @@ module.exports = {
     //     },
     // ],
 
-    alias: { // 前端
+    alias: { // 别名配置
         api: '',
         config: {
             link: '',
@@ -64,7 +76,7 @@ module.exports = {
         },
     },
 
-    strict: true,
+    strict: true, // 严格强依赖模式
 
     micros: [ 'test' ], // 被注册的容器
     // micros$$test: { // 单独配置
@@ -82,7 +94,7 @@ module.exports = {
         },
     },
 
-    plugins: [
+    plugins: [ // 自定义插件
         // [{
         //     id: 'test',
         //     description: '这是test',
@@ -156,22 +168,191 @@ const api = require('@micro-demo/api');
 
 ## Plugins 扩展
 
+### 首先在 micro-app.config.js 中注册插件
+
+```js
+plugins: [
+        [ // 1
+            {
+                id: 'test', // 插件 id
+                description: '这是test', // 插件描述
+                link: __dirname + '/test/testPlugin.js',  // 插件地址
+            }, { // 注册入的 opts
+                a: 1,
+            }
+        ],
+    ],
+```
+
+### 插件文件 `testPlugin.js`
+
+文件必须返回一个方法.
+
+```js
+module.exports = function(api, opts) {
+    console.log(opts);
+    api.onInitDone(item => {
+        console.log('init Done', item);
+    });
+    api.onInitDone(() => {
+        console.log('init Done2', api.getState('webpackConfig'));
+    });
+    api.onPluginInitDone(item => {
+        console.log('onPluginInitDone', item);
+    });
+    api.beforeMergeWebpackConfig(item => {
+        console.log('beforeMergeWebpackConfig', item);
+    });
+    api.afterMergeWebpackConfig(item => {
+        console.log('afterMergeWebpackConfig', item);
+    });
+    // api.onChainWebpcakConfig(webpackChainConfig => {
+    //     console.log('onChainWebpcakConfig', webpackChainConfig);
+    // });
+};
+```
+
+### 内置部分插件提供的 api 方法
+
+可通过如下命令进行动态查看
+
+```js
+npx micro-app show methods
+```
+
+以提供的方法如下, `System Build-in` 为内置方法
+
+```js
+╰─➤  npx micro-app show methods
+  Plugin Methods:
+     * onPluginInitDone            ( System Build-in )
+     * beforeMergeConfig           ( System Build-in )
+     * afterMergeConfig            ( System Build-in )
+     * beforeMergeServerConfig     ( System Build-in )
+     * afterMergeServerConfig      ( System Build-in )
+     * onInitWillDone              ( System Build-in )
+     * onInitDone                  ( System Build-in )
+     * modifyCommand               ( System Build-in )
+     * onRunCommand                ( System Build-in )
+     * modifyCommandHelp           ( System Build-in )
+     * beforeMergeWebpackConfig    ( 合并 webpack 配置之前事件 )
+     * afterMergeWebpackConfig     ( 合并 webpack 配置之后事件 )
+     * modifyChainWebpcakConfig    ( 合并之后提供 webpack-chain 进行再次修改事件 )
+     * onChainWebpcakConfig        ( 修改之后提供 webpack-chain 进行查看事件 )
+     * onServerInit                ( 服务初始化时事件 )
+     * onServerInitDone            ( 服务初始化完成事件 )
+     * onServerRunSuccess          ( 服务运行启动成功时事件 )
+     * onServerRunFail             ( 服务运行启动失败时事件 )
+     * beforeServerEntry           ( 服务进入业务逻辑前事件 )
+     * afterServerEntry            ( 服务从业务逻辑出来后事件 )
+     * modifyWebpackCompiler       ( 对服务启动前对 webpack compiler 进行修改, 需要返回所有参数 )
+     * beforeDevServer             ( 开发服务创建前事件 )
+     * afterDevServer              ( 开发服务创建后事件 )
+     * onBuildSuccess              ( 构建成功时事件 )
+     * onBuildFail                 ( 构建失败时事件 )
+     * beforeBuild                 ( 开始构建前事件 )
+     * afterBuild                  ( 构建结束后事件 )
+     * beforeCommandUpdate         ( 开始更新前事件 )
+     * afterCommandUpdate          ( 更新完毕后事件 )
+     * beforeCommandDeploy         ( 发布前事件 )
+     * afterCommandDeploy          ( 发布后事件 )
+     * modifyCommandDeployMessage  ( 发布消息二次编辑事件 )
+
+// 以下为针对 vusion 类型的方法
+     * modifyVusionConfig          ( 对服务启动前对 vusion config 进行修改, 需要返回所有参数 )
+     * modifyVusionWebpackConfig   ( 对服务启动前对 vusion webpackConfig 进行修改, 需要返回所有参数 )
+     * modifyDefaultVusionConfig   ( 初始化修改通用 vusion.config.js, 需要返回所有参数 )
+```
+
+### api 方法扩展
+
+可参考以下插件, 如:
+
+```js
+    // 注册一个方法
+    api.registerMethod('beforeCommandUpdate', {
+        type: api.API_TYPE.EVENT,
+        description: '开始更新前事件',
+    });
+
+    // 注册一个终端命令
+    api.registerCommand('update', {
+        description: 'update package.json',
+        usage: 'micro-app update [options]',
+        options: {
+            '-': 'update all.',
+            '-n <name>': 'only update <name>.',
+        },
+        details: `
+Examples:
+    ${chalk.gray('# update all')}
+    micro-app update
+    ${chalk.gray('# only update <name>')}
+    micro-app update -n <name>
+          `.trim(),
+    }, args => {
+        const name = args.n;
+        return updateMicro(api, name);
+    });
+
+    // 对外抛出已注册的方法.
+    api.applyPluginHooks('beforeCommandUpdate', { name, logger, microsConfig });
+
+```
+
+其它插件使用 `beforeCommandUpdate` 方法, 如下:
+
+```js
+    api.beforeCommandUpdate(item => {
+        console.log('beforeCommandUpdate', item);
+    });
+```
+
 ## 其他
 
-- 展示所有容器
+### 已支持的终端命令行
+
+```js
+╰─➤  npx micro-app help
+
+
+  Usage: micro-app <command> [options]
+
+
+  Commands:
+      * show       ( show alias & shared list, etc. )
+      * check      ( check all dependencies. )
+      * version    ( show version )
+      * start      ( runs server for production )
+      * serve      ( runs server for development )
+      * build      ( build for production )
+      * update     ( update package.json )
+      * deploy     ( sync commit status. )
+
+
+  run micro-app help [command] for usage of a specific command.
+```
+
+### 展示所有容器
 
 ```js
 npx micro-app show micros
 ```
 
-- 展示所有前端共享接口
+### 展示所有前端共享接口
 
 ```js
 npx micro-app show alias
 ```
 
-- 展示所有后端共享接口
+### 展示所有全局共享接口
 
 ```js
 npx micro-app show shared
 ```
+
+### 启动开发模式
+
+```js
+npx micro-app-dev --progress
+```

bin/base.js

@@ -10,6 +10,13 @@ const yParser = require('yargs-parser');
 const cmd = process.argv[2];
 const argv = yParser(process.argv.slice(3));
 
+// 全局环境
+if ([ 'start', 'build' ].includes(cmd)) {
+    process.env.NODE_ENV = process.env.NODE_ENV || 'production';
+} else if ([ 'serve' ].includes(cmd)) {
+    process.env.NODE_ENV = process.env.NODE_ENV || 'development';
+}
+
 // 全局指令
 if (!global.MicroAppConfig) {
     global.MicroAppConfig = {};

package.json

@@ -1,6 +1,6 @@
 {
     "name": "@micro-app/cli",
-    "version": "0.1.0-RC7",
+    "version": "0.1.0",
     "description": "micro app cli",
     "bin": {
         "micro-app": "./bin/micro-app.js",
@@ -11,6 +11,14 @@
     "scripts": {
         "test": "echo \"Error: no test specified\" && exit 1"
     },
+    "homepage": "https://github.com/zyao89/MicroApp-CLI",
+    "repository": {
+        "type": "git",
+        "url": "git+https://github.com/zyao89/MicroApp-CLI.git"
+    },
+    "bugs": {
+        "url": "https://github.com/zyao89/MicroApp-CLI/issues"
+    },
     "files": [
         "bin",
         "plugins",
@@ -34,7 +42,7 @@
         "webpack": "^4.39.2"
     },
     "dependencies": {
-        "@micro-app/core": "^0.1.0-RC4",
+        "@micro-app/core": "^0.1.0",
         "koa": "^2.8.1",
         "koa-static": "^5.0.0",
         "opn": "^5.5.0",

src/utils/checker.js

@@ -19,9 +19,11 @@ exports.checkUpgrade = function() {
 
 exports.checkNode = function() {
     // Ensure minimum supported node version is used
-    const result = semver.satisfies(process.version, pkg.engines.node);
-
-    !result && logger.error(`  You must upgrade node to ${pkg.engines.node} to use ${pkg.name}`);
-
-    return result;
+    try {
+        const result = semver.satisfies(process.version, pkg.engines.node);
+        !result && logger.error(`  You must upgrade node to ${pkg.engines.node} to use ${pkg.name}`);
+        return result;
+    } catch (error) {
+        return true;
+    }
 };

yarn.lock

@@ -182,10 +182,10 @@
     lodash "^4.17.13"
     to-fast-properties "^2.0.0"
 
-"@micro-app/core@^0.1.0-RC4":
-  version "0.1.0-RC4"
-  resolved "https://registry.yarnpkg.com/@micro-app/core/-/core-0.1.0-RC4.tgz#d391e0172ac597b2e07788e46e7a22c2374eed1b"
-  integrity sha512-XGeWdS+fnypBpQODHO8Aj0cZoZkirYg1I+K1IXZWvNf3ClXZzQKupTITjLBqhL35vkVKEJJJIlooEvTF47r6hQ==
+"@micro-app/core@^0.1.0":
+  version "0.1.0"
+  resolved "https://registry.yarnpkg.com/@micro-app/core/-/core-0.1.0.tgz#6f59e395817c7aca666b128e764d82de83b6baaf"
+  integrity sha512-spS0B1ok6LuL4d6Lb+MGOc9X4XMsqPFK7P+ZHv/iRc0XNXEDck8nNcEy/1Cwf/MUbjKofDKRMM41KXctpipnCQ==
   dependencies:
     ajv "^6.10.2"
     ajv-keywords "^3.4.1"