Finish move of utils to mdbook-core

This updates everything for the move of utils to mdbook-core. There will
be followup commits that will be moving and refactoring these utils.
This simply moves them over unchanged (except visibility).

Author: ehuss

Cargo.lock

@@ -22,7 +22,12 @@ rust-version = "1.85.0" # Keep in sync with installation.md and .github/workflow
 
 [workspace.dependencies]
 anyhow = "1.0.98"
+log = "0.4.27"
 mdbook-core = { path = "crates/mdbook-core" }
+pulldown-cmark = { version = "0.10.3", default-features = false, features = ["html"] } # Do not update, part of the public api.
+regex = "1.11.1"
+tempfile = "3.20.0"
+toml = "0.5.11" # Do not update, see https://github.com/rust-lang/mdBook/issues/2037
 
 [package]
 name = "mdbook"
@@ -50,18 +55,18 @@ clap_complete = "4.3.2"
 env_logger = "0.11.1"
 handlebars = "6.0"
 hex = "0.4.3"
-log = "0.4.17"
+log.workspace = true
 mdbook-core.workspace = true
 memchr = "2.5.0"
 opener = "0.8.1"
-pulldown-cmark = { version = "0.10.0", default-features = false, features = ["html"] } # Do not update, part of the public api.
-regex = "1.8.1"
+pulldown-cmark.workspace = true
+regex.workspace = true
 serde = { version = "1.0.163", features = ["derive"] }
 serde_json = "1.0.96"
 sha2 = "0.10.8"
 shlex = "1.3.0"
-tempfile = "3.4.0"
-toml = "0.5.11" # Do not update, see https://github.com/rust-lang/mdBook/issues/2037
+tempfile.workspace = true
+toml.workspace = true
 topological-sort = "0.2.2"
 
 # Watch feature

Cargo.toml

@@ -9,6 +9,13 @@ rust-version.workspace = true
 
 [dependencies]
 anyhow.workspace = true
+log.workspace = true
+pulldown-cmark.workspace = true
+regex.workspace = true
+toml.workspace = true
+
+[dev-dependencies]
+tempfile.workspace = true
 
 [lints]
 workspace = true

crates/mdbook-core/Cargo.toml

@@ -10,3 +10,4 @@ pub const MDBOOK_VERSION: &str = env!("CARGO_PKG_VERSION");
 pub mod errors {
     pub use anyhow::{Error, Result};
 }
+pub mod utils;

crates/mdbook-core/src/lib.rs

@@ -29,7 +29,7 @@ pub fn write_file<P: AsRef<Path>>(build_dir: &Path, filename: P, content: &[u8])
 ///
 /// ```rust
 /// # use std::path::Path;
-/// # use mdbook::utils::fs::path_to_root;
+/// # use mdbook_core::utils::fs::path_to_root;
 /// let path = Path::new("some/relative/path");
 /// assert_eq!(path_to_root(path), "../../");
 /// ```

crates/mdbook-core/src/utils/fs.rs

@@ -12,7 +12,7 @@ use std::sync::LazyLock;
 
 pub mod fs;
 mod string;
-pub(crate) mod toml_ext;
+pub mod toml_ext;
 
 pub use self::string::{
     take_anchored_lines, take_lines, take_rustdoc_include_anchored_lines,
@@ -424,7 +424,8 @@ pub fn log_backtrace(e: &Error) {
     }
 }
 
-pub(crate) fn special_escape(mut s: &str) -> String {
+/// Escape characters to make it safe for an HTML string.
+pub fn special_escape(mut s: &str) -> String {
     let mut escaped = String::with_capacity(s.len());
     let needs_escape: &[char] = &['<', '>', '\'', '"', '\\', '&'];
     while let Some(next) = s.find(needs_escape) {
@@ -444,7 +445,8 @@ pub(crate) fn special_escape(mut s: &str) -> String {
     escaped
 }
 
-pub(crate) fn bracket_escape(mut s: &str) -> String {
+/// Escape `<` and `>` for HTML.
+pub fn bracket_escape(mut s: &str) -> String {
     let mut escaped = String::with_capacity(s.len());
     let needs_escape: &[char] = &['<', '>'];
     while let Some(next) = s.find(needs_escape) {

crates/mdbook-core/src/utils/mod.rs

@@ -1,9 +1,16 @@
+//! Helper for working with toml types.
+
 use toml::value::{Table, Value};
 
-pub(crate) trait TomlExt {
+/// Helper for working with toml types.
+pub trait TomlExt {
+    /// Read a dotted key.
     fn read(&self, key: &str) -> Option<&Value>;
+    /// Read a dotted key for a mutable value.
     fn read_mut(&mut self, key: &str) -> Option<&mut Value>;
+    /// Insert with a dotted key.
     fn insert(&mut self, key: &str, value: Value);
+    /// Delete a dotted key value.
     fn delete(&mut self, key: &str) -> Option<Value>;
 }
 

crates/mdbook-core/src/utils/toml_ext.rs

@@ -6,9 +6,9 @@ use std::path::{Path, PathBuf};
 
 use super::summary::{Link, SectionNumber, Summary, SummaryItem, parse_summary};
 use crate::config::BuildConfig;
-use crate::utils::bracket_escape;
 use anyhow::{Context, Result};
 use log::debug;
+use mdbook_core::utils::bracket_escape;
 use serde::{Deserialize, Serialize};
 
 /// Load a book into memory from its `src/` directory.

src/book/book.rs

@@ -5,9 +5,9 @@ use std::path::PathBuf;
 use super::MDBook;
 use crate::config::Config;
 use crate::theme;
-use crate::utils::fs::write_file;
 use anyhow::{Context, Result};
 use log::{debug, error, info, trace};
+use mdbook_core::utils::fs::write_file;
 
 /// A helper for setting up a new book and its directory structure.
 #[derive(Debug, Clone, PartialEq)]

src/book/init.rs

@@ -27,7 +27,7 @@ use crate::preprocess::{
     CmdPreprocessor, IndexPreprocessor, LinkPreprocessor, Preprocessor, PreprocessorContext,
 };
 use crate::renderer::{CmdRenderer, HtmlHandlebars, MarkdownRenderer, RenderContext, Renderer};
-use crate::utils;
+use mdbook_core::utils;
 
 use crate::config::{Config, RustEdition};