Merge pull request #1229 from epage/refactor

refactor: Basic clean up

Author: epage

Cargo.lock

@@ -2,13 +2,13 @@
 members = [
     "crates/*",
 ]
-resolver = "2"
+resolver = "3"
 
 [workspace.package]
 repository = "https://github.com/cobalt-org/cobalt.rs"
 license = "MIT OR Apache-2.0"
-edition = "2021"
-rust-version = "1.76"  # MSRV
+edition = "2024"
+rust-version = "1.85"  # MSRV
 include = [
   "build.rs",
   "src/**/*",
@@ -159,7 +159,6 @@ jsonfeed = "0.2"
 pulldown-cmark = {version="0.12", default-features = false, features = ["html"] }
 engarde = { version = "0.1", path = "crates/engarde" }
 regex = "1.11"
-lazy_static = "1.5"
 itertools = "0.14"
 ignore = "0.4"
 serde = "1.0"

Cargo.toml

@@ -119,7 +119,9 @@ fn deprecated_split_front_matter(content: &str) -> (Option<&str>, &str) {
                 .unwrap()
         });
     if FRONT_MATTER_DIVIDE.is_match(content) {
-        log::warn!("Trailing separators are deprecated. We recommend frontmatters be surrounded, above and below, with ---");
+        log::warn!(
+            "Trailing separators are deprecated. We recommend frontmatters be surrounded, above and below, with ---"
+        );
 
         let mut splits = FRONT_MATTER_DIVIDE.splitn(content, 2);
 

crates/config/src/document.rs

@@ -98,15 +98,15 @@ mod tests {
     use super::*;
 
     macro_rules! assert_includes_dir {
-        ($root:expr, $ignores:expr, $test:expr, $included:expr) => {
+        ($root:expr_2021, $ignores:expr_2021, $test:expr_2021, $included:expr_2021) => {
             let root = $root;
             let ignores = $ignores.clone();
             let files = Source::new(std::path::Path::new(root), ignores).unwrap();
             assert_eq!(files.includes_dir(std::path::Path::new($test)), $included);
         };
     }
     macro_rules! assert_includes_file {
-        ($root:expr, $ignores:expr, $test:expr, $included:expr) => {
+        ($root:expr_2021, $ignores:expr_2021, $test:expr_2021, $included:expr_2021) => {
             let root = $root;
             let ignores = $ignores.clone();
             let files = Source::new(std::path::Path::new(root), ignores).unwrap();

crates/core/src/source.rs

@@ -2,7 +2,7 @@ use std::path::Path;
 use syntect::easy::HighlightLines;
 use syntect::highlighting::ThemeSet;
 use syntect::html::{
-    append_highlighted_html_for_styled_line, start_highlighted_html_snippet, IncludeBackground,
+    IncludeBackground, append_highlighted_html_for_styled_line, start_highlighted_html_snippet,
 };
 use syntect::parsing::{SyntaxReference, SyntaxSet};
 use syntect::util::LinesWithEndings;
@@ -116,8 +116,7 @@ mod test {
     }
     ";
 
-    const CODEBLOCK_RENDERED: &str =
-        "<pre style=\"background-color:#2b303b;\">\n\
+    const CODEBLOCK_RENDERED: &str = "<pre style=\"background-color:#2b303b;\">\n\
          <code><span style=\"color:#b48ead;\">mod </span>\
          <span style=\"color:#c0c5ce;\">test {\n\
          </span><span style=\"color:#c0c5ce;\">        </span>\

crates/engarde/src/syntax.rs

@@ -119,7 +119,7 @@ impl Server {
                 *server = Some(tiny_http::Server::http(self.addr()).map_err(Error::new)?);
             }
             Ok(Some(_)) | Err(TryLockError::WouldBlock) => {
-                return Err(Error::new("the server is running"))
+                return Err(Error::new("the server is running"));
             }
             Err(error @ TryLockError::Poisoned(_)) => return Err(Error::new(error)),
         }

crates/file-serve/src/lib.rs

@@ -30,14 +30,14 @@ impl BuildArgs {
         let config = cobalt::cobalt_model::Config::from_config(config)?;
 
         build(config)?;
-        info!("Build successful");
+        log::info!("Build successful");
 
         Ok(())
     }
 }
 
 pub(crate) fn build(config: cobalt::Config) -> Result<()> {
-    info!(
+    log::info!(
         "Building from `{}` into `{}`",
         config.source.display(),
         config.destination.display()
@@ -69,8 +69,8 @@ pub(crate) fn clean(config: &cobalt::Config) -> Result<()> {
     let destdir = match destdir {
         Ok(destdir) => destdir,
         Err(e) => {
-            debug!("No `{}` to clean", config.destination.display());
-            debug!("{}", e);
+            log::debug!("No `{}` to clean", config.destination.display());
+            log::debug!("{}", e);
             return Ok(());
         }
     };
@@ -84,7 +84,7 @@ pub(crate) fn clean(config: &cobalt::Config) -> Result<()> {
 
     fs::remove_dir_all(&destdir)?;
 
-    info!("directory `{}` removed", destdir.display());
+    log::info!("directory `{}` removed", destdir.display());
 
     Ok(())
 }

src/bin/cobalt/build.rs

@@ -1,11 +1,5 @@
 #![warn(warnings)]
 
-#[macro_use]
-extern crate lazy_static;
-
-#[macro_use]
-extern crate log;
-
 mod args;
 mod build;
 mod debug;
@@ -59,7 +53,7 @@ impl Cli {
             anstream::AutoStream::choice(&std::io::stderr()),
             anstream::ColorChoice::Never
         );
-        args::init_logging(self.logging.clone(), colored_stderr);
+        args::init_logging(self.logging, colored_stderr);
 
         match &self.command {
             Command::Init(cmd) => cmd.run(),

src/bin/cobalt/main.rs

@@ -2,6 +2,7 @@ use std::collections;
 use std::fs;
 use std::io::Write;
 use std::path;
+use std::sync::LazyLock;
 
 use anyhow::Context as _;
 use cobalt::cobalt_model;
@@ -21,7 +22,7 @@ impl InitArgs {
     pub(crate) fn run(&self) -> Result<()> {
         create_new_project(&self.directory)
             .with_context(|| anyhow::format_err!("Could not create a new cobalt project"))?;
-        info!("Created new project at {}", self.directory.display());
+        log::info!("Created new project at {}", self.directory.display());
 
         Ok(())
     }
@@ -187,13 +188,12 @@ layout: default.liquid
 {% endfor %}
 ";
 
-lazy_static! {
-    static ref DEFAULT: collections::HashMap<&'static str, &'static str> =
-        [("pages", INDEX_MD), ("posts", POST_MD)]
-            .iter()
-            .cloned()
-            .collect();
-}
+static DEFAULT: LazyLock<collections::HashMap<&'static str, &'static str>> = LazyLock::new(|| {
+    [("pages", INDEX_MD), ("posts", POST_MD)]
+        .iter()
+        .cloned()
+        .collect()
+});
 
 pub(crate) fn create_new_project<P: AsRef<path::Path>>(dest: P) -> Result<()> {
     create_new_project_for_path(dest.as_ref())
@@ -276,7 +276,7 @@ pub(crate) fn create_new_document(
         cobalt_model::files::read_file(&source_path)
             .with_context(|| anyhow::format_err!("Failed to read default: {:?}", source_path))?
     } else {
-        debug!(
+        log::debug!(
             "No custom default provided ({:?}), falling back to built-in",
             source_path
         );
@@ -323,7 +323,7 @@ pub(crate) fn create_new_document(
         fs::create_dir_all(parent)?;
     }
     create_file(&file.abs_path, &doc)?;
-    info!("Created new {} {}", collection_slug, file.rel_path);
+    log::info!("Created new {} {}", collection_slug, file.rel_path);
 
     Ok(())
 }
@@ -333,7 +333,7 @@ fn create_file<P: AsRef<path::Path>>(path: P, content: &str) -> Result<()> {
 }
 
 fn create_file_for_path(path: &path::Path, content: &str) -> Result<()> {
-    trace!("Creating file {:?}", path);
+    log::trace!("Creating file {:?}", path);
 
     let mut file = fs::OpenOptions::new()
         .write(true)
@@ -405,7 +405,7 @@ pub(crate) fn rename_document(
     cobalt_model::files::write_document_file(doc, &target.abs_path)?;
 
     if !full_front.is_draft {
-        warn!("Renaming a published page might invalidate links");
+        log::warn!("Renaming a published page might invalidate links");
     }
     fs::remove_file(source)?;
 
@@ -437,7 +437,10 @@ fn prepend_date_to_filename(
                 .first()
                 .expect("at least one element is enforced by config validator"))
     );
-    trace!("`publish_date_in_filename` setting is activated, prefix filename with date, new filename: {}", file_name);
+    log::trace!(
+        "`publish_date_in_filename` setting is activated, prefix filename with date, new filename: {}",
+        file_name
+    );
     fs::rename(file, file.with_file_name(file_name))?;
     Ok(())
 }

src/bin/cobalt/new.rs

@@ -46,11 +46,11 @@ impl ServeArgs {
         let server = server.build();
 
         let mut config = self.config.load_config()?;
-        debug!("Overriding config `site.base_url` with `/`");
+        log::debug!("Overriding config `site.base_url` with `/`");
         let host = format!("http://{}/", server.addr());
         config.site.base_url = Some(host.into());
         let mut config = cobalt_model::Config::from_config(config)?;
-        debug!(
+        log::debug!(
             "Overriding config `destination` with `{}`",
             dest.path().display()
         );
@@ -67,11 +67,11 @@ impl ServeArgs {
 
             dest.close()?;
         } else {
-            info!("Watching {} for changes", &config.source.display());
+            log::info!("Watching {} for changes", &config.source.display());
             thread::spawn(move || {
                 let e = serve(&server);
                 if let Some(e) = e.err() {
-                    error!("{}", e);
+                    log::error!("{}", e);
                 }
                 process::exit(1)
             });
@@ -84,19 +84,19 @@ impl ServeArgs {
 }
 
 fn serve(server: &file_serve::Server) -> Result<()> {
-    info!(
+    log::info!(
         "Serving {} through static file server",
         server.source().display()
     );
-    info!("Server Listening on http://{}", server.addr());
-    info!("Ctrl-c to stop the server");
+    log::info!("Server Listening on http://{}", server.addr());
+    log::info!("Ctrl-c to stop the server");
 
     Ok(server.serve()?)
 }
 
 fn open_browser(url: String) -> Result<()> {
     match open::that(url) {
-        Ok(()) => info!("Please check your browser!"),
+        Ok(()) => log::info!("Please check your browser!"),
         Err(why) => eprintln!("Failure to execute command: {why}"),
     }
     Ok(())
@@ -125,7 +125,7 @@ fn watch(config: &cobalt_model::Config) -> Result<()> {
     watcher
         .watch(&source, notify::RecursiveMode::Recursive)
         .with_context(|| anyhow::format_err!("Notify error"))?;
-    info!("Watching {} for changes", config.source.display());
+    log::info!("Watching {} for changes", config.source.display());
 
     for event in rx {
         let event = event.with_context(|| anyhow::format_err!("Notify error"))?;
@@ -145,17 +145,17 @@ fn watch(config: &cobalt_model::Config) -> Result<()> {
             // ensure we don't miss anything (normal file walks will miss
             // `_layouts`, etc).
             if event_path.starts_with(&destination) {
-                trace!("Ignored file changed {:?}", event);
+                log::trace!("Ignored file changed {:?}", event);
                 false
             } else {
-                debug!("Page changed {:?}", event);
+                log::debug!("Page changed {:?}", event);
                 true
             }
         });
         if rebuild {
             let result = build::build(config.clone());
             if let Err(fail) = result {
-                error!("build failed\n{:?}", fail);
+                log::error!("build failed\n{:?}", fail);
             }
         }
     }

src/bin/cobalt/serve.rs

@@ -11,9 +11,9 @@ use log::warn;
 use sitemap::writer::SiteMapWriter;
 
 use crate::cobalt_model;
+use crate::cobalt_model::Collection;
 use crate::cobalt_model::files;
 use crate::cobalt_model::permalink;
-use crate::cobalt_model::Collection;
 use crate::cobalt_model::{Config, Minify, SortOrder};
 use crate::document::{Document, RenderContext};
 use crate::error::Result;

src/cobalt.rs

@@ -6,7 +6,7 @@ use log::debug;
 use serde::{Deserialize, Serialize};
 
 use super::sass;
-use super::{files, Minify};
+use super::{Minify, files};
 
 use crate::error::Result;
 

src/cobalt_model/assets.rs

@@ -5,8 +5,8 @@ use std::path;
 
 use crate::error::Result;
 use anyhow::Context as _;
-use ignore::gitignore::{Gitignore, GitignoreBuilder};
 use ignore::Match;
+use ignore::gitignore::{Gitignore, GitignoreBuilder};
 use log::debug;
 use log::trace;
 use normalize_line_endings::normalized;
@@ -318,7 +318,7 @@ mod tests {
     use super::*;
 
     macro_rules! assert_includes_dir {
-        ($root:expr, $ignores:expr, $test:expr, $included:expr) => {
+        ($root:expr_2021, $ignores:expr_2021, $test:expr_2021, $included:expr_2021) => {
             let mut files = FilesBuilder::new(path::Path::new($root)).unwrap();
             let ignores: &[&str] = $ignores;
             for ignore in ignores {
@@ -329,7 +329,7 @@ mod tests {
         };
     }
     macro_rules! assert_includes_file {
-        ($root:expr, $ignores:expr, $test:expr, $included:expr) => {
+        ($root:expr_2021, $ignores:expr_2021, $test:expr_2021, $included:expr_2021) => {
             let mut files = FilesBuilder::new(path::Path::new($root)).unwrap();
             let ignores: &[&str] = $ignores;
             for ignore in ignores {