Merge pull request #69 from tidbcloud/feat/vue-demo

baurine · web-flow · commit fef46e6282ce · 2024-08-01T12:38:37.000+08:00
feat: vue demo
diff --git a/README.md b/README.md
@@ -77,7 +77,7 @@ export function Editor() {
 
 ### Setup
 
-- node.js >18.16.0
+- node.js > 20.0
 - [enable corepack](https://www.totaltypescript.com/how-to-use-corepack): `corepack enable && corepack enable npm`
 
 ### Local Development
diff --git a/package.json b/package.json
@@ -9,9 +9,11 @@
     "dev": "pnpm -r --parallel dev",
     "dev:playground": "pnpm --filter @tidbcloud/tisqleditor-playground... --parallel dev",
     "dev:playground-nextjs": "pnpm --filter @tidbcloud/tisqleditor-playground-nextjs... --parallel dev",
+    "dev:vue-demo": "pnpm --filter @tidbcloud/tisqleditor-vue-demo... --parallel dev",
     "build": "pnpm -r build",
     "build:playground": "pnpm --filter @tidbcloud/tisqleditor-playground... run build",
     "build:playground-nextjs": "pnpm --filter @tidbcloud/tisqleditor-playground-nextjs... run build",
+    "build:vue-demo": "pnpm --filter @tidbcloud/tisqleditor-vue-demo... run build",
     "test": "jest",
     "release": "changeset publish"
   },
diff --git a/packages/playground-nextjs/package.json b/packages/playground-nextjs/package.json
@@ -1,7 +1,7 @@
 {
   "name": "@tidbcloud/tisqleditor-playground-nextjs",
   "private": true,
-  "version": "0.0.1",
+  "version": "0.0.6",
   "scripts": {
     "dev": "next dev",
     "build": "next build",
diff --git a/packages/vue-demo/.gitignore b/packages/vue-demo/.gitignore
@@ -0,0 +1,24 @@
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+pnpm-debug.log*
+lerna-debug.log*
+
+node_modules
+dist
+dist-ssr
+*.local
+
+# Editor directories and files
+.vscode/*
+!.vscode/extensions.json
+.idea
+.DS_Store
+*.suo
+*.ntvs*
+*.njsproj
+*.sln
+*.sw?
diff --git a/packages/vue-demo/README.md b/packages/vue-demo/README.md
@@ -0,0 +1,16 @@
+# TiSQLEditor Vue Component Demo
+
+This demo is used to test `@tidbcloud/tisqleditor-vue` package, created by Vue3+Typescript+Vite.
+
+## Preview
+
+👉🏻 [Try it](https://tisqleditor-vue-demo.vercel.app)
+
+![tisqleditor vue demo](./public/tisqleditor-vue-demo.png)
+
+## Getting Started
+
+```bash
+pnpm i
+pnpm dev
+```
diff --git a/packages/vue-demo/index.html b/packages/vue-demo/index.html
@@ -0,0 +1,13 @@
+<!doctype html>
+<html lang="en">
+  <head>
+    <meta charset="UTF-8" />
+    <link rel="icon" type="image/svg+xml" href="/vue.svg" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+    <title>TiSQLEditor Vue Demo</title>
+  </head>
+  <body>
+    <div id="app"></div>
+    <script type="module" src="/src/main.ts"></script>
+  </body>
+</html>
diff --git a/packages/vue-demo/package.json b/packages/vue-demo/package.json
@@ -0,0 +1,25 @@
+{
+  "name": "@tidbcloud/tisqleditor-vue-demo",
+  "private": true,
+  "version": "0.0.6",
+  "type": "module",
+  "scripts": {
+    "dev": "vite",
+    "build": "vue-tsc -b && vite build",
+    "preview": "vite preview"
+  },
+  "dependencies": {
+    "@tidbcloud/codemirror-extension-ai-widget": "workspace:^",
+    "@tidbcloud/codemirror-extension-cur-sql-gutter": "workspace:^",
+    "@tidbcloud/codemirror-extension-sql-autocomplete": "workspace:^",
+    "@tidbcloud/codemirror-extension-themes": "workspace:^",
+    "@tidbcloud/tisqleditor-vue": "workspace:^",
+    "vue": "^3.4.31"
+  },
+  "devDependencies": {
+    "@vitejs/plugin-vue": "^5.0.5",
+    "typescript": "^5.2.2",
+    "vite": "^5.3.4",
+    "vue-tsc": "^2.0.24"
+  }
+}
diff --git a/packages/vue-demo/public/tisqleditor-vue-demo.png b/packages/vue-demo/public/tisqleditor-vue-demo.png
diff --git a/packages/vue-demo/public/vite.svg b/packages/vue-demo/public/vite.svg
@@ -0,0 +1 @@
+<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" aria-hidden="true" role="img" class="iconify iconify--logos" width="31.88" height="32" preserveAspectRatio="xMidYMid meet" viewBox="0 0 256 257"><defs><linearGradient id="IconifyId1813088fe1fbc01fb466" x1="-.828%" x2="57.636%" y1="7.652%" y2="78.411%"><stop offset="0%" stop-color="#41D1FF"></stop><stop offset="100%" stop-color="#BD34FE"></stop></linearGradient><linearGradient id="IconifyId1813088fe1fbc01fb467" x1="43.376%" x2="50.316%" y1="2.242%" y2="89.03%"><stop offset="0%" stop-color="#FFEA83"></stop><stop offset="8.333%" stop-color="#FFDD35"></stop><stop offset="100%" stop-color="#FFA800"></stop></linearGradient></defs><path fill="url(#IconifyId1813088fe1fbc01fb466)" d="M255.153 37.938L134.897 252.976c-2.483 4.44-8.862 4.466-11.382.048L.875 37.958c-2.746-4.814 1.371-10.646 6.827-9.67l120.385 21.517a6.537 6.537 0 0 0 2.322-.004l117.867-21.483c5.438-.991 9.574 4.796 6.877 9.62Z"></path><path fill="url(#IconifyId1813088fe1fbc01fb467)" d="M185.432.063L96.44 17.501a3.268 3.268 0 0 0-2.634 3.014l-5.474 92.456a3.268 3.268 0 0 0 3.997 3.378l24.777-5.718c2.318-.535 4.413 1.507 3.936 3.838l-7.361 36.047c-.495 2.426 1.782 4.5 4.151 3.78l15.304-4.649c2.372-.72 4.652 1.36 4.15 3.788l-11.698 56.621c-.732 3.542 3.979 5.473 5.943 2.437l1.313-2.028l72.516-144.72c1.215-2.423-.88-5.186-3.54-4.672l-25.505 4.922c-2.396.462-4.435-1.77-3.759-4.114l16.646-57.705c.677-2.35-1.37-4.583-3.769-4.113Z"></path></svg>
diff --git a/packages/vue-demo/public/vue.svg b/packages/vue-demo/public/vue.svg
@@ -0,0 +1 @@
+<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" aria-hidden="true" role="img" class="iconify iconify--logos" width="37.07" height="36" preserveAspectRatio="xMidYMid meet" viewBox="0 0 256 198"><path fill="#41B883" d="M204.8 0H256L128 220.8L0 0h97.92L128 51.2L157.44 0h47.36Z"></path><path fill="#41B883" d="m0 0l128 220.8L256 0h-51.2L128 132.48L50.56 0H0Z"></path><path fill="#35495E" d="M50.56 0L128 133.12L204.8 0h-47.36L128 51.2L97.92 0H50.56Z"></path></svg>
diff --git a/packages/vue-demo/src/App.vue b/packages/vue-demo/src/App.vue
@@ -0,0 +1,68 @@
+<script setup lang="ts">
+import { ref } from 'vue'
+
+import { SQLEditor, EditorCacheProvide } from '@tidbcloud/tisqleditor-vue'
+import { oneDark, bbedit } from '@tidbcloud/codemirror-extension-themes'
+import {
+  aiWidget,
+  isUnifiedMergeViewActive
+} from '@tidbcloud/codemirror-extension-ai-widget'
+import { curSqlGutter } from '@tidbcloud/codemirror-extension-cur-sql-gutter'
+import { sqlAutoCompletion } from '@tidbcloud/codemirror-extension-sql-autocomplete'
+
+import { delay } from './lib/delay'
+
+const isDark = ref(true)
+function toggle() {
+  isDark.value = !isDark.value
+}
+
+const extraExts = [
+  aiWidget({
+    chat: async () => {
+      await delay(2000)
+      return {
+        status: 'success',
+        message:
+          'select * from test;\n-- the data is mocked, replace by your own api when using'
+      }
+    },
+    cancelChat: () => {},
+    getDbList: () => {
+      return ['test1', 'test2']
+    }
+  }),
+  sqlAutoCompletion(),
+  curSqlGutter({
+    whenHide(view) {
+      return isUnifiedMergeViewActive(view.state)
+    }
+  })
+]
+</script>
+
+<template>
+  <EditorCacheProvide>
+    <h2>TiSQLEditor Vue Component Demo</h2>
+    <button @click="toggle">
+      toggle theme: {{ isDark ? 'dark' : 'light' }}
+    </button>
+
+    <SQLEditor
+      class="editorContainer"
+      editorId="test"
+      doc="select * from test;"
+      :theme="isDark ? oneDark : bbedit"
+      :extraExts="extraExts"
+    />
+  </EditorCacheProvide>
+</template>
+
+<style scoped>
+.editorContainer {
+  height: 400px;
+  width: 800px;
+  text-align: left;
+  margin-top: 16px;
+}
+</style>
diff --git a/packages/vue-demo/src/lib/delay.ts b/packages/vue-demo/src/lib/delay.ts
@@ -0,0 +1,3 @@
+export function delay(ms: number) {
+  return new Promise((resolve) => setTimeout(resolve, ms))
+}
diff --git a/packages/vue-demo/src/main.ts b/packages/vue-demo/src/main.ts
@@ -0,0 +1,5 @@
+import { createApp } from 'vue'
+import './style.css'
+import App from './App.vue'
+
+createApp(App).mount('#app')
diff --git a/packages/vue-demo/src/style.css b/packages/vue-demo/src/style.css
@@ -0,0 +1,79 @@
+:root {
+  font-family: Inter, system-ui, Avenir, Helvetica, Arial, sans-serif;
+  line-height: 1.5;
+  font-weight: 400;
+
+  color-scheme: light dark;
+  color: rgba(255, 255, 255, 0.87);
+  background-color: #242424;
+
+  font-synthesis: none;
+  text-rendering: optimizeLegibility;
+  -webkit-font-smoothing: antialiased;
+  -moz-osx-font-smoothing: grayscale;
+}
+
+a {
+  font-weight: 500;
+  color: #646cff;
+  text-decoration: inherit;
+}
+a:hover {
+  color: #535bf2;
+}
+
+body {
+  margin: 0;
+  display: flex;
+  place-items: center;
+  min-width: 320px;
+  min-height: 100vh;
+}
+
+h1 {
+  font-size: 3.2em;
+  line-height: 1.1;
+}
+
+button {
+  border-radius: 8px;
+  border: 1px solid transparent;
+  padding: 0.6em 1.2em;
+  font-size: 1em;
+  font-weight: 500;
+  font-family: inherit;
+  background-color: #1a1a1a;
+  cursor: pointer;
+  transition: border-color 0.25s;
+}
+button:hover {
+  border-color: #646cff;
+}
+button:focus,
+button:focus-visible {
+  outline: 4px auto -webkit-focus-ring-color;
+}
+
+.card {
+  padding: 2em;
+}
+
+#app {
+  max-width: 1280px;
+  margin: 0 auto;
+  padding: 2rem;
+  text-align: center;
+}
+
+@media (prefers-color-scheme: light) {
+  :root {
+    color: #213547;
+    background-color: #ffffff;
+  }
+  a:hover {
+    color: #747bff;
+  }
+  button {
+    background-color: #f9f9f9;
+  }
+}
diff --git a/packages/vue-demo/src/vite-env.d.ts b/packages/vue-demo/src/vite-env.d.ts
@@ -0,0 +1 @@
+/// <reference types="vite/client" />
diff --git a/packages/vue-demo/tsconfig.app.json b/packages/vue-demo/tsconfig.app.json
@@ -0,0 +1,27 @@
+{
+  "compilerOptions": {
+    "composite": true,
+    "tsBuildInfoFile": "./node_modules/.tmp/tsconfig.app.tsbuildinfo",
+    "target": "ES2020",
+    "useDefineForClassFields": true,
+    "module": "ESNext",
+    "lib": ["ES2020", "DOM", "DOM.Iterable"],
+    "skipLibCheck": true,
+
+    /* Bundler mode */
+    "moduleResolution": "bundler",
+    "allowImportingTsExtensions": true,
+    "resolveJsonModule": true,
+    "isolatedModules": true,
+    "moduleDetection": "force",
+    "noEmit": true,
+    "jsx": "preserve",
+
+    /* Linting */
+    "strict": true,
+    "noUnusedLocals": true,
+    "noUnusedParameters": true,
+    "noFallthroughCasesInSwitch": true
+  },
+  "include": ["src/**/*.ts", "src/**/*.tsx", "src/**/*.vue"]
+}
diff --git a/packages/vue-demo/tsconfig.json b/packages/vue-demo/tsconfig.json
@@ -0,0 +1,11 @@
+{
+  "files": [],
+  "references": [
+    {
+      "path": "./tsconfig.app.json"
+    },
+    {
+      "path": "./tsconfig.node.json"
+    }
+  ]
+}
diff --git a/packages/vue-demo/tsconfig.node.json b/packages/vue-demo/tsconfig.node.json
@@ -0,0 +1,13 @@
+{
+  "compilerOptions": {
+    "composite": true,
+    "tsBuildInfoFile": "./node_modules/.tmp/tsconfig.node.tsbuildinfo",
+    "skipLibCheck": true,
+    "module": "ESNext",
+    "moduleResolution": "bundler",
+    "allowSyntheticDefaultImports": true,
+    "strict": true,
+    "noEmit": true
+  },
+  "include": ["vite.config.ts"]
+}
diff --git a/packages/vue-demo/vite.config.ts b/packages/vue-demo/vite.config.ts
@@ -0,0 +1,7 @@
+import { defineConfig } from 'vite'
+import vue from '@vitejs/plugin-vue'
+
+// https://vitejs.dev/config/
+export default defineConfig({
+  plugins: [vue()]
+})
diff --git a/packages/vue/package.json b/packages/vue/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@tidbcloud/tisqleditor-vue",
-  "version": "0.0.3",
+  "version": "0.0.6",
   "description": "tisqleditor vue component",
   "type": "module",
   "main": "dist/index.js",
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml

Original file line number	Diff line number	Diff line change
`@@ -1,7 +1,7 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "@tidbcloud/tisqleditor-playground-nextjs",`
`3`	`3`	`"private": true,`
`4`		`- "version": "0.0.1",`
	`4`	`+ "version": "0.0.6",`
`5`	`5`	`"scripts": {`
`6`	`6`	`"dev": "next dev",`
`7`	`7`	`"build": "next build",`