Development Tasks #

This project uses mise to manage development tools and run common tasks. Mise ensures everyone uses the same tool versions and provides convenient commands for formatting and linting.

If you prefer not to use mise, all tasks have equivalent shell scripts in the tasks/ directory.

Available Tasks #

audit #

• Usage: audit

Audit dependencies

build #

• Usage: build
• Aliases: b

Build the project

check #

• Usage: check
• Aliases: c

Check for compilation errors

format #

• Depends: format:**

• Usage: format

• Aliases: fmt

Format all files

format:markdown #

• Usage: format:markdown
• Aliases: fmt:markdown, fmt:md, format:md

Format markdown files

format:rust #

• Usage: format:rust
• Aliases: fmt:rust, fmt:rs, format:rs

Format rust files

format:toml #

• Usage: format:toml
• Aliases: fmt:toml

Format toml files

format:yaml #

• Usage: format:yaml
• Aliases: fmt:yaml, fmt:yml, format:yml

Format yaml files

lint #

• Depends: lint:**

• Usage: lint

• Aliases: l

Lint all files

lint:editorconfig #

• Usage: lint:editorconfig
• Aliases: l:ec, l:editorconfig, lint:ec

Lint files with editorconfig-checker

lint:markdown #

• Usage: lint:markdown
• Aliases: l:md, l:markdown, lint:md

Lint markdown files

lint:rust #

• Usage: lint:rust
• Aliases: l:rust, l:rs, lint:rs

Lint rust files

lint:toml #

• Usage: lint:toml
• Aliases: l:toml

Lint toml files

lint:yaml #

• Usage: lint:yaml
• Aliases: l:yaml, l:yml, lint:yml

Lint all yaml files

publish #

• Usage: publish

Publish dir_spec to crates.io and Forgejo

test #

Run all tests

• Usage: test [--filter <filter>]
• Aliases: t

Flags #

• --filter <filter>: Filter tests by name

test-doc #

• Usage: test-doc
• Aliases: test:doc

Test the documentation examples