From ab3f6c60db78969da20759669a1a2bb5ea884d32 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?wifi=E6=AD=AAf?= <1402772884@qq.com> Date: Wed, 5 Feb 2025 20:26:40 +0800 Subject: [PATCH] =?UTF-8?q?test(mini-markdown-editor):=20=E6=B5=8B?= =?UTF-8?q?=E8=AF=95demo?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- packages/mini-markdown-editor/.gitignore | 1 + packages/mini-markdown-editor/README.md | 56 +++++-------------- packages/mini-markdown-editor/package.json | 15 ++++- .../components/Editor/__test__/index.test.tsx | 15 +++++ .../base/__test__/DropDownMenu.test.tsx | 0 .../base/__test__/IconTooltip.test.tsx | 0 .../mini-markdown-editor/src/test/setup.ts | 7 +++ .../mini-markdown-editor/vitest.config.ts | 21 +++++++ 8 files changed, 69 insertions(+), 46 deletions(-) create mode 100644 packages/mini-markdown-editor/src/components/Editor/__test__/index.test.tsx create mode 100644 packages/mini-markdown-editor/src/components/base/__test__/DropDownMenu.test.tsx create mode 100644 packages/mini-markdown-editor/src/components/base/__test__/IconTooltip.test.tsx create mode 100644 packages/mini-markdown-editor/src/test/setup.ts create mode 100644 packages/mini-markdown-editor/vitest.config.ts diff --git a/packages/mini-markdown-editor/.gitignore b/packages/mini-markdown-editor/.gitignore index a547bf3..2ce4953 100644 --- a/packages/mini-markdown-editor/.gitignore +++ b/packages/mini-markdown-editor/.gitignore @@ -22,3 +22,4 @@ dist-ssr *.njsproj *.sln *.sw? +coverage \ No newline at end of file diff --git a/packages/mini-markdown-editor/README.md b/packages/mini-markdown-editor/README.md index 74872fd..d996e48 100644 --- a/packages/mini-markdown-editor/README.md +++ b/packages/mini-markdown-editor/README.md @@ -1,50 +1,20 @@ -# React + TypeScript + Vite +# mini-markdown-editor -This template provides a minimal setup to get React working in Vite with HMR and some ESLint rules. +## 脚本 -Currently, two official plugins are available: +```bash +## 开发环境运行 +pnpm dev -- [@vitejs/plugin-react](https://github.com/vitejs/vite-plugin-react/blob/main/packages/plugin-react/README.md) uses [Babel](https://babeljs.io/) for Fast Refresh -- [@vitejs/plugin-react-swc](https://github.com/vitejs/vite-plugin-react-swc) uses [SWC](https://swc.rs/) for Fast Refresh +## 打包 +pnpm build -## Expanding the ESLint configuration +## 单元测试 +pnpm test -If you are developing a production application, we recommend updating the configuration to enable type aware lint rules: +## 单元测试（watch） +pnpm test:watch -- Configure the top-level `parserOptions` property like this: - -```js -export default tseslint.config({ - languageOptions: { - // other options... - parserOptions: { - project: ['./tsconfig.node.json', './tsconfig.app.json'], - tsconfigRootDir: import.meta.dirname, - }, - }, -}) -``` - -- Replace `tseslint.configs.recommended` to `tseslint.configs.recommendedTypeChecked` or `tseslint.configs.strictTypeChecked` -- Optionally add `...tseslint.configs.stylisticTypeChecked` -- Install [eslint-plugin-react](https://github.com/jsx-eslint/eslint-plugin-react) and update the config: - -```js -// eslint.config.js -import react from 'eslint-plugin-react' - -export default tseslint.config({ - // Set the react version - settings: { react: { version: '18.3' } }, - plugins: { - // Add the react plugin - react, - }, - rules: { - // other rules... - // Enable its recommended rules - ...react.configs.recommended.rules, - ...react.configs['jsx-runtime'].rules, - }, -}) +## 测试覆盖率 +pnpm coverage ``` diff --git a/packages/mini-markdown-editor/package.json b/packages/mini-markdown-editor/package.json index 66669ac..d657b50 100644 --- a/packages/mini-markdown-editor/package.json +++ b/packages/mini-markdown-editor/package.json @@ -8,7 +8,10 @@ "dev": "pnpm build:ast && vite", "build": "tsc -b && vite build", "lint": "eslint .", - "preview": "vite preview" + "preview": "vite preview", + "test": "vitest", + "test:watch": "vitest --watch", + "coverage": "vitest run --coverage" }, "dependencies": { "@codemirror/commands": "^6.8.0", @@ -26,22 +29,28 @@ "html2pdf.js": "^0.10.2", "react": "^18.3.1", "react-dom": "^18.3.1", - "react-hotkeys-hook": "^4.6.1" + "react-hotkeys-hook": "^4.6.1", + "zustand": "^5.0.3" }, "devDependencies": { "@eslint/js": "^9.17.0", "@mini-markdown/ast-parser": "workspace:^1.0.0", + "@testing-library/dom": "^10.4.0", + "@testing-library/jest-dom": "^6.6.3", + "@testing-library/react": "^16.2.0", "@types/react": "^18.3.18", "@types/react-dom": "^18.3.5", "@vitejs/plugin-react": "^4.3.4", + "@vitest/coverage-v8": "3.0.5", "eslint": "^9.17.0", "eslint-plugin-react-hooks": "^5.0.0", "eslint-plugin-react-refresh": "^0.4.16", "globals": "^15.14.0", + "jsdom": "^26.0.0", "styled-components": "^6.1.14", "typescript": "~5.6.2", "typescript-eslint": "^8.18.2", "vite": "^6.0.5", - "zustand": "^5.0.3" + "vitest": "^3.0.5" } } diff --git a/packages/mini-markdown-editor/src/components/Editor/__test__/index.test.tsx b/packages/mini-markdown-editor/src/components/Editor/__test__/index.test.tsx new file mode 100644 index 0000000..39fca10 --- /dev/null +++ b/packages/mini-markdown-editor/src/components/Editor/__test__/index.test.tsx @@ -0,0 +1,15 @@ +import { describe, test, expect } from "vitest"; +import { render } from "@testing-library/react"; +import "@testing-library/jest-dom"; + +import Editor from "../index"; + +describe("Editor 组件测试", () => { + test("测试组件渲染", async () => { + // 渲染组件 + const dom = await render(); + // 是否符合预期 + expect(dom).toBeTruthy(); + //...省略 + }); +}); diff --git a/packages/mini-markdown-editor/src/components/base/__test__/DropDownMenu.test.tsx b/packages/mini-markdown-editor/src/components/base/__test__/DropDownMenu.test.tsx new file mode 100644 index 0000000..e69de29 diff --git a/packages/mini-markdown-editor/src/components/base/__test__/IconTooltip.test.tsx b/packages/mini-markdown-editor/src/components/base/__test__/IconTooltip.test.tsx new file mode 100644 index 0000000..e69de29 diff --git a/packages/mini-markdown-editor/src/test/setup.ts b/packages/mini-markdown-editor/src/test/setup.ts new file mode 100644 index 0000000..c712265 --- /dev/null +++ b/packages/mini-markdown-editor/src/test/setup.ts @@ -0,0 +1,7 @@ +import "@testing-library/jest-dom"; +import { cleanup } from "@testing-library/react"; +import { afterEach } from "vitest"; + +afterEach(() => { + cleanup(); +}); diff --git a/packages/mini-markdown-editor/vitest.config.ts b/packages/mini-markdown-editor/vitest.config.ts new file mode 100644 index 0000000..544198d --- /dev/null +++ b/packages/mini-markdown-editor/vitest.config.ts @@ -0,0 +1,21 @@ +import { defineConfig } from "vitest/config"; +import react from "@vitejs/plugin-react"; +import { fileURLToPath } from "node:url"; + +export default defineConfig({ + plugins: [react()], + test: { + environment: "jsdom", + globals: true, + setupFiles: "./src/test/setup.ts", + include: ["src/**/*.{test,spec}.{js,ts,jsx,tsx}"], + coverage: { + include: ["src/components/**", "src/hooks/**", "src/utils/**", "src/store/**"], + }, + }, + resolve: { + alias: { + "@": fileURLToPath(new URL("./src", import.meta.url)), + }, + }, +}); -- Gitee