feat: support self-updating, autocomplete and loosen schema required fields

Author: van-sprundel

Cargo.lock

@@ -1,7 +1,7 @@
 [package]
 name = "ferrisume-cli"
 description = "A JSON resume CLI tool"
-version = "0.5.3"
+version = "0.5.4"
 license = "MIT"
 repository = "https://github.com/van-sprundel/ferrisume"
 edition = "2021"
@@ -27,6 +27,9 @@ tempfile = "3.12.0"
 directories = "6.0.0"
 lazy_static = "1.4.0"
 comfy-table = "7.1.4"
+self_update = { version = "1.0.0-rc.6", features = ["archive-zip", "compression-zip-deflate", "checksums"] }
+clap_complete = "4"
+jsonschema = { version = "0.47.0", default-features = false }
 
 [[bin]]
 name = "ferrisume"
@@ -36,3 +39,7 @@ path = "src/main.rs"
 [profile.dist]
 inherits = "release"
 lto = "thin"
+
+[dev-dependencies]
+flate2 = "1.1.9"
+tar = "0.4.46"

Cargo.toml

@@ -24,19 +24,54 @@ cargo binstall ferrisume-cli
 Usage: ferrisume [COMMAND]
 
 Commands:
-  init     Initialize a resume.json file
-  themes   List all available themes
-  version  Display version information
-  theme    Theme management commands
-  watch    Edit your resume in a live view
-  export   Export locally to .html or .pdf
-  help     Print this message or the help of the given subcommand(s)
+  init         Initialize a resume.json file
+  themes       List all available themes
+  version      Display version information
+  update       Update ferrisume to the latest release
+  validate     Validate a resume file against the JSON Resume schema
+  completions  Generate shell completions
+  theme        Theme management commands
+  watch        Edit your resume in a live view
+  export       Export locally to .html or .pdf
+  help         Print this message or the help of the given subcommand(s)
 
 Options:
   -h, --help     Print help
   -V, --version  Print version
 ```
 
+## Self-updating
+
+Ferrisume can update itself to the latest GitHub release:
+
+```sh
+ferrisume update          # download and install the latest version
+ferrisume update --check  # only check whether a newer version exists
+```
+
+Other commands print a hint when a newer version is available. The check runs
+at most once a day and caches its result; set `FERRISUME_NO_UPDATE_CHECK=1` to
+disable it entirely.
+
+## Validation
+
+```sh
+ferrisume validate            # validates resume.json
+ferrisume validate -i cv.json
+```
+
+Checks the file against the official [JSON Resume schema](https://jsonresume.org/schema/)
+and reports every violation with its location. All fields are optional — a
+resume without a phone number (or without most things) is valid and renders fine.
+
+## Shell completions
+
+```sh
+ferrisume completions fish > ~/.config/fish/completions/ferrisume.fish
+ferrisume completions bash > ~/.local/share/bash-completion/completions/ferrisume
+ferrisume completions zsh  > ~/.zfunc/_ferrisume
+```
+
 ## Theme Discovery
 
 Ferrisume discovers themes from (in order):

README.md

@@ -15,6 +15,8 @@ targets = ["aarch64-apple-darwin", "aarch64-unknown-linux-gnu", "x86_64-apple-da
 pr-run-mode = "upload"
 # Path that installers should place binaries in
 install-path = "CARGO_HOME"
+# Use .tar.gz on unix so `ferrisume update` (self_update crate) can extract release archives
+unix-archive = ".tar.gz"
 # Whether to install an updater program
 install-updater = false
 # Publish to crates.io after release

dist-workspace.toml

@@ -1,13 +1,51 @@
-use clap::{Arg, ArgMatches, Command};
+use clap::{Arg, ArgAction, ArgMatches, Command};
 
 pub fn args() -> ArgMatches {
+    command().get_matches()
+}
+
+pub fn command() -> Command {
     Command::new("ferrisume")
         .version(env!("CARGO_PKG_VERSION"))
         .author("Ramon van Sprundel <ramonvansprundel@gmail.com>")
         .about("A resume generator CLI tool")
         .subcommand(Command::new("init").about("Initialize a resume.json file"))
         .subcommand(Command::new("themes").about("List all available themes"))
         .subcommand(Command::new("version").about("Display version information"))
+        .subcommand(
+            Command::new("update")
+                .about("Update ferrisume to the latest release")
+                .arg(
+                    Arg::new("check")
+                        .long("check")
+                        .help("Only check whether a newer version is available")
+                        .action(ArgAction::SetTrue),
+                ),
+        )
+        .subcommand(
+            Command::new("validate")
+                .about("Validate a resume file against the JSON Resume schema")
+                .arg(
+                    Arg::new("input")
+                        .short('i')
+                        .long("input")
+                        .value_name("INPUT")
+                        .help("Specify input file")
+                        .num_args(1)
+                        .required(false)
+                        .default_value("resume.json"),
+                ),
+        )
+        .subcommand(
+            Command::new("completions")
+                .about("Generate shell completions")
+                .arg(
+                    Arg::new("shell")
+                        .help("Shell to generate completions for")
+                        .required(true)
+                        .value_parser(clap::value_parser!(clap_complete::Shell)),
+                ),
+        )
         .subcommand(
             Command::new("theme")
                 .about("Theme management commands")
@@ -99,5 +137,4 @@ pub fn args() -> ArgMatches {
                         .default_value("resume.pdf"),
                 ),
         )
-        .get_matches()
 }