chore: example dir rename to dev-server

alphaelf · Jul 26, 2022 · 0edfc40 · 0edfc40
1 parent d0e7d76
commit 0edfc40
Show file tree

Hide file tree

Showing 16 changed files with 32 additions and 47 deletions.
diff --git a/.eslintrc.js b/.eslintrc.js
@@ -152,7 +152,7 @@ module.exports = {
       }
     },
     {
-      files: ['example/**'],
+      files: ['dev-server/**'],
       globals: {
         __DEMOS__: 'readonly',
         __TARGET__: 'readonly',

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -28,9 +28,9 @@ pnpm run build:common
 
 ### Developing for Component
 
-We use a vite project in `example` for development.
+We use a vite project in `dev-server` for development.
 
-Using the following command you can start development server for specify component: 
+Using the following command you can start development server for specify component:
 
 ```sh
 pnpm run serve [component]

diff --git a/example/.gitignore → dev-server/.gitignore b/example/.gitignore → dev-server/.gitignore
diff --git a/example/README.md → dev-server/README.md b/example/README.md → dev-server/README.md
diff --git a/example/app.vue → dev-server/app.vue b/example/app.vue → dev-server/app.vue
diff --git a/example/global.d.ts → dev-server/global.d.ts b/example/global.d.ts → dev-server/global.d.ts
diff --git a/example/index.html → dev-server/index.html b/example/index.html → dev-server/index.html
@@ -5,7 +5,7 @@
     <meta http-equiv="X-UA-Compatible" content="IE=edge" />
     <meta name="viewport" content="width=device-width,initial-scale=1.0" />
     <link rel="icon" href="/favicon.ico" />
-    <title>example | Vexip UI</title>
+    <title>dev | Vexip UI</title>
   </head>
   <body>
     <div id="app"></div>

diff --git a/example/main.ts → dev-server/main.ts b/example/main.ts → dev-server/main.ts
diff --git a/example/package.json → dev-server/package.json b/example/package.json → dev-server/package.json
@@ -1,5 +1,5 @@
 {
-  "name": "@vexip-ui/example",
+  "name": "@vexip-ui/dev-server",
   "private": true,
   "scripts": {
     "serve": "vite"

diff --git a/example/theme.vue → dev-server/theme.vue b/example/theme.vue → dev-server/theme.vue
diff --git a/dev-server/tsconfig.json b/dev-server/tsconfig.json
@@ -0,0 +1,18 @@
+{
+  "extends": "../tsconfig.json",
+  "compilerOptions": {
+    "types": [
+      "vite/client"
+    ],
+    "paths": {
+      "@/*": ["../*"],
+      "vexip-ui/es/*": ["../components/*"],
+      "vexip-ui": ["../components"]
+    }
+  },
+  "include": [
+    "*.vue",
+    "*.ts",
+    "global.d.ts"
+  ]
+}
diff --git a/example/vite.config.ts → dev-server/vite.config.ts b/example/vite.config.ts → dev-server/vite.config.ts
diff --git a/example/tsconfig.json b/example/tsconfig.json
diff --git a/package.json b/package.json
@@ -158,7 +158,7 @@
     "clean": "rimraf node_modules/.cache && rimraf node_modules/.vite && rimraf node_modules/.rts2_cache",
     "commit": "git-cz",
     "create": "ts-node scripts/create.ts",
-    "lint": "eslint --fix --ext .js,.ts,.tsx,.vue common/*/src/** components/** playground/** example/**",
+    "lint": "eslint --fix --ext .js,.ts,.tsx,.vue common/*/src/** components/** playground/** dev-server/**",
     "lint:script": "eslint --fix --ext .js,.ts scripts/**",
     "lint:style": "stylelint **/*.{vue,scss} --fix",
     "postpublish": "pinst --enable",

diff --git a/pnpm-workspace.yaml b/pnpm-workspace.yaml
@@ -1,5 +1,5 @@
 packages:
   - common/*
+  - dev-server
   - docs
-  - example
   - playground
diff --git a/scripts/serve.ts b/scripts/serve.ts
@@ -14,6 +14,8 @@ const theme = args.theme || args.t
 
 const langs = ['zh-CN']
 
+const devDir = resolve(__dirname, '../dev-server')
+
 main().catch(error => {
   logger.error(error)
   process.exit(1)
@@ -41,6 +43,8 @@ async function serveComponent() {
   const router = `
     import { createRouter, createWebHashHistory } from 'vue-router'
 
+    document.title = '${target} | Vexip UI'
+
     export const router = createRouter({
       history: createWebHashHistory('/'),
       routes: [
@@ -64,13 +68,13 @@ async function serveComponent() {
   `
 
   writeFileSync(
-    resolve(__dirname, '../example/router.ts'),
+    resolve(devDir, 'router.ts'),
     format(router, { ...(await resolveConfig(resolve('.prettierrc.js'))), parser: 'typescript' }),
     'utf-8'
   )
 
   await run('vite', ['serve'], {
-    cwd: resolve(__dirname, '../example'),
+    cwd: devDir,
     stdio: 'inherit',
     env: {
       NODE_ENV: prodMode ? 'production' : 'development',
@@ -85,7 +89,7 @@ async function serveComponent() {
 
 async function serveTheme() {
   await run('vite', ['serve'], {
-    cwd: resolve(__dirname, '../example'),
+    cwd: devDir,
     stdio: 'inherit',
     env: {
       NODE_ENV: prodMode ? 'production' : 'development',