Added link checker for markdown content. closes #45

package.json

@@ -83,6 +83,7 @@
     "file-loader": "^6.0.0",
     "html-webpack-plugin": "^4.3.0",
     "jest": "^26.2.0",
+    "link-check": "^4.5.0",
     "open-browser-webpack-plugin": "github:rodrigopandini/open-browser-webpack-plugin",
     "rimraf": "^3.0.2",
     "style-loader": "^1.2.1",

src/scripts/checkLibraryLinks.sh

@@ -0,0 +1,3 @@
+#!/bin/sh
+set -e
+find data/libraries/ -name '*.slate' -exec src/scripts/checkLinks.sh '{}' +

src/scripts/checkLinks.sh

@@ -0,0 +1,3 @@
+#!/bin/sh
+set -e
+node_modules/.bin/ts-node -P src/scripts/tsconfig.json src/scripts/checkLinks.ts "$@"

src/scripts/checkLinks.ts

@@ -0,0 +1,92 @@
+import * as fs from 'fs';
+import * as Fmt from '../shared/format/format';
+import * as FmtReader from '../shared/format/read';
+import { getMetaModelWithFallback } from '../fs/format/dynamic';
+import * as Logics from '../shared/logics/logics';
+
+const Remarkable = require('remarkable').Remarkable;
+const linkify = require('remarkable/linkify').linkify;
+const linkCheck = require('link-check');
+
+let linksFound = 0;
+let linksChecking = 0;
+let linksChecked = 0;
+
+class LinkExtractor {
+  constructor(private fileName: string) {}
+
+  render(tokens: any[] = []): void {
+    for (let token of tokens) {
+      if (token.type === 'link_open') {
+        let uri: string = token.href;
+        if (uri.startsWith('http://') || uri.startsWith('https://')) {
+          linksFound++;
+          this.triggerLinkCheck(uri);
+        }
+      } else if (token.children) {
+        this.render(token.children);
+      }
+    }
+  }
+
+  private triggerLinkCheck(uri: string) {
+    if (linksChecking < 10) {
+      linksChecking++;
+      linkCheck(uri, (err: any, result: any) => {
+        if (err) {
+          console.error(`${this.fileName}: ${err}`);
+        } else if (result.status !== 'alive') {
+          console.error(`${this.fileName}: ${result.status} link: ${result.link}`);
+        }
+        linksChecking--;
+        linksChecked++;
+        if (linksChecked === linksFound) {
+          console.log(`${linksChecked} links checked.`);
+        }
+      });
+    } else {
+      setTimeout(() => this.triggerLinkCheck(uri), 1000);
+    }
+  }
+}
+
+function checkDefinitionLinks(fileName: string, definition: Fmt.Definition) {
+  if (definition.documentation) {
+    for (let documentationItem of definition.documentation.items) {
+      let md = new Remarkable;
+      md.use(linkify);
+      md.renderer = new LinkExtractor(fileName);
+      md.render(documentationItem.text);
+    }
+  }
+
+  for (let innerDefinition of definition.innerDefinitions) {
+    checkDefinitionLinks(fileName, innerDefinition);
+  }
+}
+
+function checkLinks(fileName: string): void {
+  let fileStr = fs.readFileSync(fileName, 'utf8');
+  let getMetaModel = (path: Fmt.Path) => {
+    let logic = Logics.findLogic(path.name);
+    if (logic) {
+      return logic.getMetaModel(path);
+    }
+    return getMetaModelWithFallback(fileName, path);
+  };
+  let file = FmtReader.readString(fileStr, fileName, getMetaModel);
+  for (let definition of file.definitions) {
+    checkDefinitionLinks(fileName, definition);
+  }
+}
+
+if (process.argv.length < 3) {
+  console.error('usage: src/scripts/checkLinks.sh <file1> [<file2>...]');
+  process.exit(2);
+}
+
+for (let fileName of process.argv.slice(2)) {
+  checkLinks(fileName);
+}
+
+console.log(`${linksFound} links found.`);