docs: update documents for application testing

This commit is contained in:
leejooy96 committed 2023-06-28 09:05:26 +09:00
1 parent 519e4928ad
commit dbb5636709
5 files changed
+33 -6

No files matched your search

+8
View File
@@ -9,3 +9,11 @@ Only very simple launch and behavioral tests for the template main screen have b
Currently, the test specification file is located in the `tests` directory and the test results file is located in `tests/results`. (The built-in test specification file does not generate a separate results file.) Currently, the test specification file is located in the `tests` directory and the test results file is located in `tests/results`. (The built-in test specification file does not generate a separate results file.)
The Playwright configuration is `playwright.config.ts` in the project root, see the following documentation for more information on this: https://playwright.dev/docs/test-configuration The Playwright configuration is `playwright.config.ts` in the project root, see the following documentation for more information on this: https://playwright.dev/docs/test-configuration
Once everything is configured, you can run a test with the following command.
```shell
$ npm run test
```
Before running the test, empty the build directory (`dist`) and compile the package for the test.
+1
View File
@@ -19,6 +19,7 @@
| `lint:fix` | ESLint code inspection. Use auto-fix to fix your code. | | `lint:fix` | ESLint code inspection. Use auto-fix to fix your code. |
| `format` | Prettier code inspection. It does not modify the code. | | `format` | Prettier code inspection. It does not modify the code. |
| `format:fix` | Prettier code inspection. Use auto-fix to fix your code. | | `format:fix` | Prettier code inspection. Use auto-fix to fix your code. |
| `test` | Build a package for testing and run tests against the test specification file. |
## For Documentation ## For Documentation
+2 -2
View File
@@ -6,10 +6,10 @@ Also check out the `Retron` project, which consists of Vite + React + Material-U
https://github.com/jooy2/retron https://github.com/jooy2/retron
## (Deprecated) Looking for Vutron with Webpack 5 compiler? ## (Deprecated) Looking for `Vutron` with Webpack 5 compiler?
By using the Vite compiler, we achieved our goals of reducing project and bundle size, and improving development environment and build speed. By using the Vite compiler, we achieved our goals of reducing project and bundle size, and improving development environment and build speed.
The old Vutron using the Webpack 5 compiler has been split into the repositories below and will end support soon. The old **Vutron** using the Webpack 5 compiler has been split into the repositories below and will end support soon.
https://github.com/jooy2/vutron-webpack https://github.com/jooy2/vutron-webpack
+18 -3
View File
@@ -1,13 +1,28 @@
# Pre-configured Components # Pre-configured Components
## Web app frameworks
- [Vite](https://vitejs.dev) - [Vite](https://vitejs.dev)
- [Electron](https://www.electronjs.org) - [Electron](https://www.electronjs.org)
- [Electron Builder](https://www.electron.build) - [Electron Builder](https://www.electron.build)
## Development help tools
- [TypeScript](https://www.typescriptlang.org) - [TypeScript](https://www.typescriptlang.org)
- [ESLint](https://eslint.org)
- [Prettier](https://prettier.io)
## Front-end frameworks (Vue)
- [Vue](https://vuejs.org) - [Vue](https://vuejs.org)
- [Vue-i18n](https://kazupon.github.io/vue-i18n) - [Vue-i18n](https://kazupon.github.io/vue-i18n)
- [Vue-router](https://router.vuejs.org) - [Vue-router](https://router.vuejs.org)
- [Vuetify](https://vuetifyjs.com)
- [Pinia](https://pinia.vuejs.org) - [Pinia](https://pinia.vuejs.org)
- [ESLint](https://eslint.org)
- [Prettier](https://prettier.io) ## Design frameworks
- [Vuetify](https://vuetifyjs.com)
## Testing
- [Playwright](https://playwright.dev)
+4 -1
View File
@@ -8,7 +8,7 @@
│ └─ workflows/ - GitHub workflows definition │ └─ workflows/ - GitHub workflows definition
│ └─ dependabot.yml │ └─ dependabot.yml
│ └─ FUNDING.yml │ └─ FUNDING.yml
├─ buildAssets - Package resource (icon, logo, etc.) file used for Electron build ├─ buildAssets/ - Package resource (icon, logo, etc.) file used for Electron build
│ └─ icons/ │ └─ icons/
├─ dist/ - Output directory used to build the package ├─ dist/ - Output directory used to build the package
├─ docs/ - Project documents (optionally enabled) ├─ docs/ - Project documents (optionally enabled)
@@ -43,6 +43,8 @@
│ │ ├─ App.vue - Vue app's root component │ │ ├─ App.vue - Vue app's root component
│ │ ├─ index.html - Root static index loaded by Electron renderer process │ │ ├─ index.html - Root static index loaded by Electron renderer process
│ └─ └─ main.ts - Renderer process entry point │ └─ └─ main.ts - Renderer process entry point
├─ tests/ - Application test configuration
│ └─ app.spec.ts - Test file specification
├─ .editorconfig - Editor recommended configuration file for IDE ├─ .editorconfig - Editor recommended configuration file for IDE
├─ .eslintignore - List of files to be ignored by ESLint ├─ .eslintignore - List of files to be ignored by ESLint
├─ .eslintrc.json - ESLint rule configurations ├─ .eslintrc.json - ESLint rule configurations
@@ -54,6 +56,7 @@
├─ LICENSE - Project license file ├─ LICENSE - Project license file
├─ package.json - NodeJS package configurations ├─ package.json - NodeJS package configurations
├─ package-lock.json ├─ package-lock.json
├─ playwright.config.ts - Playwright test rules configurations
├─ tsconfig.json - TypeScript configurations ├─ tsconfig.json - TypeScript configurations
├─ tsconfig.node.json - TypeScript configurations ├─ tsconfig.node.json - TypeScript configurations
├─ vite.config.ts - Vite compiler build configurations ├─ vite.config.ts - Vite compiler build configurations