markdown_link_checker_sc 0.0.137 → 0.0.139

package/README.md

@@ -30,6 +30,18 @@ Options:
   -h, --help                          display help for command
 ```
 
+## Ignore file
+
+You can create a `_link_checker_sc\ignorefile.json` in the docs (path specified by `-d`) that lists any files you want to avoid parsing.
+This is a JSON array of file paths relative the the docsroot.
+
+For example, to not parse `en/_sidebar.md` your ignore file would have this pattern:
+
+```
+["en/_sidebar.md"]
+```
+
+Note that a missing ignorefile is not an error.
 
 ## What link formats can it match
 

package/index.js

@@ -3,9 +3,7 @@
 import fs from "fs";
 import path from "path";
 import { sharedData } from "./src/shared_data.js";
-//const path = require("path");
 import { program } from "commander";
-//const { program } = require("commander");
 import {
   logFunction,
   logToFile,
@@ -21,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,
@@ -36,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(
@@ -88,6 +87,7 @@ program
     "Detect anchors in heading such as: # Heading {#anchor}",
     true
   )
+  .option("-x, --externallink [value]", "Output logs to file", false)
   .parse(process.argv);
 
 // TODO PX4 special parsing - errors or pages we exclude by default.
@@ -101,9 +101,20 @@ sharedData.allHTMLFiles = new Set([]);
 sharedData.allImageFiles = new Set([]);
 sharedData.allOtherFiles = new Set([]);
 
-//console.log(`debug: sharedData.options.repo: ${sharedData.options.repo}`);
-//console.log(`debug: sharedData.options.doc: ${sharedData.options.doc}`);
-//console.log(`debug: sharedData.options.subdir: ${sharedData.options.subdir}`);
+function resolveRepoPath(repoOption) {
+  // This gets the path from CWD by default, or resolves path up.
+  if (!repoOption || repoOption === ".") {
+    return process.cwd(); // Current working directory (Node.js)
+  }
+
+  if (repoOption === "..") {
+    return path.resolve(process.cwd(), ".."); // One directory up
+  }
+
+  return path.resolve(repoOption); // Resolve to absolute path
+}
+
+sharedData.options.repo = resolveRepoPath(sharedData.options.repo);
 
 sharedData.options.docsroot = path.join(
   sharedData.options.repo,
@@ -179,8 +190,8 @@ async function loadJSONFileToIgnore(filePath) {
 
     return filesArray;
   } catch (error) {
-    //console.error(`Error reading file: ${error.message}`);
-    console.log(`Error reading ignore file: ${error.message}`);
+    //console.log(`Error reading ignore file: ${error.message}`);
+    //Note, ignore file is private really.
     return [];
     //process.exit(1);
   }
@@ -272,7 +283,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) {
@@ -316,6 +327,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);

package/package.json

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