markdown_link_checker_sc 0.0.138 → 0.0.140

package/README.md

@@ -13,21 +13,27 @@ Usage: markdown_link_checker_sc [options]
 
 Options:
   -r, --repo <path>                   Repo root directory. Defaults to current directory. Everything resolved relative to this.) (default: "")
-  -d, --doc [directory]               Docs root directory, relative to -g (such as `docs`). Defaults to '' (all docs in root of repo). Use -d as well to restrict search to a particular subfolder. Defaults to current directory. (default:
+  -d, --doc [directory]               Docs root directory, relative to -r (such as `docs`). Defaults to '' (all docs in root of repo). Use -d as well to restrict
+                                      search to a particular subfolder. Defaults to current directory. (default:
                                       "D:\\github\\hamishwillee\\markdown_link_checker_sc")
-  -e, --subdir [directory]            A subfolder of the docs root (-d) to search for markdown and html files. Such as: `en` for an English subfolder. Default empty (same as -d directory) (default: "")
-  -i, --imagedir [directory]          The directory to search for all image files for global orphan checking, relative docs root (-d) - such as: `assets` or `en`. Default empty if not explicitly set, and global orphan checking will not be done
-                                      (default: "")
-  -c, --headingAnchorSlugify [value]  Slugify approach for turning markdown headings into heading anchors. Currently support vuepress only and always (default: "vuepress")
-  -t, --tryMarkdownforHTML [value]    Try a markdown file extension check if a link to HTML fails. (default: true)
+  -e, --subdir [directory]            A subfolder of the docs root (-d) to search for markdown and html files. Such as: `en` for an English subfolder. Default
+                                      empty (same as -d directory) (default: "")
+  -i, --imagedir [directory]          The directory to search for all image files for global orphan checking, relative docs root (-d) - such as: `assets` or `en`.
+                                      Default empty if not explicitly set, and global orphan checking will not be done (default: "")
+  -c, --headingAnchorSlugify [value]  Slugify approach for turning markdown headings into heading anchors. Currently support vuepress only and always (default:
+                                      "vuepress")
+  -h, --tryMarkdownforHTML [value]    Try a markdown file extension check if a link to HTML fails. (default: true)
   -l, --log <types...>                Types of console logs to display logs for debugging. Types: functions, todo etc.
-  -f, --files <path>                  JSON file with array of files to report on (default is all files). JSON paths are usually relative to git repo root `-r`. (default: "")
-  -s, --toc [value]                   full filename of TOC/Summary file in file system. If not specified, inferred from file with most links to other files
+  -f, --files <path>                  JSON file with array of files to report on (default is all files). JSON paths are usually relative to git repo root `-r`.
+                                      (default: "")
+  -t, --toc [value]                   full filename of TOC/Summary file in file system. If not specified, inferred from file with most links to other files
   -u, --site_url [value]              Site base url in form dev.example.com (used to catch absolute urls to local files)
   -o, --logtofile [value]             Output logs to file (default: true)
   -p, --interactive [value]           Interactively add errors to the ignore list at <repo>/_link_checker_sc/ignore_errors.json (default: false)
   -c, --anchor_in_heading [value]     Detect anchors in heading such as: # Heading {#anchor} (default: true)
-  -h, --help                          display help for command
+  -x, --externallink [value]          Output logs to file (default: false)
+  -e, --errors [values]               WIP (don't use) Error type names to remove, space separated. By default ExternalLinkWarning (default: "ExternalLinkWarning")
+  --help                              display help for command
 ```
 
 ## Ignore file
@@ -81,7 +87,7 @@ This does catch a LOT of cases though, and is pretty quick.
 - Catches markdown files that are orphans - i.e. not linked by any file, or not linked by file which has the most links (normally the TOC file)
 - Catches orphan images
 - Allows you to specify that some errors are OK to ignore. These are stored in a file. See `-i` options\
-
+- Can run its own external link checker if -x is True. This is quite useful as you can control what errors get reported.
 
 ## TODO
 
@@ -111,3 +117,8 @@ The way this works:
 - Finally the output is exported in a markdown friendly output format.
 
 Lots more to do, but this already catches lots of internal errors.
+
+
+
+<!-- Tests
+node index.js -r D:\github\px4\PX4-Autopilot -d docs -e en -i assets -x True > px4_link_errors.txt -->

package/index.js

@@ -19,6 +19,7 @@ import { processMarkdown } from "./src/process_markdown.js";
 import { processRelativeLinks } from "./src/process_relative_links.js";
 import { checkLocalImageLinks } from "./src/process_local_image_links.js";
 import { processUrlsToLocalSource } from "./src/process_internal_url_links.js";
+import { processExternalUrlLinks } from "./src/process_external_url_links.js";
 import {
   checkPageOrphans,
   getPageWithMostLinks,
@@ -34,7 +35,7 @@ program
   )
   .option(
     "-d, --doc [directory]",
-    "Docs root directory, relative to -g (such as `docs`). Defaults to '' (all docs in root of repo). Use -d as well to restrict search to a particular subfolder. Defaults to current directory.",
+    "Docs root directory, relative to -r (such as `docs`). Defaults to '' (all docs in root of repo). Use -d as well to restrict search to a particular subfolder. Defaults to current directory.",
     process.cwd()
   )
   .option(
@@ -53,7 +54,7 @@ program
     "vuepress"
   )
   .option(
-    "-t, --tryMarkdownforHTML [value]",
+    "-h, --tryMarkdownforHTML [value]",
     "Try a markdown file extension check if a link to HTML fails.",
     true
   )
@@ -67,7 +68,7 @@ program
     ""
   )
   .option(
-    "-s, --toc [value]",
+    "-t, --toc [value]",
     "full filename of TOC/Summary file in file system. If not specified, inferred from file with most links to other files"
   )
   .option(
@@ -86,6 +87,12 @@ program
     "Detect anchors in heading such as: # Heading {#anchor}",
     true
   )
+  .option("-x, --externallink [value]", "Output logs to file", false)
+  .option(
+    "-e, --errors [values]",
+    "WIP (don't use) Error type names to remove, space separated. By default ExternalLinkWarning",
+    "ExternalLinkWarning"
+  )
   .parse(process.argv);
 
 // TODO PX4 special parsing - errors or pages we exclude by default.
@@ -130,6 +137,7 @@ sharedData.options.markdownroot = path.join(
 //console.log(`debug: sharedData.options.subdir: ${sharedData.options.subdir}`);
 //console.log(`debug: sharedData.options.docsroot: ${sharedData.options.docsroot}`);
 //console.log(`debug: sharedData.options.markdownroot: ${sharedData.options.markdownroot}`);
+//console.log(`debug: sharedData.options.errors: ${sharedData.options.errors}`);
 
 //process.exit(1);
 
@@ -281,7 +289,7 @@ const processDirectory = async (dir) => {
     pathToJsonIgnoreFile
   );
 
-  // process  containing markdown, return results which includes links, headings, id anchors
+  // process containing markdown, return results which includes links, headings, id anchors
   const results = await processDirectory(sharedData.options.markdownroot);
 
   if (!results.allErrors) {
@@ -325,6 +333,13 @@ const processDirectory = async (dir) => {
   const errorsGlobalImageOrphanCheck = await checkImageOrphansGlobal(results);
   results["allErrors"].push(...errorsGlobalImageOrphanCheck);
 
+  // Process links to externalURLs.
+  if (sharedData.options.externallink) {
+    const errorsFromExternalUrlLinks = await processExternalUrlLinks(results);
+    //console.log(    `debug: errorsFromExternalUrlLinks: ${errorsFromExternalUrlLinks}`  );
+    results["allErrors"].push(...errorsFromExternalUrlLinks);
+  }
+
   // Filter the errors based on the settings in options.
   // At time of writing just filters on specific set of pages.
   let filteredResults = filterErrors(results.allErrors);
@@ -335,7 +350,21 @@ const processDirectory = async (dir) => {
   outputErrors(filteredResults);
 
   //make array and document options? ie. if includes ...
-  const jsonFilteredErrors = JSON.stringify(filteredResults, null, 2);
+  function censorCircular(key, value) {
+    if (typeof value === "object" && value !== null) {
+      // Check if this object has already been seen (is part of a cycle)
+      // A more robust solution might involve a WeakSet to track seen objects
+      // For simplicity here, we're just checking for the specific problematic property
+      if (key === "issuerCertificate") {
+        console.warn(`Circular reference detected in key: ${key}`);
+        return "[Circular]"; // Or undefined to omit it entirely
+      }
+    }
+    return value;
+  }
+
+  const jsonFilteredErrors = JSON.stringify(filteredResults, censorCircular, 2);
+  //const jsonFilteredErrors = JSON.stringify(filteredResults, null, 2);
   logToFile("./logs/filteredErrors.json", jsonFilteredErrors);
 
   // Log filtered errors to standard out
@@ -344,14 +373,14 @@ const processDirectory = async (dir) => {
   }
 
   //make array and document options? ie. if includes ...
-  const jsonAllResults = JSON.stringify(results, null, 2);
+  const jsonAllResults = JSON.stringify(results, censorCircular, 2);
   logToFile("./logs/allResults.json", jsonAllResults);
   if (sharedData.options.log.includes("allresults")) {
     console.log(jsonAllResults);
   }
 
   //make array and document options? ie. if includes ...
-  const jsonAllErrors = JSON.stringify(results.allErrors, null, 2);
+  const jsonAllErrors = JSON.stringify(results.allErrors, censorCircular, 2);
   logToFile("./logs/allErrors.json", jsonAllErrors);
 
   if (sharedData.options.log.includes("allerrors")) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "markdown_link_checker_sc",
-  "version": "0.0.138",
+  "version": "0.0.140",
   "description": "Markdown Link Checker",
   "main": "index.js",
   "scripts": {