docs(example): vue-project

Author: JoeshuTT

examples/vue-project/README.md

@@ -1,40 +1,14 @@
 # vue-project
 
-This template should help get you started developing with Vue 3 in Vite.
+使用 version-polling 的示例项目
 
-## Recommended IDE Setup
+## 安装npm包
 
-[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
+```bash
+# npm registry
+pnpm add version-polling@latest
+# local file
+pnpm add ../../
+# see
+pnpm list --json version-polling
 ```

examples/vue-project/package.json

@@ -10,6 +10,7 @@
     "type-check": "vue-tsc --noEmit"
   },
   "dependencies": {
+    "version-polling": "^1.3.3",
     "vue": "^3.2.47",
     "vue-router": "^4.1.6"
   },

examples/vue-project/pnpm-lock.yaml

@@ -5,7 +5,12 @@ import router from './router';
 import './assets/main.css';
 
 import { createVersionPolling } from 'version-polling';
-// 安装调试本地 version-polling 包
+
+/**
+ *
+ * 调试version-polling
+ *
+ */
 createVersionPolling({
   // eventTriggerList: ['popstate'],
   pollingInterval: 5 * 1000,

examples/vue-project/src/main.ts

@@ -1,15 +1,18 @@
-import { fileURLToPath, URL } from 'node:url'
+import { URL, fileURLToPath } from 'node:url';
 
-import { defineConfig } from 'vite'
-import vue from '@vitejs/plugin-vue'
-import vueJsx from '@vitejs/plugin-vue-jsx'
+import vue from '@vitejs/plugin-vue';
+import vueJsx from '@vitejs/plugin-vue-jsx';
+import { defineConfig } from 'vite';
 
 // https://vitejs.dev/config/
 export default defineConfig({
   plugins: [vue(), vueJsx()],
   resolve: {
     alias: {
-      '@': fileURLToPath(new URL('./src', import.meta.url))
-    }
-  }
-})
+      '@': fileURLToPath(new URL('./src', import.meta.url)),
+    },
+  },
+  build: {
+    target: 'es2015',
+  },
+});