update original

Author: funkill

rust-cookbook/.github/workflows/mdbook-test.yml

@@ -27,7 +27,7 @@ jobs:
       - name: Test Results
         if: always()
         run: |
-          if [ ${{ steps.cargo_test.outcome }} == 'success' ]; then
+          if [ "${{ steps.cargo_test.outcome }}" == "success" ]; then
             echo "✅ All tests passed!"
           else
             echo "❌ Some tests failed. Check the logs above for details."
@@ -40,11 +40,13 @@ jobs:
     steps:
       - uses: actions/checkout@v5
       - uses: actions-rust-lang/setup-rust-toolchain@v1
-      - run: cargo check --workspace
+      - name: cargo check
+        id: cargo_check
+        run: cargo check --workspace
       - name: Check Results
         if: always()
         run: |
-          if [ ${{ steps.cargo_check.outcome }} == 'success' ]; then
+          if [ "${{ steps.cargo_check.outcome }}" == "success" ]; then
             echo "✅ Workspace check passed!"
           else
             echo "❌ Workspace check failed. Check the logs above for details."

rust-cookbook/CONTRIBUTING.md

@@ -44,6 +44,12 @@ To run the cookbook test suite:
 cargo test
 ```
 
+To run only the skeptic tests (useful when working on examples):
+
+```
+cargo test --test skeptic
+```
+
 ### xtask
 
 To simplify common tasks like testing, building the book, and running linters.
@@ -60,6 +66,12 @@ cargo install mdbook@0.4.43 lychee@0.17.0
   cargo xtask test all
   ```
 
+- To run only the skeptic tests:
+
+  ```bash
+  cargo test --test skeptic
+  ```
+
 - To build the book locally:
 
   ```bash
@@ -75,28 +87,24 @@ run on the continuous integration server.  These linters should be run locally
 before submitting a pull request to ensure there are no dead links or spelling
 errors made.
 
-To install the link checker, review the documentation for [python] to install
-python 3.6 and pip3.  Installing link-checker once the dependencies are met
-is done with pip3.
+To install the link checker, use Cargo:
 
-```
-[sudo] pip3 install link-checker==0.1.0
+```bash
+cargo install lychee@0.17.0
 ```
 
-Alternatively, add the user install directory (probably `~/.local/bin`) to
-your PATH variable and install link-checker for your user.
+Checking the links of the book locally can be done with the xtask tool.
+First, ensure the book is built with mdBook.
 
-```
-pip3 install --user link-checker==0.1.0
+```bash
+cargo xtask book
+cargo xtask test link
 ```
 
-Checking the links of the book locally first requires the book to be built
-with mdBook.  From the root directory of the cookbook, the following commands
-run the link checker.
+Alternatively, you can run lychee directly to check all files in the repository:
 
-```
-mdbook build
-link-checker ./book
+```bash
+lychee --base . --config ./ci/lychee.toml .
 ```
 
 The aspell binary provides spell checking.  Apt packages provide installation
@@ -132,7 +140,7 @@ Pressing `a` or `l` will not add the word to the custom dictionary.
 If there are no errors, it will just print the local Aspell version and exit.
 
 [mdbook]: https://github.com/rust-lang-nursery/mdBook
-[python]: https://packaging.python.org/tutorials/installing-packages/#install-pip-setuptools-and-wheel
+[lychee]: https://github.com/lycheeverse/lychee
 [skeptic]: https://github.com/brson/rust-skeptic
 
 

rust-cookbook/Cargo.toml

@@ -1,5 +1,5 @@
 [workspace]
-members = ["crates/algorithms/*", "crates/web", "xtask"]
+members = ["crates/algorithms/*", "crates/development_tools/debugging/tracing", "crates/web", "xtask"]
 
 [workspace.package]
 edition = "2024"
@@ -23,6 +23,8 @@ default = []
 [workspace.dependencies]
 rand = "0.9"
 rand_distr = "0.5"
+tracing = "0.1"
+tracing-subscriber = "0.3"
 
 # NOTE: These dependencies add dependencies to the rust playground (play.rust-lang.org).
 # Be wary removing or changing these without considering this fact.
@@ -77,6 +79,8 @@ thiserror = "2"
 threadpool = "1.8"
 tokio = { version = "1", features = ["full"] }
 toml = "0.8"
+tracing = "0.1"
+tracing-subscriber = "0.3"
 unicode-segmentation = "1.2.1"
 url = "2.5"
 walkdir = "2.5"

rust-cookbook/build.rs

@@ -5,7 +5,10 @@ const REMOVED_TESTS: &[&str] = &[
     "./src/web/clients/api/rate-limited.md",
 ];
 
-const REMOVED_PREFIXES: &[&str] = &["./src/algorithms/randomness/"];
+const REMOVED_PREFIXES: &[&str] = &[
+    "./src/algorithms/randomness/",
+    "./src/development_tools/debugging/tracing/",
+];
 
 fn main() {
     let paths = WalkDir::new("./src/")

rust-cookbook/crates/algorithms/randomness/src/bin/passwd.rs

@@ -1,13 +1,32 @@
-use rand::Rng;
-use rand_distr::Alphanumeric;
+use rand::{distr::Alphanumeric, Rng};
 
 fn main() {
+    let password = generate_password();
+    println!("{password}");
+}
+
+fn generate_password() -> String {
     const PASSWORD_LEN: usize = 30;
     let mut rng = rand::rng();
 
-    let password: String = (0..PASSWORD_LEN)
+    (0..PASSWORD_LEN)
         .map(|_| rng.sample(Alphanumeric) as char)
-        .collect();
+        .collect()
+}
 
-    println!("{password}");
+#[cfg(test)]
+mod tests {
+    use super::*;
+
+    #[test]
+    fn test_password_length() {
+        let password = generate_password();
+        assert_eq!(password.len(), 30);
+    }
+
+    #[test]
+    fn test_password_is_alphanumeric() {
+        let password = generate_password();
+        assert!(password.chars().all(|c| c.is_alphanumeric()));
+    }
 }

rust-cookbook/crates/development_tools/debugging/tracing/Cargo.toml

@@ -0,0 +1,11 @@
+[package]
+name = "tracing-console"
+version.workspace = true
+authors.workspace = true
+edition.workspace = true
+license.workspace = true
+publish.workspace = true
+
+[dependencies]
+tracing.workspace = true
+tracing-subscriber.workspace = true

rust-cookbook/crates/development_tools/debugging/tracing/src/bin/tracing-console.rs

@@ -0,0 +1,18 @@
+use tracing::{debug, error, info, trace, warn};
+
+fn main() {
+    tracing_subscriber::fmt::init();
+
+    error!("This is an error!");
+    warn!("This is a warning.");
+    info!("This is an informational message.");
+
+    // with the default configuration, debug! and trace! messages are not shown
+    debug!("This is a debug message.");
+    trace!("This is a trace message.");
+}
+
+#[test]
+fn test_main() {
+    main();
+}

rust-cookbook/crates/web/src/lib.rs

@@ -1,7 +1,7 @@
-mod broken;
-mod paginated;
-mod links;
-mod wiki;
+pub mod broken;
+pub mod paginated;
+pub mod links;
+pub mod wiki;
 
 #[cfg(test)]
 mod tests {

rust-cookbook/crates/web/src/wiki.rs

@@ -3,7 +3,7 @@ use std::borrow::Cow;
 use std::collections::HashSet;
 use std::sync::LazyLock;
 
-pub fn extract_links(content: &str) -> HashSet<Cow<str>> {
+pub fn extract_links(content: &str) -> HashSet<Cow<'_, str>> {
   static WIKI_REGEX: LazyLock<Regex> = LazyLock::new(|| Regex::new(
       r"(?x)
                 \[\[(?P<internal>[^\[\]|]*)[^\[\]]*\]\]    # internal links

rust-cookbook/src/SUMMARY.md

@@ -2,6 +2,7 @@
 
 [Table of Contents](intro.md)
 [About](about.md)
+
 - [Algorithms](algorithms.md)
   - [Generate Random Values](algorithms/randomness.md)
   - [Sort a Vector](algorithms/sorting.md)
@@ -28,6 +29,7 @@
   - [Debugging](development_tools/debugging.md)
     - [Log Messages](development_tools/debugging/log.md)
     - [Configure Logging](development_tools/debugging/config_log.md)
+    - [Tracing Messages](development_tools/debugging/tracing.md)
   - [Versioning](development_tools/versioning.md)
   - [Build Time Tooling](development_tools/build_tools.md)
 - [Encoding](encoding.md)