Extract CLI crate and add shell completion and man page #42
Conversation
|
I think having clap as a build dependency unconditionally is unfortunate. If we want to do this, maybe the CLI should be extracted into its own crate like in Typst. cc: @reknih |
|
Yeah, I actually also extracted it when I did the rewrite initially, but I didn't know whether that was what you wanted so I ended up reverting to using a |
|
Originally, I liked this setup, but I've come to prefer the more flexible two-crate setup since. |
|
Yeah, extracting the CLI into its own crate should be nicer, you're right. I will update the PR in the following days with this setup. Thank you for the feedback! |
mrgalopes
force-pushed
the
feature/shell-completion
branch
from
3b92f83 to
9e3056e
Compare
|
I separated the crates inspired by the structure of typst, and also rebased on main. Let me know what you think. |
There was a problem hiding this comment.
Looks good to me in general, just a few nitpicks.
Also, I don't know anything about build scripts, so I will leave that @laurmaedje.
But could you maybe explain what this now makes possible which wasn't possible before? I tried to install using cargo install --path crates/svg2pdf-cli and then type svg2pdf --d and autocomplete to get --dpi, but it doesn't seem to work. Am I missing something?
Cargo.toml
Outdated
| @@ -1,47 +1,15 @@ | |||
| [workspace] | |||
| members = ["tests"] | |||
| members = ["crates/*", "tests"] | |||
| default-members = ["crates/svg2pdf"] | |||
There was a problem hiding this comment.
I would change this to default-members = ["crates/typst-cli"], since the cli is what you want to execute by default when running cargo run in the root directory.
crates/svg2pdf-cli/Cargo.toml
Outdated
| image = { version = "0.24", default-features = false, features = [ | ||
| "jpeg", | ||
| "png", | ||
| "gif", |
There was a problem hiding this comment.
I guess that's personal preference, but maybe better to keep everything in a single line? Not sure about this one, though.
There was a problem hiding this comment.
I had a TOML formatter turned on for VSCode which did this, but I can revert it if you prefer, no problem.
|
Apologies for the delay. I've been looking for alternatives to add the completions but couldn't find any that were ideal. The way that this was done mirrors the typst-cli, where the nix flake installs the completion after the build. Without nix, this would have to be done manually. From what I could find, crates.io doesn't let you install arbitrary files, like completion files. This is how I've done for zsh:
fpath+=~/.zfunc
autoload -Uz compinit
compinit
cp target/release/artifacts/_svg2pdf ~/.zfunc |
crates/svg2pdf-cli/Cargo.toml
Outdated
| image = { version = "0.24", default-features = false, features = [ | ||
| "jpeg", | ||
| "png", | ||
| "gif", |
crates/svg2pdf-cli/Cargo.toml
Outdated
| [build-dependencies] | ||
| clap = { version = "4.4.2", features = ["derive", "string"] } | ||
| clap_complete = "4.4.3" | ||
| clap_mangen = "0.2.14" |
There was a problem hiding this comment.
Please add newlines at the end of files where they are missing.
crates/svg2pdf-cli/build.rs
Outdated
| use clap_complete::{generate_to, Shell}; | ||
|
|
||
| mod args { | ||
| include!("src/cli.rs"); |
There was a problem hiding this comment.
I think the name args.rs (like in Typst) is clearer.
laurmaedje
changed the title
|
Thank you! |
Closes #27.
Adapted from the main typst repo. It only outputs the completions and the man page when the cli feature is enabled. A downside is that it always fetches and compiles the dependencies. Any suggestions are appreciated. 😄