bin: better error handling

Bumps [JamesIves/github-pages-deploy-action](https://github.com/JamesIves/github-pages-deploy-action) from 4.4.0 to 4.4.1.
- [Release notes](https://github.com/JamesIves/github-pages-deploy-action/releases)
- [Commits](https://github.com/JamesIves/github-pages-deploy-action/compare/v4.4.0...v4.4.1)

---
updated-dependencies:
- dependency-name: JamesIves/github-pages-deploy-action
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>

.github/dependabot.yml

@@ -0,0 +1,10 @@
+version: 2
+updates:
+- package-ecosystem: cargo
+  directory: "/"
+  schedule:
+    interval: monthly
+- package-ecosystem: github-actions
+  directory: "/"
+  schedule:
+    interval: monthly

.github/workflows/check.yml

@@ -9,9 +9,9 @@ jobs:
     runs-on: ubuntu-20.04
     steps:
       - name: Checkout sources
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
       - name: Cache build files
-        uses: actions/cache@v2
+        uses: actions/cache@v3
         with:
           path: |
             ~/.cargo/registry
@@ -35,9 +35,9 @@ jobs:
     runs-on: ubuntu-20.04
     steps:
       - name: Checkout sources
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
       - name: Cache build files
-        uses: actions/cache@v2
+        uses: actions/cache@v3
         with:
           path: |
             ~/.cargo/registry
@@ -70,7 +70,7 @@ jobs:
         rust:
           - stable
           - beta
-          - 1.58.0
+          - 1.60.0
         experimental:
           - false
         # Run a canary test on nightly that's allowed to fail
@@ -87,9 +87,9 @@ jobs:
     continue-on-error: ${{ matrix.experimental }}
     steps:
       - name: Checkout sources
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
       - name: Cache build files
-        uses: actions/cache@v2
+        uses: actions/cache@v3
         with:
           path: |
             ~/.cargo/registry

.github/workflows/deploy.yml

@@ -37,11 +37,11 @@ jobs:
     runs-on: ${{ matrix.os }}
     steps:
       - name: Setup | Checkout
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
 
       # Cache files between builds
       - name: Setup | Cache Cargo
-        uses: actions/cache@v2
+        uses: actions/cache@v3
         with:
           path: |
             ~/.cargo/registry
@@ -90,7 +90,7 @@ jobs:
           tar czvf ../../stage/${{ env.CRATE_NAME }}-${{ steps.extract_tag.outputs.tag }}-${{ matrix.name }} ${{ env.CRATE_NAME }}
           cd -
       - name: Post Setup | Upload artifacts
-        uses: actions/upload-artifact@v2
+        uses: actions/upload-artifact@v3
         with:
           name: ${{ env.CRATE_NAME }}-${{ steps.extract_tag.outputs.tag }}-${{ matrix.name }}
           path: target/stage/*
@@ -102,12 +102,12 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Setup | Checkout
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
         with:
           fetch-depth: 0
 
       - name: Setup | Artifacts
-        uses: actions/download-artifact@v2
+        uses: actions/download-artifact@v3
 
       - name: Setup | Release notes
         run: |

.github/workflows/docs.yml

@@ -12,8 +12,8 @@ jobs:
   publish:
     runs-on: ubuntu-20.04
     steps:
-      - uses: actions/checkout@v2
-      - uses: actions/cache@v2
+      - uses: actions/checkout@v3
+      - uses: actions/cache@v3
         with:
           path: |
             ~/.cargo/registry
@@ -33,7 +33,7 @@ jobs:
       - name: Build book
         run: ./scripts/build-book
       - name: Push docs
-        uses: JamesIves/github-pages-deploy-action@v4.3.3
+        uses: JamesIves/github-pages-deploy-action@v4.4.1
         with:
           branch: gh-pages
           folder: book/book

.github/workflows/publish.yml

@@ -9,8 +9,8 @@ jobs:
   publish:
     runs-on: ubuntu-20.04
     steps:
-      - uses: actions/checkout@v2
-      - uses: actions/cache@v2
+      - uses: actions/checkout@v3
+      - uses: actions/cache@v3
         with:
           path: |
             ~/.cargo/registry

CHANGELOG.md

@@ -1,5 +1,13 @@
 ## Changelog
 
+## Unreleased
+
+## 1.8.0
+
+### Changed
+
+- MSRV (minimum supported rust version) is now 1.60.0 for clap v4
+
 ## 1.7.0
 
 ### Changed

Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "mdbook-admonish"
-version = "1.7.0"
+version = "1.8.0"
 edition = "2021"
 
 authors = ["Tom Milligan <code@tommilligan.net>"]
@@ -22,22 +22,22 @@ name = "mdbook_admonish"
 path = "src/lib.rs"
 
 [dependencies]
-anyhow = "1.0.57"
-clap = { version = "3.0.14", default_features = false, features = ["std", "cargo"], optional = true }
-env_logger = { version = "0.9.0", default_features = false, optional = true }
-log = { version = "0.4.14", optional = true }
-mdbook = "0.4.15"
-once_cell = "1.10.0"
-pulldown-cmark = "0.9.1"
-regex = "1.5.5"
-semver = "1.0.7"
-serde = { version = "1.0.136", features = ["derive"] }
-serde_json = "1.0.79"
+anyhow = "1.0.65"
+clap = { version = "4", default_features = false, features = ["std", "derive"], optional = true }
+env_logger = { version = "0.9.1", default_features = false, optional = true }
+log = { version = "0.4.17", optional = true }
+mdbook = "0.4.21"
+once_cell = "1.15.0"
+pulldown-cmark = "0.9.2"
+regex = "1.6.0"
+semver = "1.0.14"
+serde = { version = "1.0.145", features = ["derive"] }
+serde_json = "1.0.85"
 toml = "0.5.9"
-toml_edit = { version = "0.13.4", optional = true }
+toml_edit = { version = "0.15.0", optional = true }
 
 [dev-dependencies]
-pretty_assertions = "1.1.0"
+pretty_assertions = "1.3.0"
 
 [features]
 default = ["cli", "cli-install"]

scripts/check

@@ -15,10 +15,12 @@ cargo fmt -- --check
 # - RUSTSEC-2020-0071 known unlikely segfault in `time`
 # - RUSTSEC-2020-0016 `net2` is unmaintained
 # - RUSTSEC-2020-0159 known unlikely segfault in `chrono`
+# - RUSTSEC-2021-0145 known unmaintained atty transitive dep
 eprintln "Auditing dependencies"
 cargo audit --deny warnings \
   --ignore RUSTSEC-2020-0071 \
   --ignore RUSTSEC-2020-0016 \
+  --ignore RUSTSEC-2021-0145 \
   --ignore RUSTSEC-2020-0159
 
 eprintln "Linting sources"

src/bin/mdbook-admonish.rs

@@ -1,58 +1,70 @@
-use clap::{crate_version, Arg, ArgMatches, Command};
+use anyhow::Result;
+use clap::{Parser, Subcommand};
 use mdbook::{
     errors::Error,
     preprocess::{CmdPreprocessor, Preprocessor},
 };
 use mdbook_admonish::Admonish;
+#[cfg(feature = "cli-install")]
+use std::path::PathBuf;
 use std::{io, process};
 
-pub fn make_app() -> Command<'static> {
-    let mut command = Command::new("mdbook-admonish")
-        .version(crate_version!())
-        .about("mdbook preprocessor to add support for admonitions");
-    command = command.subcommand(
-        Command::new("supports")
-            .arg(Arg::new("renderer").required(true))
-            .about("Check whether a renderer is supported by this preprocessor"),
-    );
+/// mdbook preprocessor to add support for admonitions
+#[derive(Parser)]
+#[command(author, version, about, long_about = None)]
+struct Cli {
+    #[command(subcommand)]
+    command: Option<Commands>,
+}
+
+#[derive(Subcommand)]
+enum Commands {
+    /// Check whether a renderer is supported by this preprocessor
+    Supports { renderer: String },
 
     #[cfg(feature = "cli-install")]
-    {
-        command = command.subcommand(
-        Command::new("install")
-            .arg(Arg::new("css-dir").long("css-dir").default_value(".").help(
-                "Relative directory for the css assets,\nfrom the book directory root",
-            ))
-            .arg(Arg::new("dir").default_value(".").help(
-                "Root directory for the book,\nshould contain the configuration file (`book.toml`)",
-            ))
-            .about("Install the required assset files and include it in the config"));
-    }
-    command
+    /// Install the required assset files and include it in the config
+    Install {
+        /// Root directory for the book, should contain the configuration file (`book.toml`)
+        ///
+        /// If not set, defaults to the current directory.
+        dir: Option<PathBuf>,
+
+        /// Relative directory for the css assets, from the book directory root
+        ///
+        /// If not set, defaults to the current directory.
+        #[arg(long)]
+        css_dir: Option<PathBuf>,
+    },
 }
 
 fn main() {
     env_logger::init_from_env(env_logger::Env::default().default_filter_or("info"));
 
-    let matches = make_app().get_matches();
-
-    if let Some(sub_args) = matches.subcommand_matches("supports") {
-        handle_supports(sub_args);
-    } else if let Some(sub_args) = matches.subcommand_matches("install") {
-        #[cfg(feature = "cli-install")]
-        {
-            install::handle_install(sub_args);
+    let cli = Cli::parse();
+    if let Err(error) = run(cli) {
+        log::error!("Fatal error: {}", error);
+        for error in error.chain() {
+            log::error!("  - {}", error);
         }
-        #[cfg(not(feature = "cli-install"))]
-        {
-            panic!("cli-install feature not enabled: {:?}", sub_args)
-        }
-    } else if let Err(e) = handle_preprocessing() {
-        eprintln!("{}", e);
         process::exit(1);
     }
 }
 
+fn run(cli: Cli) -> Result<()> {
+    match cli.command {
+        None => handle_preprocessing(),
+        Some(Commands::Supports { renderer }) => {
+            handle_supports(renderer);
+        }
+        #[cfg(feature = "cli-install")]
+        Some(Commands::Install { dir, css_dir }) => install::handle_install(
+            dir.unwrap_or_else(|| PathBuf::from(".")),
+            css_dir.unwrap_or_else(|| PathBuf::from(".")),
+        ),
+    }
+}
+
 fn handle_preprocessing() -> Result<(), Error> {
     let (ctx, book) = CmdPreprocessor::parse_input(io::stdin())?;
 
@@ -71,9 +83,8 @@ fn handle_preprocessing() -> Result<(), Error> {
     Ok(())
 }
 
-fn handle_supports(sub_args: &ArgMatches) -> ! {
-    let renderer = sub_args.value_of("renderer").expect("Required argument");
-    let supported = Admonish.supports_renderer(renderer);
+fn handle_supports(renderer: String) -> ! {
+    let supported = Admonish.supports_renderer(&renderer);
 
     // Signal whether the renderer is supported by exiting with 1 or 0.
     if supported {
@@ -85,12 +96,11 @@ fn handle_supports(sub_args: &ArgMatches) -> ! {
 
 #[cfg(feature = "cli-install")]
 mod install {
-    use clap::ArgMatches;
+    use anyhow::{Context, Result};
     use std::{
         fs::{self, File},
         io::Write,
         path::PathBuf,
-        process,
     };
     use toml_edit::{self, Array, Document, Item, Table, Value};
 
@@ -112,22 +122,14 @@ mod install {
         }
     }
 
-    pub fn handle_install(sub_args: &ArgMatches) {
-        let dir = sub_args.value_of("dir").expect("Required argument");
-        let css_dir = sub_args.value_of("css-dir").expect("Required argument");
-        let proj_dir = PathBuf::from(dir);
+    pub fn handle_install(proj_dir: PathBuf, css_dir: PathBuf) -> Result<()> {
         let config = proj_dir.join("book.toml");
-
-        if !config.exists() {
-            log::error!("Configuration file '{}' missing", config.display());
-            process::exit(1);
-        }
-
         log::info!("Reading configuration file '{}'", config.display());
-        let toml = fs::read_to_string(&config).expect("can't read configuration file");
+        let toml = fs::read_to_string(&config)
+            .with_context(|| format!("can't read configuration file '{}'", config.display()))?;
         let mut doc = toml
             .parse::<Document>()
-            .expect("configuration is not valid TOML");
+            .context("configuration is not valid TOML")?;
 
         if let Ok(preprocessor) = preprocessor(&mut doc) {
             const ASSETS_VERSION: &str = std::include_str!("./assets/VERSION");
@@ -142,8 +144,8 @@ mod install {
 
         let mut additional_css = additional_css(&mut doc);
         for (name, content) in ADMONISH_CSS_FILES {
-            let filepath = proj_dir.join(css_dir).join(name);
-            let filepath_str = filepath.to_str().expect("non-utf8 filepath");
+            let filepath = proj_dir.join(&css_dir).join(name);
+            let filepath_str = filepath.to_str().context("non-utf8 filepath")?;
 
             if let Ok(ref mut additional_css) = additional_css {
                 if !additional_css.contains_str(filepath_str) {
@@ -158,18 +160,18 @@ mod install {
                 "Copying '{name}' to '{filepath}'",
                 filepath = filepath.display()
             );
-            let mut file = File::create(filepath).expect("can't open file for writing");
+            let mut file = File::create(&filepath).context("can't open file for writing")?;
             file.write_all(content)
-                .expect("can't write content to file");
+                .context("can't write content to file")?;
         }
 
         let new_toml = doc.to_string();
         if new_toml != toml {
             log::info!("Saving changed configuration to '{}'", config.display());
             let mut file =
-                File::create(config).expect("can't open configuration file for writing.");
+                File::create(config).context("can't open configuration file for writing.")?;
             file.write_all(new_toml.as_bytes())
-                .expect("can't write configuration");
+                .context("can't write configuration")?;
         } else {
             log::info!("Configuration '{}' already up to date", config.display());
         }
@@ -179,8 +181,7 @@ mod install {
 A beautifully styled message.
 ```"#;
         log::info!("Add a code block like:\n{}", codeblock);
-
-        process::exit(0);
+        Ok(())
     }
 
     /// Return the `additional-css` field, initializing if required.