development.org

Format, test, lint

cargo fmt -- --check
cargo test --all-features
cargo clippy --allow-dirty --allow-staged

Documentation

Durable documentation follows the path-first Johnny.Decimal Org topology under docs/index.org and docs/topology.toml.

Use `docs/AC_slug/AC.ID_semantic_name.org` for long-lived records. The category prefix in the directory and the coordinate in the file name must agree. If a new category is needed, update `docs/topology.toml` explicitly instead of silently inventing category meaning.

.devenv/devenv-profile-exec cargo run --quiet \
  --manifest-path languages/orgize/Cargo.toml -- \
  lint languages/orgize/docs languages/orgize/development.org

Update snapshot testing

cargo install cargo-insta
cargo insta test --all-features
cargo insta review

Fuzz testing

cargo install cargo-fuzz
rustup default nightly
cargo fuzz run fuzz_target_1

Benchmark

curl -q https://orgmode.org/worg/doc.org --output ./benches/doc.org
curl -q https://orgmode.org/worg/org-faq.org --output ./benches/org-faq.org
curl -q https://orgmode.org/worg/org-hacks.org --output ./benches/org-hacks.org
curl -q https://orgmode.org/worg/org-release-notes.org --output ./benches/org-release-notes.org
curl -q https://orgmode.org/worg/org-syntax.org --output ./benches/org-syntax.org
curl -q https://raw.githubusercontent.com/bzg/org-mode/main/doc/org-manual.org --output ./benches/org-manual.org

cargo bench --bench parse

Benchmark w/ flamegraph

cargo install flamegraph
cargo flamegraph --bench parse -o baseline.svg -- --bench
# then open baseline.svg with your browser