feat: WikilinkChecker as optional

include span in tests

fix: allow too many lines

fix merge conflicts

fix merge conflicts

Author: JayJayArr

README.md

@@ -540,7 +540,7 @@ Options:
           Find links in verbatim sections like `pre`- and `code` blocks
 
       --include-wikilinks
-          Check WikiLinks in Markdown files
+          Check WikiLinks in Markdown files, this requires specifying --base-url
 
       --index-files <INDEX_FILES>
           When checking locally, resolves directory links to a separate index file.
@@ -684,28 +684,6 @@ Options:
           User agent
 
           [default: lychee/0.20.1]
-          [default: color]
-          [possible values: plain, color, emoji, task]
-
-  -f, --format <FORMAT>
-          Output format of final status report
-
-          [default: compact]
-          [possible values: compact, detailed, json, markdown, raw]
-
-      --require-https
-          When HTTPS is available, treat HTTP links as errors
-
-      --cookie-jar <COOKIE_JAR>
-          Tell lychee to read cookies from the given file. Cookies will be stored in the
-          cookie jar and sent with requests. New cookies will be stored in the cookie jar
-          and existing cookies will be updated.
-
-      --include-wikilinks
-          Check WikiLinks in Markdown files, this requires specifying --base-url
-
-  -h, --help
-          Print help (see a summary with '-h')
 
   -v, --verbose...
           Set verbosity level; more output per occurrence (e.g. `-v` or `-vv`)
@@ -721,13 +699,13 @@ Options:
 
 ### Exit codes
 
-0 Success. The operation was completed successfully as instructed.
+0   Success. The operation was completed successfully as instructed.
 
-1 Missing inputs or any unexpected runtime failures or configuration errors
+1   Missing inputs or any unexpected runtime failures or configuration errors
 
-2 Link check failures. At least one non-excluded link failed the check.
+2   Link check failures. At least one non-excluded link failed the check.
 
-3 Encountered errors in the config file.
+3   Encountered errors in the config file.
 
 ### Ignoring links
 

lychee-bin/tests/cli.rs

@@ -2524,7 +2524,7 @@ The config file should contain every possible key for documentation purposes."
             .arg("--dump")
             .arg("--include-wikilinks")
             .arg("--base-url")
-            .arg(fixtures_path())
+            .arg(fixtures_path!())
             .arg(test_path)
             .assert()
             .success()
@@ -2987,51 +2987,51 @@ The config file should contain every possible key for documentation purposes."
 
     #[test]
     fn test_wikilink_fixture_obsidian_style() {
-        let input = fixtures_path().join("wiki/obsidian-style.md");
+        let input = fixtures_path!().join("wiki/obsidian-style.md");
 
         // testing without fragments should not yield failures
-        main_command()
+        main_command!()
             .arg(&input)
             .arg("--include-wikilinks")
             .arg("--fallback-extensions")
             .arg("md")
             .arg("--base-url")
-            .arg(fixtures_path())
+            .arg(fixtures_path!())
             .assert()
             .success()
             .stdout(contains("4 OK"));
     }
 
     #[test]
     fn test_wikilink_fixture_with_fragments_obsidian_style_fixtures_excluded() {
-        let input = fixtures_path().join("wiki/obsidian-style-plus-headers.md");
+        let input = fixtures_path!().join("wiki/obsidian-style-plus-headers.md");
 
         // fragments should resolve all headers
-        main_command()
+        main_command!()
             .arg(&input)
             .arg("--include-wikilinks")
             .arg("--fallback-extensions")
             .arg("md")
             .arg("--base-url")
-            .arg(fixtures_path())
+            .arg(fixtures_path!())
             .assert()
             .success()
             .stdout(contains("4 OK"));
     }
 
     #[test]
     fn test_wikilink_fixture_with_fragments_obsidian_style() {
-        let input = fixtures_path().join("wiki/obsidian-style-plus-headers.md");
+        let input = fixtures_path!().join("wiki/obsidian-style-plus-headers.md");
 
         // fragments should resolve all headers
-        main_command()
+        main_command!()
             .arg(&input)
             .arg("--include-wikilinks")
             .arg("--include-fragments")
             .arg("--fallback-extensions")
             .arg("md")
             .arg("--base-url")
-            .arg(fixtures_path())
+            .arg(fixtures_path!())
             .assert()
             .success()
             .stdout(contains("4 OK"));

lychee-lib/src/checker/file.rs

@@ -38,7 +38,7 @@ pub(crate) struct FileChecker {
     /// Utility for performing fragment checks in HTML files.
     fragment_checker: FragmentChecker,
     /// Utility for checking wikilinks, indexes files in a given directory
-    wikilink_checker: WikilinkChecker,
+    wikilink_checker: Option<WikilinkChecker>,
 }
 
 impl FileChecker {
@@ -335,19 +335,26 @@ impl FileChecker {
 
     // Initializes the index of the wikilink checker
     fn setup_wikilinks(&self) -> Result<(), ErrorKind> {
-        self.wikilink_checker.setup_wikilinks_index()
+        match &self.wikilink_checker {
+            Some(checker) => checker.setup_wikilinks_index(),
+            None => Err(ErrorKind::WikilinkCheckerInit(
+                "Initialization failed, no checker instantiated".to_string(),
+            )),
+        }
     }
 
     // Tries to resolve a link by looking up the filename in the wikilink index
     fn apply_wikilink_check(&self, path: &Path, uri: &Uri) -> Result<PathBuf, ErrorKind> {
         let mut path_buf = path.to_path_buf();
         for ext in &self.fallback_extensions {
             path_buf.set_extension(ext);
-            match self.wikilink_checker.contains_path(&path_buf) {
-                None => {
-                    trace!("Tried to find wikilink {} at {}", uri, path_buf.display());
+            if let Some(checker) = &self.wikilink_checker {
+                match checker.contains_path(&path_buf) {
+                    None => {
+                        trace!("Tried to find wikilink {} at {}", uri, path_buf.display());
+                    }
+                    Some(resolved_path) => return Ok(resolved_path),
                 }
-                Some(resolved_path) => return Ok(resolved_path),
             }
         }
 

lychee-lib/src/extract/markdown.rs

@@ -24,6 +24,7 @@ fn md_extensions() -> Options {
 }
 
 /// Extract unparsed URL strings from a Markdown string.
+#[allow(clippy::too_many_lines)]
 pub(crate) fn extract_markdown(
     input: &str,
     include_verbatim: bool,
@@ -97,8 +98,8 @@ pub(crate) fn extract_markdown(
                                 text: wikilink.to_string(),
                                 element: Some("a".to_string()),
                                 attribute: Some("wikilink".to_string()),
-                        // wiki links start with `[[`, so offset the span by `2`
-                            span: span.start + 2
+                                // wiki links start with `[[`, so offset the span by `2`
+                                span: span_provider.span(span.start + 2)
                             }])
                         } else {
                             warn!("WARNING: The wikilink destination url {dest_url} could not be cleaned by removing potholes and fragments");
@@ -679,16 +680,19 @@ Shortcut link: [link4]
                 text: "foo".to_string(),
                 element: Some("a".to_string()),
                 attribute: Some("wikilink".to_string()),
+                span: span(2, 3),
             },
             RawUri {
                 text: "foo".to_string(),
                 element: Some("a".to_string()),
                 attribute: Some("wikilink".to_string()),
+                span: span(3, 3),
             },
             RawUri {
                 text: "foo".to_string(),
                 element: Some("a".to_string()),
                 attribute: Some("wikilink".to_string()),
+                span: span(4, 3),
             },
         ];
         assert_eq!(uris, expected);

lychee-lib/src/types/error.rs

@@ -183,11 +183,9 @@ pub enum ErrorKind {
     #[error("Failed to lock a Mutex")]
     MutexPoisoned,
 
-    /// Test-only error variant for formatter tests
-    /// Available in both test and debug builds to support cross-crate testing
-    #[cfg(any(test, debug_assertions))]
-    #[error("Generic test error")]
-    TestError,
+    /// Error when initializing the Wikilink Checker
+    #[error("Failed to initialize Wikilink Checker")]
+    WikilinkCheckerInit(String),
 }
 
 impl ErrorKind {
@@ -349,7 +347,10 @@ impl ErrorKind {
             ErrorKind::PreprocessorError{command, reason} => Some(format!("Command '{command}' failed {reason}. Check value of the pre option")),
             ErrorKind::MutexPoisoned => Some (
                 "One or more threads failed and poisoned a Mutex".to_string()
-            )
+            ),
+            ErrorKind::WikilinkCheckerInit(reason) => Some(format!(
+                "Error initializing the Wikilink Checker: {reason} ",
+            )),
         }
     }
 
@@ -480,7 +481,8 @@ impl Hash for ErrorKind {
             Self::Cookies(e) => e.hash(state),
             Self::StatusCodeSelectorError(e) => e.to_string().hash(state),
             Self::PreprocessorError { command, reason } => (command, reason).hash(state),
-            Self::MutexPoisoned => "Mutex Poisoned".to_string().hash(state),
+            Self::MutexPoisoned => "Mutex Poisoned".hash(state),
+            Self::WikilinkCheckerInit(e) => e.hash(state),
         }
     }
 }

lychee-lib/src/utils/wikilink_checker.rs

@@ -19,10 +19,17 @@ pub(crate) struct WikilinkChecker {
 }
 
 impl WikilinkChecker {
-    pub(crate) fn new(base: Option<Base>) -> Self {
-        Self {
-            basedir: base,
-            ..Default::default()
+    pub(crate) fn new(base: Option<Base>) -> Option<Self> {
+        if base.is_none() {
+            None
+        } else {
+            warn!(
+                "The Wikilink Checker could not be initialized because the base directory is missing"
+            );
+            Some(Self {
+                basedir: base,
+                ..Default::default()
+            })
         }
     }
 
@@ -68,7 +75,10 @@ impl WikilinkChecker {
                 // A remote base is of no use for the wikilink checker, silently skip over it
                 Base::Remote(remote_base_name) => {
                     warn!("Error using remote base url for checking wililinks: {remote_base_name}");
-                    Ok(())
+                    Err(ErrorKind::WikilinkCheckerInit(
+                        "Remote Base Directory found, only local directories are allowed"
+                            .to_string(),
+                    ))
                 }
             },
         }