@module-federation/vite 0.2.8 → 1.0.0-alpha-ffc6e23

package/README.md

@@ -1,4 +1,4 @@
-# Vite/Rollup plugin for Module Federation
+# Vite plugin for Module Federation
 
 ## Reason why 🤔
 
@@ -10,64 +10,69 @@ This plugin makes Module Federation work together with [Vite](https://vitejs.dev
 ## Working implementations
 
 ### [React](https://github.com/module-federation/module-federation-examples/tree/master/vite-react-microfrontends)<br>
+
 ### [Svelte](https://github.com/module-federation/module-federation-examples/tree/master/vite-svelte-microfrontends)<br>
-### [Vue](https://github.com/module-federation/module-federation-examples/tree/master/vite-vue-microfrontends)
 
+### [Vue](https://github.com/module-federation/module-federation-examples/tree/master/vite-vue-microfrontends)
 
 ## Getting started 🚀
 
-This plugin is based on top of [native-federation](https://www.npmjs.com/package/@softarc/native-federation) so this library is a [peer dependency](https://docs.npmjs.com/cli/v8/configuring-npm/package-json#peerdependencies).
+https://module-federation.io/guide/basic/webpack.html
 
-You need to extend the Vite configuration with this plugin:
-
-```typescript
+```js
+// vite.config.js
 import { defineConfig } from 'vite';
-import { federation } from '@module-federation/vite';
-import { createEsBuildAdapter } from '@softarc/native-federation-esbuild';
+import vue from '@vitejs/plugin-vue';
+import { federation } from 'module-federation-vite';
+import topLevelAwait from 'vite-plugin-top-level-await';
 
 // https://vitejs.dev/config/
-export default defineConfig(async ({ command }) => ({
-  server: {
-    fs: {
-      allow: ['.', '../shared'],
-    },
-  },
+export default defineConfig({
   plugins: [
-    await federation({
-      options: {
-        workspaceRoot: __dirname,
-        outputPath: 'dist',
-        tsConfig: 'tsconfig.json',
-        federationConfig: 'module-federation/federation.config.cjs',
-        verbose: false,
-        dev: command === 'serve',
+    federation({
+      name: 'bbc',
+      remotes: {
+        mfapp01: 'mfapp01@https://unpkg.com/mf-app-01@1.0.9/dist/remoteEntry.js',
+        remote2: 'mfapp02@https://unpkg.com/mf-app-02/dist/remoteEntry.js',
+        remote3:
+          'remote1@https://unpkg.com/react-manifest-example_remote1@1.0.6/dist/mf-manifest.json',
+        // "remote4": {
+        //   entry: "http://localhost:5174/dd/remoteEntry.js",
+        //   globalEntryName: "bb",
+        //   type: "esm"
+        // }
+      },
+      exposes: {
+        App: './src/App.vue',
+      },
+      filename: 'dd/remoteEntry.js',
+      shared: {
+        vue: {},
+        react: {
+          requiredVersion: '18',
+        },
       },
-      adapter: createEsBuildAdapter({ plugins: [...], }),
     }),
-    [...]
+    // If you set build.target: "chrome89", you can remove this plugin
+    // topLevelAwait(),
   ],
-}));
+  build: {
+    target: 'chrome89',
+  },
+});
 ```
 
-<br>
+## roadmap
 
-### Define configs
+- feat: generate mf-manifest.json
+- feat: support chrome plugin
 
-You need to define two different configurations in the `federationConfig` property.<br>
-Here are two examples:
+* ✅ ~~feat: support runtime plugins~~
 
-- [host](https://www.npmjs.com/package/@softarc/native-federation#configuring-hosts)
-- [remote](https://www.npmjs.com/package/@softarc/native-federation#configuring-remotes)
-  <br><br>
+- feat: download remote d.ts
+- feat: generate d.ts
+- feat: support @vitejs/plugin-legacy
 
 ### So far so good 🎉
 
 Now you are ready to use Module Federation in Vite!
-
-## Thanks 🤝
-
-Big thanks to:
-
-[Manfred Steyer](https://twitter.com/manfredsteyer), Speaker, Trainer, Consultant and Author with focus on Angular. Google Developer Expert (GDE) and Microsoft MVP.
-
-who collaborate with me to make this possible.