pioduino/uv
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 1 Wiki Activity

Add anchor links to arguments and options in the CLI reference (#11754)

Browse Source 
<img width="1427" alt="Screenshot 2025-02-24 at 1 26 01 PM"
src="https://github.com/user-attachments/assets/9df589b6-79e4-478a-a404-043448a3bb3b"
/>
This commit is contained in:
Zanie Blue
2025-02-24 15:48:14 -06:00
committed by GitHub
parent 2ea1df1a1f
commit 1dd0f6aaf3
2 changed files with 1394 additions and 1390 deletions
Download Patch File Download Diff File Expand all files Collapse all files
crates/uv-dev/src/generate_cli_reference.rs
+9 -5
View File
@@ -185,6 +185,8 @@ fn generate_command<'a>(output: &mut String, command: &'a Command, parents: &mut
// Do not display options for commands with children
if !has_subcommands {
let name_key = name.replace(' ', "-");
// Display positional arguments
let mut arguments = command
.get_positionals()
@@ -196,10 +198,11 @@ fn generate_command<'a>(output: &mut String, command: &'a Command, parents: &mut
output.push_str("<dl class=\"cli-reference\">");
for arg in arguments {
output.push_str("<dt>");
let id = format!("{name_key}--{}", arg.get_id());
output.push_str(&format!("<dt id=\"{id}\">"));
output.push_str(&format!(
"<code>{}</code>",
arg.get_id().to_string().to_uppercase()
"<a href=\"#{id}\"<code>{}</code></a>",
arg.get_id().to_string().to_uppercase(),
));
output.push_str("</dt>");
if let Some(help) = arg.get_long_help().or_else(|| arg.get_help()) {
@@ -225,9 +228,10 @@ fn generate_command<'a>(output: &mut String, command: &'a Command, parents: &mut
output.push_str("<dl class=\"cli-reference\">");
for opt in options {
let Some(long) = opt.get_long() else { continue };
let id = format!("{name_key}--{long}");
output.push_str("<dt>");
output.push_str(&format!("<code>--{long}</code>"));
output.push_str(&format!("<dt id=\"{id}\">"));
output.push_str(&format!("<a href=\"#{id}\"><code>--{long}</code></a>",));
if let Some(short) = opt.get_short() {
output.push_str(&format!(", <code>-{short}</code>"));
}