From 2a34003d9ddd7e3fd7553fe054c6a9ab7127fc72 Mon Sep 17 00:00:00 2001 From: QiaoJ-Chen Date: Sun, 22 Sep 2024 21:58:58 +0800 Subject: [PATCH] [Fix][Engine UI] update the doc. How to use it --- .../seatunnel-engine-ui/README.md | 34 ++----------------- 1 file changed, 2 insertions(+), 32 deletions(-) diff --git a/seatunnel-engine/seatunnel-engine-ui/README.md b/seatunnel-engine/seatunnel-engine-ui/README.md index e60417505a45..c84b0e6a612a 100644 --- a/seatunnel-engine/seatunnel-engine-ui/README.md +++ b/seatunnel-engine/seatunnel-engine-ui/README.md @@ -1,19 +1,5 @@ # seatunnel-engine-ui -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). - -## 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 [Volar](https://marketplace.visualstudio.com/items?itemName=Vue.volar) to make the TypeScript language service aware of `.vue` types. - -## Customize configuration - -See [Vite Configuration Reference](https://vitejs.dev/config/). - ## Project Setup ```sh @@ -32,29 +18,13 @@ pnpm dev pnpm build ``` -### Run Unit Tests with [Vitest](https://vitest.dev/) +### Run Unit Tests with [Vitest] ```sh pnpm test:unit ``` -### Run End-to-End Tests with [Cypress](https://www.cypress.io/) - -```sh -pnpm test:e2e:dev -``` - -This runs the end-to-end tests against the Vite development server. -It is much faster than the production build. - -But it's still recommended to test the production build with `test:e2e` before deploying (e.g. in CI environments): - -```sh -pnpm build -pnpm test:e2e -``` - -### Lint with [ESLint](https://eslint.org/) +### Lint with [ESLint] ```sh pnpm lint