Files

undergroundwires 75c9b51bf2 Migrate to electron-vite and electron-builder

- Switch from deprecated Vue CLI plugin to `electron-vite` (see
  nklayman/vue-cli-plugin-electron-builder#1982)
- Update main/preload scripts to use `index.cjs` filenames to support
  `"type": "module"`, resolving crash issue (#233). This crash was
  related to Electron not supporting ESM (see electron/asar#249,
  electron/electron#21457).
- This commit completes migration to Vite from Vue CLI (#230).

Structure changes:

- Introduce separate folders for Electron's main and preload processes.
- Move TypeHelpers to `src/` to mark tit as accessible by the rest of
  the code.

Config changes:

- Make `vite.config.ts` reusable by Electron configuration.
- On electron-builder, use `--publish` flag instead of `-p` for clarity.

Tests:

- Add log for preload script loading verification.
- Implement runtime environment sanity checks.
- Enhance logging in `check-desktop-runtime-errors`.

2023-08-24 20:01:53 +02:00

3.1 KiB

Raw Blame History

Development

Before your commit, a good practice is to:

Run unit tests
Lint your code

You could run other types of tests as well, but they may take longer time and overkill for your changes. Automated actions executes the tests for a pull request or change in the main branch. See ci-cd.md for more information.

Commands

Prerequisites

Install node >15.x.
Install dependencies using npm install.

Testing

Run unit tests: npm run test:unit
Run integration tests: npm run test:integration
Run end-to-end (e2e) tests:
- npm run test:cy:open: Run tests interactively using the development server with hot-reloading.
- npm run test:cy:run: Run tests on the production build in a headless mode.

📖 Read more about testing in tests.

Linting

Lint all (recommended 💡): npm run lint
Markdown: npm run lint:md
Markdown consistency npm run lint:md:consistency
Markdown relative URLs: npm run lint:md:relative-urls
JavaScript/TypeScript: npm run lint:eslint
Yaml: npm run lint:yaml

Running

Web:

Run in local server: npm run dev
- 💡 Meant for local development with features such as hot-reloading.
Preview production build: npm run preview
- Start a local web server that serves the built solution from ./dist.
- 💡 Run npm run build before npm run preview.

Desktop apps:

npm run electron:dev: The command will build the main process and preload scripts source code, and start a dev server for the renderer, and start the Electron app.
npm run electron:preview: The command will build the main process, preload scripts and renderer source code, and start the Electron app to preview.
npm run electron:prebuild: The command will build the main process, preload scripts and renderer source code. Usually before packaging the Electron application, you need to execute this command.
npm run electron:build: Prebuilds the Electron application, packages and publishes it through electron-builder.

Docker:

Build: docker build -t undergroundwires/privacy.sexy:latest .
Run: docker run -it -p 8080:80 --rm --name privacy.sexy undergroundwires/privacy.sexy:latest

Building

Build web application: npm run build
Build desktop application: npm run electron:build
(Re)create icons (see documentation): npm run create-icons

Utility Scripts

Run fresh NPM install: ./scripts/fresh-npm-install.sh
- This script provides a clean NPM install, removing existing node modules and optionally the package-lock.json (when run with -n), then installs dependencies and runs unit tests.
Configure VSCode: ./scripts/configure-vscode.sh
- This script checks and sets the necessary configurations for VSCode in settings.json file.

Recommended extensions

You should use EditorConfig to follow project style.

For Visual Studio Code, .vscode/extensions.json includes list of recommended extensions.

3.1 KiB Raw Blame History