Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(mangen): generate filename and files #5331

Merged
merged 2 commits into from
Feb 2, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
45 changes: 45 additions & 0 deletions clap_mangen/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -95,6 +95,51 @@ impl Man {
}
}

/// Handle [`Man`] in relation to files
impl Man {
/// Generate the filename of the manual page
#[must_use]
pub fn get_filename(&self) -> String {
format!(
"{}.{}",
self.cmd
.get_display_name()
.unwrap_or_else(|| self.cmd.get_name()),
self.section
)
}

/// [Renders](Man::render) the manual page and writes it to a file
pub fn generate_to(
&self,
out_dir: impl AsRef<std::path::Path>,
) -> Result<std::path::PathBuf, std::io::Error> {
let filepath = out_dir.as_ref().join(self.get_filename());
let mut file = std::fs::File::create(&filepath)?;
self.render(&mut file)?;
file.flush()?;
Ok(filepath)
}
}

/// Generate manual page files for the command with all subcommands
pub fn generate_to(
cmd: clap::Command,
out_dir: impl AsRef<std::path::Path>,
) -> Result<(), std::io::Error> {
fn generate(cmd: clap::Command, out_dir: &std::path::Path) -> Result<(), std::io::Error> {
for cmd in cmd.get_subcommands().cloned() {
epage marked this conversation as resolved.
Show resolved Hide resolved
epage marked this conversation as resolved.
Show resolved Hide resolved
generate(cmd, out_dir)?;
}
Man::new(cmd).generate_to(out_dir)?;
Ok(())
}

let mut cmd = cmd.disable_help_subcommand(true);
cmd.build();
generate(cmd, out_dir.as_ref())
}

/// Generate ROFF output
impl Man {
/// Render a full manual page into the writer.
Expand Down
Loading