Developing with the HUD

Dependences

Installing

Install npm from the Node.js site.

After installing run npm install in the zap-hud directory to install the HUD dependences.

Building

The HUD uses webpack as its static module bundler to transpile Vue & javascript files.

Run webpack with: npm run build

The HUD uses Gradle as its Java build tool.

Run the following command from the root directory: gradle deployZapAddOn

Testing

The HUD uses ava as its testing framework.

Run all tests with:

npm run test or gradle npmTestHud

Tests are found in the src/test/js directory.

Linting

The HUD uses xo as its linter.

Run the linter with:

npm run lint or gradle npmLintAllHud

If you want to lint just the staged changes use:

npm run lint-staged or gradle npmLintStagedHud