Skip to content

Npm Scripts

$ npm run %SCRIPT_NAME%

General

Script NameDescription
devStart Electron as a development environment
dev:debugStart Electron as a development environment (with vite debug)
dev:debug:forceStart Electron as a development environment (with vite debug + clean vite cache)
build:preCommands commonly run at build time. This script does not need to be run separately.
buildBuild the package for the current operating system.
build:allBuild a specified package for the entire operating system (Requires cross-platform build configuration)
build:direlectron-builder directory build
build:macBuild preconfigured packages for macOS
build:linuxBuild preconfigured packages for Linux
build:winBuild preconfigured packages for Windows
lintESLint code inspection. It does not modify the code.
lint:fixESLint code inspection. Use auto-fix to fix your code.
formatPrettier code inspection. It does not modify the code.
format:fixPrettier code inspection. Use auto-fix to fix your code.
testBuild a package for testing and run tests against the test specification file.
test:linuxBuild a package for testing and run tests against the test specification file. (for linux ci only)

For Documentation

Used only for contributing to project documentation. Must be run from the docs directory location.

Script NameDescription
devStart the local document server. (For development)
buildBuild a local document server. Used only for GitHub page builders.
serveStart the local document server.