Skip to content

Commit 9fb02ac

Browse files
committed
docs(cli): show author and GitHub URL in --help output
1 parent 6cffbfe commit 9fb02ac

1 file changed

Lines changed: 15 additions & 8 deletions

File tree

crates/codelens/src/cli.rs

Lines changed: 15 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -15,9 +15,10 @@ const STYLES: Styles = Styles::styled()
1515
#[derive(Parser, Debug)]
1616
#[command(
1717
name = "codelens",
18-
author,
1918
version,
20-
about = "High performance code analysis tool — stats, health scores, hotspots, and trends",
19+
about = "High performance code analysis tool — stats, health scores, hotspots, and trends\n\n\
20+
Author: Tiger <DropFan@Gmail.com>\n\
21+
GitHub: https://github.com/DropFan/codelens",
2122
styles = STYLES,
2223
after_help = EXAMPLES,
2324
)]
@@ -42,20 +43,26 @@ pub struct Cli {
4243
#[derive(Subcommand, Debug)]
4344
pub enum Command {
4445
/// Analyze code health score.
45-
#[command(long_about = "Score code health across five dimensions: complexity, function size, \
46+
#[command(
47+
long_about = "Score code health across five dimensions: complexity, function size, \
4648
comment ratio, file size, and nesting depth. Reports at project, directory, and file \
4749
levels with grades from A (best) to F (worst). Use --top to control how many items \
48-
are shown per level.")]
50+
are shown per level."
51+
)]
4952
Health(HealthArgs),
5053
/// Detect change hotspots (churn x complexity).
51-
#[command(long_about = "Find the riskiest files in your codebase by combining git change \
54+
#[command(
55+
long_about = "Find the riskiest files in your codebase by combining git change \
5256
frequency (churn) with code complexity. Files that change often AND are complex are \
53-
the most likely sources of bugs. Requires a git repository.")]
57+
the most likely sources of bugs. Requires a git repository."
58+
)]
5459
Hotspot(HotspotArgs),
5560
/// Track codebase trends with snapshots.
56-
#[command(long_about = "Save snapshots of codebase metrics and compare them over time. \
61+
#[command(
62+
long_about = "Save snapshots of codebase metrics and compare them over time. \
5763
Snapshots are stored in .codelens/snapshots/ as JSON files. References: \"latest\", \
58-
\"latest~N\" (Nth before latest), or date prefix like \"2025-01-01\".")]
64+
\"latest~N\" (Nth before latest), or date prefix like \"2025-01-01\"."
65+
)]
5966
Trend(TrendArgs),
6067
}
6168

0 commit comments

Comments
 (0)