{"id":22779356,"url":"https://github.com/microappjs/core","last_synced_at":"2025-04-15T14:22:08.033Z","repository":{"id":35100157,"uuid":"174333042","full_name":"MicroAppJS/core","owner":"MicroAppJS","description":"[Library] Pluggable application framework Core.","archived":false,"fork":false,"pushed_at":"2022-12-10T00:24:32.000Z","size":2189,"stargazers_count":1,"open_issues_count":12,"forks_count":2,"subscribers_count":2,"default_branch":"master","last_synced_at":"2024-04-25T14:22:23.232Z","etag":null,"topics":["core","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}},"created_at":"2019-03-07T11:39:33.000Z","updated_at":"2022-02-23T01:42:49.000Z","dependencies_parsed_at":"2023-01-15T14:00:37.446Z","dependency_job_id":null,"html_url":"https://github.com/MicroAppJS/core","commit_stats":null,"previous_names":[],"tags_count":31,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MicroAppJS%2Fcore","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MicroAppJS%2Fcore/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MicroAppJS%2Fcore/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MicroAppJS%2Fcore/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/MicroAppJS","download_url":"https://codeload.github.com/MicroAppJS/core/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":249085759,"owners_count":21210349,"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":["core","micro","micro-app","micro-application","microapp"],"created_at":"2024-12-11T20:08:34.098Z","updated_at":"2025-04-15T14:22:08.009Z","avatar_url":"https://github.com/MicroAppJS.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Micro APP Core\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/core/workflows/Coveralls/badge.svg\n[Github-Actions-Coveralls-url]: https://github.com/MicroAppJS/core\n[Coverage-img]: https://coveralls.io/repos/github/MicroAppJS/core/badge.svg?branch=master\n[Coverage-url]: https://coveralls.io/github/MicroAppJS/core?branch=master\n[npm-img]: https://img.shields.io/npm/v/@micro-app/core.svg?style=flat-square\n[npm-url]: https://npmjs.org/package/@micro-app/core\n[download-img]: https://img.shields.io/npm/dm/@micro-app/core.svg?style=flat-square\n[download-url]: https://npmjs.org/package/@micro-app/core\n\n## Install\n\n```sh\nyarn add @micro-app/core\n```\n\nor\n\n```sh\nnpm install -D @micro-app/core\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: '', // type 类型\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    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```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     * 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```\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","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmicroappjs%2Fcore","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmicroappjs%2Fcore","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmicroappjs%2Fcore/lists"}