feat: add MF Vite Vue3 example (#4289)

* feat: add MF Vite Vue3 example * chore: clean up package.json
module-federation · Oct 10, 2024 · 2f4da01 · 2f4da01
1 parent c6fd6cb
commit 2f4da01
Show file tree

Hide file tree

Showing 39 changed files with 11,037 additions and 0 deletions.
diff --git a/module-federation-vite-vue3/README.md b/module-federation-vite-vue3/README.md
@@ -0,0 +1,14 @@
+# Svelte host and remote
+
+## Getting started
+
+From this directory execute:
+
+- npm run install:deps
+- npm run preview
+
+Open your browser at http://localhost:5173/ to see the amazing result
+
+![screenshot](docs/screenshot.png)
+
+The state is shared between applications
diff --git a/module-federation-vite-vue3/docs/screenshot.png b/module-federation-vite-vue3/docs/screenshot.png
diff --git a/module-federation-vite-vue3/host/.eslintrc.cjs b/module-federation-vite-vue3/host/.eslintrc.cjs
@@ -0,0 +1,15 @@
+/* eslint-env node */
+require("@rushstack/eslint-patch/modern-module-resolution");
+
+module.exports = {
+  root: true,
+  extends: [
+    "plugin:vue/vue3-essential",
+    "eslint:recommended",
+    "@vue/eslint-config-typescript",
+    "@vue/eslint-config-prettier",
+  ],
+  parserOptions: {
+    ecmaVersion: "latest",
+  },
+};
diff --git a/module-federation-vite-vue3/host/.gitignore b/module-federation-vite-vue3/host/.gitignore
@@ -0,0 +1,30 @@
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+pnpm-debug.log*
+lerna-debug.log*
+
+node_modules/
+.DS_Store
+dist
+dist-ssr
+coverage
+*.local
+
+/cypress/videos/
+/cypress/screenshots/
+
+# Editor directories and files
+.vscode/*
+!.vscode/extensions.json
+.idea
+*.suo
+*.ntvs*
+*.njsproj
+*.sln
+*.sw?
+
+.__mf__temp
diff --git a/module-federation-vite-vue3/host/.prettierrc.json b/module-federation-vite-vue3/host/.prettierrc.json
@@ -0,0 +1 @@
+{}
diff --git a/module-federation-vite-vue3/host/README.md b/module-federation-vite-vue3/host/README.md
@@ -0,0 +1,46 @@
+# host
+
+This template should help get you started developing with Vue 3 in Vite.
+
+## Recommended IDE Setup
+
+[VSCode](https://code.visualstudio.com/) + [Volar](https://marketplace.visualstudio.com/items?itemName=Vue.volar) (and disable Vetur) + [TypeScript Vue Plugin (Volar)](https://marketplace.visualstudio.com/items?itemName=Vue.vscode-typescript-vue-plugin).
+
+## Type Support for `.vue` Imports in TS
+
+TypeScript cannot handle type information for `.vue` imports by default, so we replace the `tsc` CLI with `vue-tsc` for type checking. In editors, we need [TypeScript Vue Plugin (Volar)](https://marketplace.visualstudio.com/items?itemName=Vue.vscode-typescript-vue-plugin) to make the TypeScript language service aware of `.vue` types.
+
+If the standalone TypeScript plugin doesn't feel fast enough to you, Volar has also implemented a [Take Over Mode](https://github.com/johnsoncodehk/volar/discussions/471#discussioncomment-1361669) that is more performant. You can enable it by the following steps:
+
+1. Disable the built-in TypeScript Extension
+    1) Run `Extensions: Show Built-in Extensions` from VSCode's command palette
+    2) Find `TypeScript and JavaScript Language Features`, right click and select `Disable (Workspace)`
+2. Reload the VSCode window by running `Developer: Reload Window` from the command palette.
+
+## Customize configuration
+
+See [Vite Configuration Reference](https://vitejs.dev/config/).
+
+## Project Setup
+
+```sh
+npm install
+```
+
+### Compile and Hot-Reload for Development
+
+```sh
+npm run dev
+```
+
+### Type-Check, Compile and Minify for Production
+
+```sh
+npm run build
+```
+
+### Lint with [ESLint](https://eslint.org/)
+
+```sh
+npm run lint
+```
diff --git a/module-federation-vite-vue3/host/env.d.ts b/module-federation-vite-vue3/host/env.d.ts
@@ -0,0 +1 @@
+/// <reference types="vite/client" />
diff --git a/module-federation-vite-vue3/host/index.html b/module-federation-vite-vue3/host/index.html
@@ -0,0 +1,14 @@
+<!doctype html>
+<html lang="en">
+  <head>
+    <meta charset="UTF-8" />
+    <link rel="icon" href="/favicon.ico" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+    <title>Host</title>
+  </head>
+
+  <body>
+    <div id="app"></div>
+    <script type="module" src="/src/main.ts"></script>
+  </body>
+</html>
diff --git a/module-federation-vite-vue3/host/package.json b/module-federation-vite-vue3/host/package.json
@@ -0,0 +1,36 @@
+{
+  "name": "module-federation-vite-vue3-host",
+  "version": "0.0.0",
+  "private": true,
+  "scripts": {
+    "dev": "run-p vite:dev force-vite-restart",
+    "vite:dev": "vite --port 4173",
+    "build": "run-p type-check build-only",
+    "preview": "vite preview --port 4173",
+    "build-only": "vite build",
+    "type-check": "vue-tsc --noEmit",
+    "lint": "eslint . --ext .vue,.js,.jsx,.cjs,.mjs,.ts,.tsx,.cts,.mts --fix --ignore-path .gitignore",
+    "force-vite-restart": "node ../shared/forceViteRestart.js"
+  },
+  "dependencies": {
+    "pinia": "^2.0.28",
+    "vue": "^3.2.45"
+  },
+  "devDependencies": {
+    "@module-federation/vite": "1.1.1",
+    "@rushstack/eslint-patch": "^1.1.4",
+    "@types/node": "^18.11.12",
+    "@vitejs/plugin-vue": "^4.0.0",
+    "@vitejs/plugin-vue-jsx": "^3.0.0",
+    "@vue/eslint-config-prettier": "^7.0.0",
+    "@vue/eslint-config-typescript": "^11.0.0",
+    "@vue/tsconfig": "^0.1.3",
+    "eslint": "^8.22.0",
+    "eslint-plugin-vue": "^9.3.0",
+    "npm-run-all": "^4.1.5",
+    "prettier": "^2.7.1",
+    "typescript": "~4.7.4",
+    "vite": "^5.3.5",
+    "vue-tsc": "^1.0.12"
+  }
+}