Skip to content

Commit

Permalink
docs: add v0.1 release note (#2287)
Browse files Browse the repository at this point in the history
  • Loading branch information
zhoushaw authored Apr 4, 2024
1 parent 6798d16 commit 06ea45d
Show file tree
Hide file tree
Showing 7 changed files with 72 additions and 3 deletions.
2 changes: 1 addition & 1 deletion apps/website-new/docs/en/_meta.json
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
},
{
"text": "Community",
"link": "/community/showcase/",
"link": "/community/showcase",
"activeMatch": "/community/",
"items": [
{
Expand Down
1 change: 1 addition & 0 deletions apps/website-new/docs/en/community/_meta.json
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
[ "v0-1", "showcase"]
33 changes: 33 additions & 0 deletions apps/website-new/docs/en/community/v0-1.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
# v0.1 Release

> April 3, 2024
We have recently released the **v0.1** version of **[Module Federation Enhanced](https://github.com/module-federation/universe)** (You can simply think of it as the early version of Module Federation 2.0.)!

`Module Federation Enhanced` differs from the `Module Federation` built into `Webpack5` by providing not only the core features of module export, loading, and dependency sharing but also additional dynamic type hinting, `Manifest`, `Federation Runtime`, and `Runtime Plugin`. These features make `Module Federation` more suitable for use as a micro-frontend architecture in large-scale `Web` applications.

### 🔥 Features

`Module Federation` comes with the following features:

- **New Documentation**: `Module Federation` has launched a [brand-new documentation](https://module-federation.io/), which can help you better understand and utilize `Module Federation`.

- **Dynamic Type Hinting**: `Module Federation` uses dynamic runtime, which previously did not support `TypeScript` type hinting. This significantly impacted the stability and maintainability of projects. Therefore, `Module Federation` now supports out-of-the-box type exports and dynamic type loading capabilities, as well as hot type updating, providing an experience akin to loading local `NPM` modules.

- **Manifest**: In the past, `Module Federation` primarily used `remoteEntry.js` as the entry point for `Module Federation` modules. Remote modules could not store more original information, such as type files, exposes, remotes, etc. We now support setting `remote` to `mf-manifest.json`, which enables more advanced capabilities: `type hinting`, `resource preloading`, `visualized dependency relationships`, `shared dependency analysis`, `integration with deployment platforms`, and `service discovery`.

- **Federation Runtime**: `Federation Runtime` is an independent software development kit (SDK) that addresses compatibility issues with `Module Federation` across different build tools. In the early stages, the implementation of `Module Federation` was tightly coupled with `Webpack 5`, making it difficult for other build tools to support and leading to poor maintainability. By treating `Federation Runtime` as a separate component, the new versions of `Webpack` and `Rspack`, as well as other build tools, can more easily implement and maintain `Module Federation` features, enhancing the flexibility and efficiency of module loading and dependency sharing.

- **Rspack**: The `Module Federation` in Rspack is based on `Federation Runtime`, thus enjoying all the additional capabilities of `Module Federation Enhance`. Moreover, due to the partitioned architecture concept of `Module Federation`, you can progressively migrate your large projects to `Rspack` through `Module Federation`.

### 💡 Next Steps

`Module Federation Enhanced` is still in rapid iteration and plans to introduce more powerful new features.

For example, we are developing the **Module Federation Chrome Devtool**, a user-friendly `Module Federation` debugging and proxy tool that can directly proxy online project `Module Federation` modules to local and enable real-time hot updates. It provides a visual dependency graph that allows you to see the `Module Federation` dependency relationships and `Shared` settings.

At the same time, we will offer more framework-level capabilities, such as: `Modern.js SSR`, `React Server Component`, `Router`, `Web Component`, `cross-frame`.

### 🙏 Acknowledgements

The release of `Module Federation Enhanced` version `0.1` would not have been possible without the feedback and suggestions from the `Module Federation` community and the efforts of contributors to the [`Universe`](https://github.com/module-federation/universe) repository.
1 change: 0 additions & 1 deletion apps/website-new/docs/en/plugin/dev/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -116,7 +116,6 @@ export default pluginFooBar;

## Hooks

Of course, here is the English translation of the above content:

### beforeInit

Expand Down
2 changes: 1 addition & 1 deletion apps/website-new/docs/zh/_meta.json
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
},
{
"text": "社区",
"link": "/community/showcase/",
"link": "/community/showcaseå",
"activeMatch": "/community/",
"items": [
{
Expand Down
1 change: 1 addition & 0 deletions apps/website-new/docs/zh/community/_meta.json
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
[ "v0-1", "showcase"]
35 changes: 35 additions & 0 deletions apps/website-new/docs/zh/community/v0-1.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
# v0.1 发布

> April 3, 2024
我们最近发布了 **[Module Federation enhanced](https://github.com/module-federation/universe)** **v0.1** 版本(你可以简单将其理解为 Module Federation 2.0 的早期版本)!

`Module Federation Enhanced` 不同于 `Webpack5` 内置的 `Module Federation` 它提供了除 `Module Federation` 有的:模块导出、模块加载、依赖共享,还提供了额外的动态类型提示、`Manifest``Federation Runtime``Runtime Plugin`,这些功能能让 `Module Federation` 更适合作为大型 `Web` 应用的微前端架构。


### 🔥 特性

`Module Federation` 具备以下特性:

- **新版文档**`Module Federation` 上线了[全新的文档](https://module-federation.io/),能够帮助你更好的了解和使用 `Module Federation`

- **动态类型提示**`Module Federation` 采用运行时动态,使得它不支持 `TypeScript` 的类型提示,这对于项目的稳定性和可维护性带来了很大的影响,因此在 `Module Federation` 中支持了开箱即用的类型导出和动态类型加载能力和类型热更新能力,体验就像是加载本地的 `NPM` 模块一样。

- **Manifest**`Module Federation` 在过去的主要使用 `remoteEntry.js` 来作为 `Module Federation` 模块的入口,远程模块中无法存放更多的原信息,例如:类型文件、expose、remotes 等信息,我们支持设置 `remote``mf-manifest.json` 这可以支持更多进阶的能力:`类型提示``资源预加载``可视化依赖关系``共享依赖分析``与部署平台打通``服务发现`

- **Federation Runtime**`Federation Runtime` 是一种独立的软件开发工具包(SDK),它解决了模块联合(Module Federation)在不同构建工具中的兼容性问题。在早期,`Module Federation` 的实现与 `Webpack 5` 紧密耦合,这使得其他构建工具难以支持,并且可维护性差。通过将 `Federation Runtime` 作为独立组件,新版的 `Webpack``Rspack` 以及其他构建工具都能够更容易地实现和维护 `Module Federation` 功能,提高了模块加载和依赖共享的灵活性和效率。

- **Rspack**:Rspack 中的 `Module Federation` 基于 `Federation Runtime`,因此能够享受 `Module Federation Enhanced` 所有额外的能力,并且由于 `Module Federation` 分治的架构思想,你可以将你的大型项目通过 `Module Federation` 渐进式迁移至 `Rspack`


### 💡 下一步

目前 `Module Federation Enhanced` 仍在快速迭代中,并计划引入更多强大的新特性。

比如,我们正在开发 **Module Federation Chrome Devtool**,这是一个易用 `Module Federation` 调试和代理工具,它能够将线上项目的 `Module Federation` 模块直接代理到本地,并且能够实时热更新,它提供可视化的依赖图能够看到 `Module Federation` 依赖关系以及 `Shared` 设置情况。

同时我们将会提供更多框架上层的能力建设,比如:`Modern.js SSR``React Server Component``Router``Web Component``cross-frame`

### 🙏 致谢

`Module Federation Enhanced``0.1` 发布离不开 `Module Federation` 的反馈和建议、 [`Universe`](https://github.com/module-federation/universe) 仓库贡献者做出的努力。

0 comments on commit 06ea45d

Please sign in to comment.