feat(cli): merge help output across builtin and project commands

[ElijahAhianyo]

Description

This PR merges the help text from the project's binary commands into cot-cli's help text. This is more of a best effort. When we can't locate the binary or extract metadata information, we fall back to the generic help text generated by Clap, which will not contain commands present in the project binary.

When there's a command present in both cot-cli and the project binary, we merge them

Type of change

• Bug fix
• New feature
• Documentation
• Refactor / cleanup
• Performance improvement
• Other (describe above)

[github-actions]

Bencher Report

Project	cot
Branch	elijah/cot-cli-proxy/stack-4-help
Testbed	github-ubuntu-latest

Click to view all benchmark results

Benchmark	Latency	Benchmark Result microseconds (µs) (Result Δ%)	Upper Boundary microseconds (µs) (Limit %)
empty_router/empty_router	📈 view plot 🚷 view threshold	13,540.00 µs (+27.55%) Baseline: 10,615.76 µs	18,963.91 µs (71.40%)
json_api/json_api	📈 view plot 🚷 view threshold	996.92 µs (-2.33%) Baseline: 1,020.66 µs	1,345.80 µs (74.08%)
nested_routers/nested_routers	📈 view plot 🚷 view threshold	969.75 µs (+1.01%) Baseline: 960.08 µs	1,248.08 µs (77.70%)
single_root_route/single_root_route	📈 view plot 🚷 view threshold	925.93 µs (+0.23%) Baseline: 923.85 µs	1,210.59 µs (76.49%)
single_root_route_burst/single_root_route_burst	📈 view plot 🚷 view threshold	18,177.00 µs (+7.82%) Baseline: 16,857.97 µs	22,038.64 µs (82.48%)

🐰 View full continuous benchmarking report in Bencher

[codecov]

Codecov Report

❌ Patch coverage is 98.24561% with 6 lines in your changes missing coverage. Please review.

Files with missing lines	Patch %	Lines
cot-cli/src/main.rs	94.66%	2 Missing and 2 partials ⚠️
cot-cli/src/handlers.rs	99.25%	0 Missing and 2 partials ⚠️

Flag	Coverage Δ
rust	90.00% <98.24%> (?)

Flags with carried forward coverage won't be shown. Click here to find out more.

Files with missing lines	Coverage Δ
cot-cli/src/args.rs	100.00% <ø> (ø)
cot-cli/src/handlers.rs	98.79% <99.25%> (ø)
cot-cli/src/main.rs	88.95% <94.66%> (ø)

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

[m4tx]

I played around with this and it seems to be working just fine. I even had to check the output of an old version of cot-cli because it was so seamless! Good job!

The only confusing part that's remaining is that running a server command seems to be printing out invalid binary name:

❯ ../cot/target/debug/cot collect-static
error: the following required arguments were not provided:
  <dir>

Usage: m4txblog collect-static <dir>

For more information, try '--help'.

Whereas when using --help, cot is displayed instead of m4txblog in this example:

❯ ../cot/target/debug/cot collect-static --help
Collects all static files into a static directory

Usage: cot collect-static <dir>

Arguments:
  <dir>  The directory to collect the static files into

Options:
  -h, --help  Print help

I don't consider it a merge blocker (especially since the fix won't necessarily be trivial), but we should definitely create an issue for this.

[ElijahAhianyo]

I played around with this and it seems to be working just fine. I even had to check the output of an old version of cot-cli because it was so seamless! Good job!

The only confusing part that's remaining is that running a server command seems to be printing out invalid binary name:

❯ ../cot/target/debug/cot collect-static
error: the following required arguments were not provided:
  <dir>

Usage: m4txblog collect-static <dir>

For more information, try '--help'.

Whereas when using --help, cot is displayed instead of m4txblog in this example:

❯ ../cot/target/debug/cot collect-static --help
Collects all static files into a static directory

Usage: cot collect-static <dir>

Arguments:
  <dir>  The directory to collect the static files into

Options:
  -h, --help  Print help

I don't consider it a merge blocker (especially since the fix won't necessarily be trivial), but we should definitely create an issue for this.

Ah right. Yeah, just created an issue here: #679