Here’s a list of all the commands used by the Desktop App. These can all be found in package.json
, and should be run using npm
, using the following syntax: npm run <command>
.
build
- An amalgam of the following build commands, used to build the Desktop App:
build:main
- Builds the source code used by the Electron Main processbuild:renderer
- Builds the source code used by the Electron Renderer processbuild:robotjs
- Builds a version of RobotJS specifically for the current OS/architecture/Electron versionstart
- Runs the Desktop App using the current code built in the dist/ folderrestart
- Re-runs the build process and then starts the app (amalgam of build and start)clean
- Removes all installed Node modules and built code
clean-install
- Same as above, but then runs npm install to reinstall the Node modulesclean-dist
- Only removes the built codewatch
- Runs the app, but watches for code changes and re-compiles on the fly when a file is changed
watch:main
- Same as above, but only for the main modulewatch:renderer
- Same as above, but only for the renderer moduletest
- Builds and runs all of the automated tests for the Desktop App
test:e2e
- Builds and runs the E2E tests for the Desktop App
test:e2e:nobuild
- Runs the E2E tests without rebuilding the entire apptest:e2e:build
- Builds the E2E teststest:e2e:run
- Runs the E2E tests without building themtest:unit
- Runs the unit tests for the main moduletest:coverage
- Runs the unit tests and displays a coverage breakdownpackage:all
- Builds and creates distributable packages for all OSes
package:windows
- Builds and creates distributable packages for Windowspackage:mac
- Builds and creates distributable packages for macOSpackage:mac-universal
- Builds and creates a Universal binary for macOSpackage:linux
- Builds and creates distributable packages for Linuxlint:js
- Runs ESLint against the code and displays results
lint:js-quiet
- Same as above, but with the –quiet optionfix:js
- Save as above, but attempts to fix some of the issuescheck-build-config
- Builds and validates the build config
check-build-config:build
- Builds the build configcheck-build-config:run
- Validates the build configcheck-types
- Runs the TypeScript compiler against the codeprune
- Runs ts-prune to display unused codeSome useful CLI options the desktop app uses are shown below. You can also display these options by running: npm run start help
.
--version, -v: Prints the application version
--dataDir, -d: Set the path to where user data is stored
--disableDevMode, -p: Disable development mode to allow for testing as if it was Production
Some common environment variables that are used include:
NODE_ENV
: Defines the Node environment
PRODUCTION
: Used for Production modeDEVELOPMENT
: Development modeTEST
: Used when running automated testsMM_DEBUG_MODALS
: Used for debugging modals, set to 1
to show Developer Tools when a modal is openedMM_DEBUG_SETTINGS
: Used for debugging the Settings Window, set to 1
to show Developer Tools when the window is opened