diff --git a/docs/src/automated-testing.md b/docs/src/automated-testing.md index 8efbfcc..3b91de5 100644 --- a/docs/src/automated-testing.md +++ b/docs/src/automated-testing.md @@ -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.) 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. diff --git a/docs/src/npm-scripts.md b/docs/src/npm-scripts.md index db02295..0a733b9 100644 --- a/docs/src/npm-scripts.md +++ b/docs/src/npm-scripts.md @@ -19,6 +19,7 @@ | `lint:fix` | ESLint code inspection. Use auto-fix to fix your code. | | `format` | Prettier code inspection. It does not modify the 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 diff --git a/docs/src/other-projects.md b/docs/src/other-projects.md index 539aed1..40aa320 100644 --- a/docs/src/other-projects.md +++ b/docs/src/other-projects.md @@ -6,10 +6,10 @@ Also check out the `Retron` project, which consists of Vite + React + Material-U 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. -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 diff --git a/docs/src/pre-configured-components.md b/docs/src/pre-configured-components.md index 451dab4..c4b485d 100644 --- a/docs/src/pre-configured-components.md +++ b/docs/src/pre-configured-components.md @@ -1,13 +1,28 @@ # Pre-configured Components +## Web app frameworks + - [Vite](https://vitejs.dev) - [Electron](https://www.electronjs.org) - [Electron Builder](https://www.electron.build) + +## Development help tools + - [TypeScript](https://www.typescriptlang.org) +- [ESLint](https://eslint.org) +- [Prettier](https://prettier.io) + +## Front-end frameworks (Vue) + - [Vue](https://vuejs.org) - [Vue-i18n](https://kazupon.github.io/vue-i18n) - [Vue-router](https://router.vuejs.org) -- [Vuetify](https://vuetifyjs.com) - [Pinia](https://pinia.vuejs.org) -- [ESLint](https://eslint.org) -- [Prettier](https://prettier.io) + +## Design frameworks + +- [Vuetify](https://vuetifyjs.com) + +## Testing + +- [Playwright](https://playwright.dev) diff --git a/docs/src/project-structure.md b/docs/src/project-structure.md index 8f33546..0b8e9c7 100644 --- a/docs/src/project-structure.md +++ b/docs/src/project-structure.md @@ -8,7 +8,7 @@ │ └─ workflows/ - GitHub workflows definition │ └─ dependabot.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/ ├─ dist/ - Output directory used to build the package ├─ docs/ - Project documents (optionally enabled) @@ -43,6 +43,8 @@ │ │ ├─ App.vue - Vue app's root component │ │ ├─ index.html - Root static index loaded by Electron renderer process │ └─ └─ main.ts - Renderer process entry point +├─ tests/ - Application test configuration +│ └─ app.spec.ts - Test file specification ├─ .editorconfig - Editor recommended configuration file for IDE ├─ .eslintignore - List of files to be ignored by ESLint ├─ .eslintrc.json - ESLint rule configurations @@ -54,6 +56,7 @@ ├─ LICENSE - Project license file ├─ package.json - NodeJS package configurations ├─ package-lock.json +├─ playwright.config.ts - Playwright test rules configurations ├─ tsconfig.json - TypeScript configurations ├─ tsconfig.node.json - TypeScript configurations ├─ vite.config.ts - Vite compiler build configurations