{"id":19266559,"url":"https://github.com/microappjs/cli","last_synced_at":"2026-02-07T17:32:21.893Z","repository":{"id":36595165,"uuid":"174332684","full_name":"MicroAppJS/cli","owner":"MicroAppJS","description":"[CLI] Pluggable application framework.","archived":false,"fork":false,"pushed_at":"2023-03-04T04:37:00.000Z","size":1792,"stargazers_count":1,"open_issues_count":14,"forks_count":1,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-06-18T17:03:14.175Z","etag":null,"topics":["cli","koa2","micro","micro-app","micro-application","microapp"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/MicroAppJS.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2019-03-07T11:36:52.000Z","updated_at":"2022-01-25T02:06:22.000Z","dependencies_parsed_at":"2024-06-19T17:38:04.989Z","dependency_job_id":"e18e00c1-e8ca-45e2-bbb9-85e8e5e9e67a","html_url":"https://github.com/MicroAppJS/cli","commit_stats":null,"previous_names":[],"tags_count":24,"template":false,"template_full_name":null,"purl":"pkg:github/MicroAppJS/cli","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MicroAppJS%2Fcli","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MicroAppJS%2Fcli/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MicroAppJS%2Fcli/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MicroAppJS%2Fcli/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/MicroAppJS","download_url":"https://codeload.github.com/MicroAppJS/cli/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MicroAppJS%2Fcli/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":265508247,"owners_count":23779103,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cli","koa2","micro","micro-app","micro-application","microapp"],"created_at":"2024-11-09T20:05:48.204Z","updated_at":"2026-02-07T17:32:21.855Z","avatar_url":"https://github.com/MicroAppJS.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Micro APP CLI\n\nPluggable micro application framework.\n\n基于webpack多入口的多仓库业务模块开发的插件应用框架脚手架.\n\n[![Github Actions Coveralls][Github-Actions-Coveralls]][Github-Actions-Coveralls-url]\n[![Coverage Status][Coverage-img]][Coverage-url]\n[![NPM Version][npm-img]][npm-url]\n[![NPM Download][download-img]][download-url]\n\n[Github-Actions-Coveralls]: https://github.com/MicroAppJS/cli/workflows/Coveralls/badge.svg\n[Github-Actions-Coveralls-url]: https://github.com/MicroAppJS/cli\n[Coverage-img]: https://coveralls.io/repos/github/MicroAppJS/cli/badge.svg?branch=master\n[Coverage-url]: https://coveralls.io/github/MicroAppJS/cli?branch=master\n[npm-img]: https://img.shields.io/npm/v/@micro-app/cli.svg?style=flat-square\n[npm-url]: https://npmjs.org/package/@micro-app/cli\n[download-img]: https://img.shields.io/npm/dm/@micro-app/cli.svg?style=flat-square\n[download-url]: https://npmjs.org/package/@micro-app/cli\n\n## Install\n\n```sh\nyarn add @micro-app/cli\n```\n\nor\n\n```sh\nnpm install -D @micro-app/cli\n```\n\n## Usage\n\n### 在项目 `根目录` 初始化创建一个 `micro-app.config.js` 文件\n\n```sh\nnpx micro-app init\n```\n\n### 对 `micro-app.config.js` 配置文件进行编辑\n\n```js\nmodule.exports = {\n    name: '@micro-app/demo',\n    description: '',\n    version: '0.0.1',\n    type: '', // types 类型\n\n    staticPath: [], // String | Array\n\n    entry: { // 入口\n        main: './test/index.js',\n    },\n\n    htmls: [ // 输出模版配置\n        {\n            template: './test/index.js',\n        },\n    ],\n\n    alias: { // 别名配置\n        api: '',\n        config: {\n            link: '',\n            description: '配置',\n        },\n        service: {\n            link: '',\n            description: '接口',\n            type: 'server',\n        },\n    },\n\n    strict: true, // 严格强依赖模式\n\n    micros: [ 'test' ], // 被注册的容器\n\n    // 服务配置\n    server: {\n        hooks: '',\n        entry: '', // 服务端入口\n        port: 8088, // 服务端口号\n    },\n\n    plugins: [ // 自定义插件\n        // [{\n        //     id: 'test',\n        //     description: '这是test',\n        //     link: __dirname + '/test/testPlugin',\n        // }, {\n        //     a: 1,\n        // }],\n    ],\n};\n```\n\n### 在 `package.json` 中加载其他模块, 例如\n\n```json\n    \"dependencies\": {\n        \"@micro-app/test\": \"git+ssh://git@github.com/micro-app.git#test\"\n    },\n```\n\n### 开发模式\n\n```sh\nnpx micro-app serve\n```\n\nor\n\n```sh\nnpx micro-app-dev\n```\n\n### 运行\n\n```sh\nnpx micro-app start\n```\n\nor\n\n```sh\nnpx micro-app-start\n```\n\n## 项目中使用共享接口\n\n```js\nconst api = require('@micro-demo/api');\n```\n\n## Plugins 扩展\n\n### 首先在 micro-app.config.js 中注册插件\n\n```js\nplugins: [\n        [ // 1\n            {\n                id: 'test', // 插件 id\n                description: '这是test', // 插件描述\n                link: __dirname + '/test/testPlugin.js',  // 插件地址\n            }, { // 注册入的 opts\n                a: 1,\n            }\n        ],\n    ],\n```\n\n### 插件文件 `testPlugin.js`\n\n文件必须返回一个方法.\n\n```js\nmodule.exports = function(api, opts) {\n    console.log(opts);\n    api.onInitDone(item =\u003e {\n        console.log('init Done', item);\n    });\n    api.onInitDone(() =\u003e {\n        console.log('init Done2', api.getState('webpackConfig'));\n    });\n    api.onPluginInitDone(item =\u003e {\n        console.log('onPluginInitDone', item);\n    });\n};\n```\n\n### 内置部分插件提供的 api 方法\n\n可通过如下命令进行动态查看\n\n```js\nnpx micro-app show methods\n```\n\n以提供的方法如下, `System Build-in` 为内置方法\n\n```js\n╰─➤  npx micro-app show methods\n  Plugin Methods:\n     * onPluginInitDone            ( System Build-in )\n     * beforeMergeConfig           ( System Build-in )\n     * afterMergeConfig            ( System Build-in )\n     * modifyDefaultServerConfig   ( System Build-in )\n     * onInitWillDone              ( System Build-in )\n     * onInitDone                  ( System Build-in )\n     * modifyCommand               ( System Build-in )\n     * onRunCommand                ( System Build-in )\n     * modifyCommandHelp           ( System Build-in )\n     * modifyWebpackConfig         ( 合并之后提供 webpack config 进行再次修改事件 )\n     * onServerInit                ( 服务初始化时事件 )\n     * onServerInitWillDone        ( 服务初始化即将完成事件 )\n     * onServerInitDone            ( 服务初始化完成事件 )\n     * onServerRunSuccess          ( 服务运行启动成功时事件 )\n     * onServerRunFail             ( 服务运行启动失败时事件 )\n     * beforeServerEntry           ( 服务进入业务逻辑前事件 )\n     * afterServerEntry            ( 服务从业务逻辑出来后事件 )\n     * beforeDevServer             ( 开发服务创建前事件 )\n     * afterDevServer              ( 开发服务创建后事件 )\n     * onBuildSuccess              ( 构建成功时事件 )\n     * onBuildFail                 ( 构建失败时事件 )\n     * beforeBuild                 ( 开始构建前事件 )\n     * afterBuild                  ( 构建结束后事件 )\n     * beforeCommandUpdate         ( 开始更新前事件 )\n     * afterCommandUpdate          ( 更新完毕后事件 )\n     * beforeCommandDeploy         ( 发布前事件 )\n     * afterCommandDeploy          ( 发布后事件 )\n     * modifyCommandDeployMessage  ( 发布消息二次编辑事件 )\n\n// 以下为针对 vusion 类型的方法\n     * modifyVusionConfig          ( 对服务启动前对 vusion config 进行修改, 需要返回所有参数 )\n     * modifyVusionWebpackConfig   ( 对服务启动前对 vusion webpackConfig 进行修改, 需要返回所有参数 )\n     * modifyDefaultVusionConfig   ( 初始化修改通用 vusion.config.js, 需要返回所有参数 )\n```\n\n### api 方法扩展\n\n可参考以下插件, 如:\n\n```js\n    // 注册一个方法\n    api.registerMethod('beforeCommandUpdate', {\n        type: api.API_TYPE.EVENT,\n        description: '开始更新前事件',\n    });\n\n    // 注册一个终端命令\n    api.registerCommand('update', {\n        description: 'update package.json',\n        usage: 'micro-app update [options]',\n        options: {\n            '--all': 'update all.',\n            '-n \u003cname\u003e': 'only update \u003cname\u003e.',\n        },\n        details: `\nExamples:\n    ${chalk.gray('# update all')}\n    micro-app update --all\n    ${chalk.gray('# only update \u003cname\u003e')}\n    micro-app update -name \u003cname\u003e\n          `.trim(),\n    }, args =\u003e {\n        const name = args.name;\n        return updateMicro(api, name);\n    });\n\n    // 对外触发已注册的方法.\n    api.applyPluginHooks('beforeCommandUpdate', { name, logger, microsConfig });\n\n```\n\n其它插件使用 `beforeCommandUpdate` 方法, 如下:\n\n```js\n    api.beforeCommandUpdate(item =\u003e {\n        console.log('beforeCommandUpdate', item);\n    });\n```\n\n## 其他\n\n### 已支持的终端命令行\n\n```js\n╰─➤  npx micro-app help\n\n\n  Usage: micro-app \u003ccommand\u003e [options]\n\n\n  Commands:\n      * show       ( show alias \u0026 shared list, etc. )\n      * check      ( check all dependencies. )\n      * version    ( show version )\n      * start      ( runs server for production )\n      * serve      ( runs server for development )\n      * build      ( build for production )\n      * update     ( update package.json )\n      * deploy     ( sync commit status. )\n\n\n  run micro-app help [command] for usage of a specific command.\n```\n\n### 展示所有容器\n\n```js\nnpx micro-app show micros\n```\n\n### 展示所有前端共享接口\n\n```js\nnpx micro-app show alias\n```\n\n### 展示所有全局共享接口\n\n```js\nnpx micro-app show shared\n```\n\n### 启动开发模式\n\n```js\nnpx micro-app-dev --progress\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmicroappjs%2Fcli","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmicroappjs%2Fcli","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmicroappjs%2Fcli/lists"}