Skip to content

Commit

Permalink
feat(markdown docs): add aliases to options
Browse files Browse the repository at this point in the history
Move `cargo md-gen` to an ignored test. This allows moving clap-markdown to dev-dependency allowing the use of a fork and removing an unneeded dependency since the markdown generation is pre-release.
  • Loading branch information
willemneal authored and gitbutler-client committed Dec 2, 2024
1 parent 790dd3c commit 57c5af4
Show file tree
Hide file tree
Showing 6 changed files with 57 additions and 29 deletions.
4 changes: 2 additions & 2 deletions .cargo-husky/hooks/pre-commit
Original file line number Diff line number Diff line change
Expand Up @@ -5,5 +5,5 @@ set -e
echo '+cargo fmt --check'
cargo fmt --check || (cargo fmt && exit 1)

echo '+cargo run --bin doc-gen --features clap-markdown'
cargo run --bin doc-gen --features clap-markdown
echo '+cargo md-gen'
cargo md-gen
4 changes: 2 additions & 2 deletions .cargo-husky/hooks/pre-push
Original file line number Diff line number Diff line change
Expand Up @@ -16,5 +16,5 @@ echo '+cargo test --all'
cargo build
cargo test --all || (echo "might need to rebuild make build-snapshot" && exit 1)

echo '+cargo run --bin doc-gen --features clap-markdown'
cargo run --bin doc-gen --features clap-markdown
echo '+cargo md-gen'
cargo md-gen
2 changes: 1 addition & 1 deletion .cargo/config.toml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

[alias] # command aliases
f = "fmt"
md-gen = "run --bin doc-gen --features clap-markdown"
md-gen = "test --package soroban-cli --lib -- test::md_gen --exact --ignored"
s = "run --quiet --"
# b = "build"
# c = "check"
Expand Down
Loading

0 comments on commit 57c5af4

Please sign in to comment.