Extract CLI crate and add shell completion and man page (#42)

Author: mrgalopes

.github/workflows/ci.yml

@@ -49,6 +49,6 @@ jobs:
       - uses: actions/checkout@v3
       - uses: dtolnay/rust-toolchain@stable
       - uses: Swatinem/rust-cache@v2
-      - run: cargo clippy --all-targets --features cli
+      - run: cargo clippy --all-targets
       - run: cargo fmt --check --all
       - run: cargo doc --workspace --no-deps

Cargo.lock

@@ -1,5 +1,7 @@
 [workspace]
-members = ["tests"]
+members = ["crates/*", "tests"]
+default-members = ["crates/svg2pdf-cli"]
+resolver = "2"
 
 [workspace.package]
 version = "0.9.0"
@@ -9,39 +11,3 @@ repository = "https://github.com/typst/svg2pdf"
 readme = "README.md"
 license = "MIT OR Apache-2.0"
 
-[package]
-name = "svg2pdf"
-description = "Convert SVG files to PDFs."
-categories = ["encoding", "graphics", "multimedia"]
-keywords = ["svg", "pdf", "vector-graphics", "conversion"]
-version.workspace = true
-authors.workspace = true
-edition.workspace = true
-repository.workspace = true
-license.workspace = true
-
-[features]
-default = ["image"]
-image = ["dep:image"]
-cli = ["dep:clap", "dep:termcolor", "usvg/text", "dep:fontdb"]
-
-[lib]
-test = false
-doctest = false
-
-[[bin]]
-name = "svg2pdf"
-path = "src/main.rs"
-required-features = ["cli"]
-
-[dependencies]
-miniz_oxide = "0.7"
-pdf-writer = "0.9"
-usvg = { version = "0.36", default-features = false }
-image = { version = "0.24", default-features = false, features = ["jpeg", "png", "gif"], optional = true }
-termcolor = { version = "1", optional = true }
-clap = { version = "4.4.2", features = ["derive"], optional = true }
-fontdb = { version = "0.15", optional= true }
-
-[dev-dependencies]
-usvg = { version = "0.36.0" }

Cargo.toml

@@ -34,7 +34,7 @@ std::fs::write("target/time_series.pdf", pdf)?;
 This crate also contains a command line interface. Install it by running the command below:
 
 ```bash
-cargo install svg2pdf --features cli
+cargo install svg2pdf-cli
 ```
 
 You can then convert SVGs to PDFs by running commands like these:

README.md

@@ -0,0 +1,35 @@
+[package]
+name = "svg2pdf-cli"
+description = "The command line interface for svg2pdf."
+categories = ["encoding", "graphics", "multimedia", "command-line-utilities"]
+keywords = ["svg2pdf", "cli"]
+version.workspace = true
+authors.workspace = true
+edition.workspace = true
+repository.workspace = true
+license.workspace = true
+build = "build.rs"
+
+[[bin]]
+name = "svg2pdf"
+path = "src/main.rs"
+test = false
+doctest = false
+bench = false
+doc = false
+
+[dependencies]
+svg2pdf = { path = "../svg2pdf" }
+miniz_oxide = "0.7"
+pdf-writer = "0.9"
+usvg = { version = "0.36", default-features = false, features = ["text"] }
+image = { version = "0.24", default-features = false, features = ["jpeg", "png", "gif"] }
+termcolor = { version = "1" }
+clap = { version = "4.4.2", features = ["derive"] }
+fontdb = { version = "0.15" }
+
+[build-dependencies]
+clap = { version = "4.4.2", features = ["derive", "string"] }
+clap_complete = "4.4.3"
+clap_mangen = "0.2.14"
+

crates/svg2pdf-cli/Cargo.toml

@@ -0,0 +1,32 @@
+use std::{env, path::Path};
+
+use clap::{CommandFactory, ValueEnum};
+use clap_complete::{generate_to, Shell};
+
+mod args {
+    include!("src/args.rs");
+}
+
+fn main() -> Result<(), std::io::Error> {
+    let outdir_str = match env::var_os("OUT_DIR") {
+        None => return Ok(()),
+        Some(outdir) => outdir,
+    };
+
+    // Put the files in the artifacts folder (/target/artifacts)
+    let outdir_path = &Path::new(&outdir_str).ancestors().nth(3).unwrap();
+    let artifacts_path = outdir_path.join("artifacts");
+    std::fs::create_dir_all(&artifacts_path)?;
+
+    let mut cmd = args::Args::command();
+
+    let man = clap_mangen::Man::new(cmd.clone());
+    let mut manpage_file = std::fs::File::create(artifacts_path.join("svg2pdf.1"))?;
+    man.render(&mut manpage_file)?;
+
+    for shell in Shell::value_variants() {
+        generate_to(*shell, &mut cmd, "svg2pdf", &artifacts_path).unwrap();
+    }
+
+    Ok(())
+}

crates/svg2pdf-cli/build.rs

@@ -0,0 +1,15 @@
+use std::path::PathBuf;
+
+use clap::Parser;
+
+#[derive(Debug, Parser)]
+#[clap(about, version)]
+pub struct Args {
+    /// Path to read SVG file from.
+    pub input: PathBuf,
+    /// Path to write PDF file to.
+    pub output: Option<PathBuf>,
+    /// The number of SVG pixels per PDF points.
+    #[clap(long, default_value = "72.0")]
+    pub dpi: f32,
+}

crates/svg2pdf-cli/src/args.rs

@@ -1,5 +1,5 @@
 use std::io::{self, Write};
-use std::path::{Path, PathBuf};
+use std::path::Path;
 use std::process;
 
 use clap::Parser;
@@ -8,17 +8,7 @@ use usvg::{TreeParsing, TreeTextToPath};
 
 use svg2pdf::Options;
 
-#[derive(Debug, Parser)]
-#[clap(about, version)]
-struct Args {
-    /// Path to read SVG file from.
-    input: PathBuf,
-    /// Path to write PDF file to.
-    output: Option<PathBuf>,
-    /// The number of SVG pixels per PDF points.
-    #[clap(long, default_value = "72.0")]
-    dpi: f32,
-}
+mod args;
 
 fn main() {
     if let Err(msg) = run() {
@@ -28,7 +18,7 @@ fn main() {
 }
 
 fn run() -> Result<(), String> {
-    let args = Args::parse();
+    let args = args::Args::parse();
 
     let name =
         Path::new(args.input.file_name().ok_or("Input path does not point to a file")?);

src/main.rs crates/svg2pdf-cli/src/main.rssrc/main.rs renamed to crates/svg2pdf-cli/src/main.rs

@@ -0,0 +1,28 @@
+[package]
+name = "svg2pdf"
+description = "Convert SVG files to PDFs."
+categories = ["encoding", "graphics", "multimedia"]
+keywords = ["svg", "pdf", "vector-graphics", "conversion"]
+version.workspace = true
+authors.workspace = true
+edition.workspace = true
+repository.workspace = true
+license.workspace = true
+
+[lib]
+doctest = false
+bench = false
+
+[features]
+default = ["image"]
+image = ["dep:image"]
+
+[dependencies]
+miniz_oxide = "0.7"
+pdf-writer = "0.9"
+usvg = { version = "0.36", default-features = false }
+image = { version = "0.24", default-features = false, features = ["jpeg", "png", "gif"], optional = true }
+
+[dev-dependencies]
+usvg = { version = "0.36.0" }
+