Skip to content

Commit 9204314

Browse files
committed
feat: add foundry-cli-markdown crate
Add a new crate for generating Markdown documentation from clap CLIs. This is a fork of clap-markdown with the following enhancements: - Support for grouped options by help heading (PR #48) - Show environment variable names for arguments (PR #50) - Add version information to generated Markdown (PR #52)
1 parent 2c34163 commit 9204314

5 files changed

Lines changed: 630 additions & 3 deletions

File tree

Cargo.lock

Lines changed: 24 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

Cargo.toml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,7 @@ members = [
2626
"crates/primitives/",
2727
"crates/script-sequence/",
2828
"crates/test-utils/",
29+
"crates/cli-markdown/",
2930
]
3031
resolver = "2"
3132

benches/src/lib.rs

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -286,7 +286,7 @@ impl BenchmarkProject {
286286
self.hyperfine(
287287
"forge_test",
288288
version,
289-
"forge test --gas-limit 100000000",
289+
"forge test",
290290
runs,
291291
Some("forge build"),
292292
None,
@@ -345,7 +345,7 @@ impl BenchmarkProject {
345345
self.hyperfine(
346346
"forge_fuzz_test",
347347
version,
348-
r#"forge test --gas-limit 100000000 --match-test "test[^(]*\([^)]+\)""#,
348+
r#"forge test --match-test "test[^(]*\([^)]+\)""#,
349349
runs,
350350
Some("forge build"),
351351
None,
@@ -386,7 +386,7 @@ impl BenchmarkProject {
386386
self.hyperfine(
387387
"forge_isolate_test",
388388
version,
389-
"forge test --gas-limit 100000000 --isolate",
389+
"forge test --isolate",
390390
runs,
391391
Some("forge build"),
392392
None,

crates/cli-markdown/Cargo.toml

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
[package]
2+
name = "foundry-cli-markdown"
3+
description = "Generate Markdown documentation for clap CLIs"
4+
version.workspace = true
5+
edition.workspace = true
6+
rust-version.workspace = true
7+
authors.workspace = true
8+
license.workspace = true
9+
homepage.workspace = true
10+
repository.workspace = true
11+
12+
[lints]
13+
workspace = true
14+
15+
[dependencies]
16+
clap = { version = "4", features = ["env"] }
17+
18+
[dev-dependencies]
19+
clap = { version = "4", features = ["derive"] }
20+
pretty_assertions = "1"

0 commit comments

Comments
 (0)