ruff/ruff_dev/src/generate_cli_help.rs

//! Generate CLI help.

use anyhow::Result;
use clap::{Args, CommandFactory};
use ruff::cli::Cli as MainCli;

use crate::utils::replace_readme_section;

const HELP_BEGIN_PRAGMA: &str = "<!-- Begin auto-generated cli help. -->";
const HELP_END_PRAGMA: &str = "<!-- End auto-generated cli help. -->";

#[derive(Args)]
pub struct Cli {
    /// Write the generated help to stdout (rather than to `README.md`).
    #[arg(long)]
    pub(crate) dry_run: bool,
}

fn trim_lines(s: &str) -> String {
    s.lines().map(str::trim_end).collect::<Vec<_>>().join("\n")
}

pub fn main(cli: &Cli) -> Result<()> {
    let mut cmd = MainCli::command();
    let output = trim_lines(cmd.render_help().to_string().trim());

    if cli.dry_run {
        print!("{output}");
    } else {
        replace_readme_section(
            &format!("```\n{output}\n```\n"),
            HELP_BEGIN_PRAGMA,
            HELP_END_PRAGMA,
        )?;
    }

    Ok(())
}