markdown_link_checker_sc 0.0.9 → 0.0.11

package/README.md

@@ -1,6 +1,7 @@
 # markdown link checker sc
 
 ALPHA - Mostly just attempting better handling of internal links.
+Probably never coming out of alpha. Bit of fun.
 
 Markdown link checker in node.
 Better handling of internal link checking.
@@ -9,10 +10,34 @@ Better handling of internal link checking.
 Current version only does internal link checking
 
 ```
-Usage: index [options]
+Usage: markdown_link_checker_sc [options]
 
 Options:
-  -d, --directory [directory]         The directory to search for markdown and html files (default: is current directory)
-  -h, --headingAnchorSlugify [value]  Slugify approach for turning markdown headings into heading anchors. Currently support vuepress only and always (default: "vuepress")
-  --help                              display help for command
+  -d, --directory [directory]         The directory to search for markdown and html files (default:
+                                      "D:\\github\\hamishwillee\\markdown_link_checker_sc")
+  -s, --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)
+  -l, --log [value]                   Export some logs for debugging.  (default: false)
+  -f, --files <path>                  JSON file with array of files to report on (default is all files). Paths are
+                                      relative relative to -d by default, but -r can be used to set a different root.
+                                      (default: "")
+  -r, --root <path>                   Directory to prepend before file paths in the JSON directory. Default is same as
+                                      directory. Useful if directory is not your repo root (default: "")
+  -h, --help                          display help for command
 ```
+
+
+The way this works:
+- Sspecify the directory and it will search below that for all markdown/html files.
+- It loads each file, and:
+  - parses for markdown and html style links for both page and image links.
+  - parses headings and builds list of anchors in the page (as per vuepress) for those headings (poorly tested code)
+  - parses for html elements with ids, that are also link targets. 
+- Then it parses the results, comparing internal links to internal anchors to see if it can find matching files, and matching headings or anchors within files.
+  - If it can't match, that is an error - which gets added to the list of errors with a type and enough detail to handle.
+- Errors are then filtered based on:
+  - pages in a json file defined using -f (and possibly -r). 
+- Finally the output is exported in a markdown friendly output format.
+
+Lots more to do, but this already catches lots of internal errors.

package/index.js

@@ -11,7 +11,7 @@ program
     process.cwd()
   )
   .option(
-    "-h, --headingAnchorSlugify [value]",
+    "-s, --headingAnchorSlugify [value]",
     "Slugify approach for turning markdown headings into heading anchors. Currently support vuepress only and always",
     "vuepress"
   )
@@ -402,7 +402,7 @@ function filterErrors(errors) {
   // This method filters all errors against settings in the command line - such as pages to output.
   let filteredErrors = errors;
   // Filter results on specified file names (if any specified)
-  console.log(`Number pages to filter: ${options.files.length}`);
+  //console.log(`Number pages to filter: ${options.files.length}`);
   if (options.files.length > 0) {
     filteredErrors = errors.filter((error) => {
       //console.log(`Error: ${error}`);
@@ -449,17 +449,17 @@ function outputErrors(results) {
 
   //console.log(sortedByPageErrors);
   for (page in sortedByPageErrors) {
-    console.log(`${page}`);
+    console.log(`\n${page}`);
     for (const error of sortedByPageErrors[page]) {
       if (error.type == "InternalLinkMissingFile") {
-        console.log(`  ${error.type}: ${error.linkUrl}`);
+        console.log(`- ${error.type}: ${error.linkUrl}`);
         //console.log(`  ${error.type}: ${error.linkAnchor}, linkURL: ${error.linkUrl}`);
         // { "type": "InternalLinkMissingFile", "page": `${page.page_file}`, "linkUrl": `${link.linkUrl}`, "linkText": `${link.linkText}`, "linkUrlFilePath": `${linkAbsoluteFilePath}` };
       } else if (error.type == "InternalLocalMissingAnchor") {
         // missing anchor in linked file that exists.
         //console.log(error);
         console.log(
-          `  ${error.type}: #${error.linkAnchor} (not found in current file)`
+          `- ${error.type}: #${error.linkAnchor} (not found in current file)`
         );
         //console.log(`  ${error.type}: #${error.linkAnchor} (heading/anchor missing?)`);
         //console.log(`  #${error.linkAnchor} - Internal anchor not found`);
@@ -470,7 +470,7 @@ function outputErrors(results) {
         // missing anchor in linked file that exists.
         //console.log(error);
         console.log(
-          `  ${error.type}: #${error.linkAnchor} not found in ${error.linkUrlFilePath}`
+          `- ${error.type}: #${error.linkAnchor} not found in ${error.linkUrlFilePath}`
         );
         //console.log(`  ${error.type}: #${error.linkAnchor} (heading/anchor missing?)`);
         //console.log(`  #${error.linkAnchor} - Internal anchor not found`);
@@ -478,7 +478,7 @@ function outputErrors(results) {
         //console.log(`  Internal anchor not found: #${error.linkAnchor} `);
         // { "type": "InternalMissingAnchor", "page": `${page.page_file}`, "linkAnchor": `${link.linkAnchor}`, "linkUrl": `${link.linkUrl}`, "linktext": `${link.linkText}`, "linkUrlFilePath": `${linkAbsoluteFilePath}` };
       } else if (error.type == "InternalLinkToHTML") {
-        console.log(`  ${error.type}: ${error.linkUrl} (should be ".md"?)`);
+        console.log(`- ${error.type}: ${error.linkUrl} (should be ".md"?)`);
         //console.log(`  ${error.type}: linkURL: ${error.linkUrl} ends in ".html"`);
         // { "type": "InternalLinkToHTML", "page": `${page.page_file}`, "linkUrl": `${link.linkUrl}`, "linkText": `${link.linkText}`, "linkUrlFilePath": `${linkAbsoluteFilePath}`  };
       } else {

package/package.json

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