-
Notifications
You must be signed in to change notification settings - Fork 104
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #444 from str4d/clap-completions-and-manpages
`clap` completions and manpages
- Loading branch information
Showing
19 changed files
with
607 additions
and
674 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,243 @@ | ||
| use std::env; | ||
| use std::fs; | ||
| use std::io; | ||
| use std::path::Path; | ||
| use std::path::PathBuf; | ||
|
|
||
| use clap::{Command, CommandFactory, ValueEnum}; | ||
| use clap_complete::{generate_to, Shell}; | ||
| use clap_mangen::{ | ||
| roff::{Inline, Roff}, | ||
| Man, | ||
| }; | ||
| use flate2::{write::GzEncoder, Compression}; | ||
|
|
||
| mod i18n { | ||
| include!("src/bin/rage/i18n.rs"); | ||
| } | ||
| mod rage { | ||
| include!("src/bin/rage/cli.rs"); | ||
| } | ||
| mod rage_keygen { | ||
| include!("src/bin/rage-keygen/cli.rs"); | ||
| } | ||
| mod rage_mount { | ||
| include!("src/bin/rage-mount/cli.rs"); | ||
| } | ||
|
|
||
| #[macro_export] | ||
| macro_rules! fl { | ||
| ($message_id:literal) => {{ | ||
| i18n_embed_fl::fl!($crate::i18n::LANGUAGE_LOADER, $message_id) | ||
| }}; | ||
|
|
||
| ($message_id:literal, $($args:expr),* $(,)?) => {{ | ||
| i18n_embed_fl::fl!($crate::i18n::LANGUAGE_LOADER, $message_id, $($args), *) | ||
| }}; | ||
| } | ||
|
|
||
| struct Example { | ||
| text: String, | ||
| cmd: &'static str, | ||
| output: Option<String>, | ||
| } | ||
|
|
||
| impl Example { | ||
| const fn new(text: String, cmd: &'static str, output: Option<String>) -> Self { | ||
| Self { text, cmd, output } | ||
| } | ||
| } | ||
|
|
||
| struct Examples<const N: usize>([Example; N]); | ||
|
|
||
| impl<const N: usize> Examples<N> { | ||
| fn render(self, w: &mut impl io::Write) -> io::Result<()> { | ||
| let mut roff = Roff::default(); | ||
| roff.control("SH", ["EXAMPLES"]); | ||
| for example in self.0 { | ||
| roff.control("TP", []); | ||
| roff.text( | ||
| [ | ||
| Inline::Roman(format!("{}:", example.text)), | ||
| Inline::LineBreak, | ||
| Inline::Bold(format!("$ {}", example.cmd)), | ||
| Inline::LineBreak, | ||
| ] | ||
| .into_iter() | ||
| .chain( | ||
| example | ||
| .output | ||
| .into_iter() | ||
| .flat_map(|output| [Inline::Roman(output), Inline::LineBreak]), | ||
| ) | ||
| .collect::<Vec<_>>(), | ||
| ); | ||
| } | ||
| roff.to_writer(w) | ||
| } | ||
| } | ||
|
|
||
| #[derive(Clone)] | ||
| struct Cli { | ||
| rage: Command, | ||
| rage_keygen: Command, | ||
| rage_mount: Command, | ||
| } | ||
|
|
||
| impl Cli { | ||
| fn build() -> Self { | ||
| Self { | ||
| rage: rage::AgeOptions::command(), | ||
| rage_keygen: rage_keygen::AgeOptions::command(), | ||
| rage_mount: rage_mount::AgeMountOptions::command(), | ||
| } | ||
| } | ||
|
|
||
| fn generate_completions(&mut self, out_dir: &Path) -> io::Result<()> { | ||
| fs::create_dir_all(out_dir)?; | ||
|
|
||
| for &shell in Shell::value_variants() { | ||
| generate_to(shell, &mut self.rage, "rage", out_dir)?; | ||
| generate_to(shell, &mut self.rage_keygen, "rage-keygen", out_dir)?; | ||
| generate_to(shell, &mut self.rage_mount, "rage-mount", out_dir)?; | ||
| } | ||
|
|
||
| Ok(()) | ||
| } | ||
|
|
||
| fn generate_manpages(self, out_dir: &Path) -> io::Result<()> { | ||
| fs::create_dir_all(out_dir)?; | ||
|
|
||
| fn generate_manpage( | ||
| out_dir: &Path, | ||
| name: &str, | ||
| cmd: Command, | ||
| custom: impl FnOnce(&Man, &mut GzEncoder<fs::File>) -> io::Result<()>, | ||
| ) -> io::Result<()> { | ||
| let file = fs::File::create(out_dir.join(format!("{}.1.gz", name)))?; | ||
| let mut w = GzEncoder::new(file, Compression::best()); | ||
|
|
||
| let man = Man::new(cmd); | ||
| man.render_title(&mut w)?; | ||
| man.render_name_section(&mut w)?; | ||
| man.render_synopsis_section(&mut w)?; | ||
| man.render_options_section(&mut w)?; | ||
| custom(&man, &mut w)?; | ||
| man.render_version_section(&mut w)?; | ||
| man.render_authors_section(&mut w) | ||
| } | ||
|
|
||
| generate_manpage( | ||
| out_dir, | ||
| "rage", | ||
| self.rage | ||
| .about(fl!("man-rage-about")) | ||
| .after_help(rage::after_help_content("rage-keygen")), | ||
| |man, w| { | ||
| man.render_extra_section(w)?; | ||
| Examples([ | ||
| Example::new( | ||
| fl!("man-rage-example-enc-single"), | ||
| "echo \"_o/\" | rage -o hello.age -r age1uvscypafkkxt6u2gkguxet62cenfmnpc0smzzlyun0lzszfatawq4kvf2u", | ||
| None, | ||
| ), | ||
| Example::new( | ||
| fl!("man-rage-example-enc-multiple"), | ||
| "echo \"_o/\" | rage -r age1uvscypafkkxt6u2gkguxet62cenfmnpc0smzzlyun0lzszfatawq4kvf2u \ | ||
| -r age1ex4ty8ppg02555at009uwu5vlk5686k3f23e7mac9z093uvzfp8sxr5jum > hello.age", | ||
| None, | ||
| ), | ||
| Example::new( | ||
| fl!("man-rage-example-enc-password"), | ||
| "rage -p -o hello.txt.age hello.txt", | ||
| Some(format!("{}:", fl!("type-passphrase"))), | ||
| ), | ||
| Example::new( | ||
| fl!("man-rage-example-enc-list"), | ||
| "tar cv ~/xxx | rage -R recipients.txt > xxx.tar.age", | ||
| None, | ||
| ), | ||
| Example::new( | ||
| fl!("man-rage-example-enc-identities"), | ||
| "tar cv ~/xxx | rage -e -i keyA.txt -i keyB.txt > xxx.tar.age", | ||
| None, | ||
| ), | ||
| Example::new( | ||
| fl!("man-rage-example-enc-url"), | ||
| "echo \"_o/\" | rage -o hello.age -R <(curl https://github.com/str4d.keys)", | ||
| None, | ||
| ), | ||
| Example::new( | ||
| fl!("man-rage-example-dec-identities"), | ||
| "rage -d -o hello -i keyA.txt -i keyB.txt hello.age", | ||
| None, | ||
| ), | ||
| ]) | ||
| .render(w) | ||
| }, | ||
| )?; | ||
| generate_manpage( | ||
| out_dir, | ||
| "rage-keygen", | ||
| self.rage_keygen.about(fl!("man-keygen-about")), | ||
| |_, w| { | ||
| Examples([ | ||
| Example::new(fl!("man-keygen-example-stdout"), "rage-keygen", None), | ||
| Example::new( | ||
| fl!("man-keygen-example-file"), | ||
| "rage-keygen -o key.txt", | ||
| Some(format!( | ||
| "{}: age1ql3z7hjy54pw3hyww5ayyfg7zqgvc7w3j2elw8zmrj2kg5sfn9aqmcac8p", | ||
| fl!("tty-pubkey") | ||
| )), | ||
| ), | ||
| ]) | ||
| .render(w) | ||
| }, | ||
| )?; | ||
| generate_manpage( | ||
| out_dir, | ||
| "rage-mount", | ||
| self.rage_mount.about(fl!("man-mount-about")), | ||
| |_, w| { | ||
| Examples([ | ||
| Example::new( | ||
| fl!("man-mount-example-identity"), | ||
| "rage-mount -t tar -i key.txt encrypted.tar.age ./tmp", | ||
| None, | ||
| ), | ||
| Example::new( | ||
| fl!("man-mount-example-passphrase"), | ||
| "rage-mount -t zip encrypted.zip.age ./tmp", | ||
| Some(format!("{}:", fl!("type-passphrase"))), | ||
| ), | ||
| ]) | ||
| .render(w) | ||
| }, | ||
| )?; | ||
|
|
||
| Ok(()) | ||
| } | ||
| } | ||
|
|
||
| fn main() -> io::Result<()> { | ||
| i18n::load_languages(); | ||
|
|
||
| // `OUT_DIR` is "intentionally opaque as it is only intended for `rustc` interaction" | ||
| // (https://github.com/rust-lang/cargo/issues/9858). Peek into the black box and use | ||
| // it to figure out where the target directory is. | ||
| let out_dir = match env::var_os("OUT_DIR") { | ||
| None => return Ok(()), | ||
| Some(out_dir) => PathBuf::from(out_dir) | ||
| .ancestors() | ||
| .nth(3) | ||
| .expect("should be absolute path") | ||
| .to_path_buf(), | ||
| }; | ||
|
|
||
| let mut cli = Cli::build(); | ||
| cli.generate_completions(&out_dir.join("completions"))?; | ||
| cli.generate_manpages(&out_dir.join("manpages"))?; | ||
|
|
||
| Ok(()) | ||
| } |
Oops, something went wrong.