@originjs/vite-plugin-federation - npm Package Compare versions

Comparing version 0.0.2 to 0.0.3

package.json

 {
   "name": "@originjs/vite-plugin-federation",
-  "version": "0.0.2",
+  "version": "0.0.3",
   "description": "A Vite plugin which support Module Federation.",
@@ -33,3 +33,4 @@ "main": "dist/index.js",
     "prebuild": "rimraf dist",
-    "build": "rollup -c --sourcemap"
+    "build": "rollup -c",
+    "changelog": "conventional-changelog -p angular -i CHANGELOG.md -s --commit-path ."
   },
@@ -45,4 +46,5 @@ "dependencies": {
     "@types/estree": "^0.0.50",
+    "conventional-changelog-cli": "^2.1.1",
     "rollup": "^2.56.0"
   }
 }

README.md

@@ -1,5 +0,67 @@
-# Vite Module Federation Plugin
+# vite-plugin-federation
 
-Inspired by [webpack](https://github.com/webpack/webpack)'s module-federation feature.
+A Vite plugin which support Module Federation.
+Inspired by Webpack [Module Federation](https://webpack.js.org/concepts/module-federation/) feature.
 
-A Vite plugin which support Module Federation.
+## Install
+
+Using npm:
+
+```
+npm install @originjs/vite-plugin-federation --save-dev
+```
+
+## Usage
+
+- for a Vite project, in `vite.config.js`:
+
+```js
+import { defineConfig } from 'vite'
+import federation from "@originjs/vite-plugin-federation";
+
+export default defineConfig({
+  plugins: [
+    federation({
+      name: 'module-name',
+      filename: 'remoteEntry.js',
+      exposes: {
+        './Button': './src/Button.vue',
+      },
+      remotes:{
+          foo: 'remote_foo'
+      }
+      shared: ['vue']
+    })
+  ],
+})
+
+```
+
+- for a Rollup project, in `rollup.config.js`:
+
+```js
+import federation from '@originjs/vite-plugin-federation'
+
+export default {
+  input: 'src/index.js',
+  output: {
+    format: 'esm',
+    dir: 'dist'
+  },
+  plugins: [
+    federation({
+      filename: 'remoteEntry.js',
+      exposes: {
+        './Button': './src/button'
+      },
+      shared: ['react']
+    })
+  ]
+}
+```
+
+## Examples
+
+- [basic-host-remote](https://github.com/originjs/vite-plugin-federation/tree/main/packages/examples/basic-host-remote)
+- [simple-react](https://github.com/originjs/vite-plugin-federation/tree/main/packages/examples/simple-react)
+- [vue3-demo](https://github.com/originjs/vite-plugin-federation/tree/main/packages/examples/vue3-demo)

types/index.d.ts

@@ -76,2 +76,16 @@ /**
 
+type Remotes = (string | RemotesObject)[] | RemotesObject
+
+type Shared = (string | SharedObject)[] | SharedObject
+
+type ConfigTypeSet = ExposesConfig | RemotesConfig | SharedConfig
+
+declare interface SharedRuntimeInfo {
+  id: string
+  dependencies: string[]
+  fileName: string
+  fileDir: string
+  filePath: string
+}
+
 /**
@@ -220,3 +234,3 @@ * Modules that should be exposed by this container. Property names are used as public paths.
    */
-  import?: string | false
+  import?: boolean
 
@@ -223,0 +237,0 @@ /**

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Dynamic require

Supply chain risk

Dynamic require can indicate the package is performing dangerous or unsafe dynamic code execution.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Lines of code

3822

increased by9.17%

Number of lines in readme file

68

increased by1033.33%

Worsened metrics

Total package byte prevSize

157207

decreased by-63.34%

Dev dependency count

6

increased by20%

Number of package files

8

decreased by-11.11%

Number of low supply chain risk alerts

1

increased byInfinity%

No dependency changes