haze/DEVELOPING.md

Developing

Setup

Nix based development environment

The recommended way to setup the development environment is to use Lix/Nix.

Once installed, you can enter the development shell using nix develop or, setup direnv to automatically enter the development shell when you enter the folder.

The development shell provides all necessary tooling to develop haze.

Without Nix

The fooling tools need to be setup to develop without using Nix to manage the development setup:

• cargo - For building the program
• mdbook - For building the documentation
• prettier - For formatting the non-rust files
• vale - For checking documentation

Building

cargo build

The binary can then be found at target/debug/haze.

Formatting

With Nix

nix fmt

Without Nix

Rust code

cargo fmt

Documentation

prettier --write '**/*.md'

Building documentation

mdbook serve

Checking documentation

vale src/ book/src/ book/README.md *.md

Run all checks

nix flake check

Building docker images

nix run .#'"haze-image-php-8.4"'.copyToDockerDaemon