Provide lint and lint:watch with VSCode config

Author: rvedotrc

.vscode/tasks.json

@@ -0,0 +1,51 @@
+{
+  // See https://go.microsoft.com/fwlink/?LinkId=733558
+  // for the documentation about the tasks.json format
+  "version": "2.0.0",
+  "tasks": [
+    {
+      "label": "Markdown lint",
+      "type": "npm",
+      "script": "lint",
+      "problemMatcher": {
+        "fileLocation": ["relative", "${workspaceFolder}"],
+        "severity": "error",
+        "owner": "lint-owner",
+        "source": "lint-source",
+        "pattern": {
+          "regexp": "^(.*?):(\\d+)(?::(\\d+))? ((?:MD|VL)\\S+) (.*)$",
+          "file": 1,
+          "line": 2,
+          "column": 3,
+          "code": 4,
+          "message": 5
+        }
+      }
+    },
+    {
+      "label": "Markdown lint (watch)",
+      "type": "npm",
+      "script": "lint:watch",
+      "isBackground": true,
+      "problemMatcher": {
+        "fileLocation": ["relative", "${workspaceFolder}"],
+        "severity": "error",
+        "owner": "lint-owner",
+        "source": "lint-source",
+        "pattern": {
+          "regexp": "^(.*?):(\\d+)(?::(\\d+))? ((?:MD|VL)\\S+) (.*)$",
+          "file": 1,
+          "line": 2,
+          "column": 3,
+          "code": 4,
+          "message": 5
+        },
+        "background": {
+          "activeOnStart": true,
+          "beginsPattern": "^lint START$",
+          "endsPattern": "^lint END$"
+        }
+      }
+    }
+  ]
+}

dist/gulpfile.js

@@ -0,0 +1,15 @@
+import { watch } from "gulp";
+import { spawn } from "node:child_process";
+export const lint = () => new Promise((resolve, _reject) => {
+    const child = spawn("./lint", { stdio: ["ignore", "inherit", "inherit"] });
+    child.on("close", (_code, _signal) => {
+        // if (code) reject(new Error(`./lint failed with exit code ${code}`));
+        // if (signal) reject(new Error(`./lint was killed by signal ${signal}`));
+        resolve();
+    });
+});
+export const lintWatch = () => {
+    watch(["**/*", "!.git/**", "!node_modules/**"], lint);
+    lint();
+};
+export default lintWatch;

dist/parse.js

@@ -1,4 +1,13 @@
 import mit from "markdown-it";
+const sourceLocationOf = (needle, haystack) => {
+    const index = haystack.indexOf(needle);
+    if (index < 0)
+        return null;
+    const parts = haystack.substring(0, index).split("\n");
+    if (parts.length === 0)
+        return null;
+    return { line0: parts.length - 1, column0: parts[parts.length - 1].length };
+};
 export const parse = (content) => {
     const parser = mit();
     const tokens = parser.parse(content, {});
@@ -9,20 +18,27 @@ export const parse = (content) => {
             if (token.type === "link_open") {
                 const indexOfNextClose = tokens.findIndex((t2, i2) => i2 > index && t2.type === "link_close");
                 if (indexOfNextClose > index) {
+                    const target = token.attrGet("href");
+                    const sourceLocation = sourceLocationOf(`(${target})`, content);
                     parsedLinks.push({
-                        target: token.attrGet("href"),
+                        target,
                         content: tokens
                             .slice(index + 1, indexOfNextClose)
                             .map((t) => t.content)
                             .join(""),
+                        sourceLocation,
                     });
                 }
             }
-            if (token.type === "image")
+            if (token.type === "image") {
+                const src = token.attrGet("src");
+                const sourceLocation = sourceLocationOf(`(${src})`, content);
                 parsedImages.push({
-                    src: token.attrGet("src"),
+                    src,
                     alt: token.content,
+                    sourceLocation,
                 });
+            }
             if (token.children)
                 scan(token.children);
         });

dist/validateLinks.js

@@ -25,6 +25,9 @@ const scanForLinks = async (filenames) => {
         return { filename, ...parse(content) };
     }));
 };
+const showError = (filename, sourceLocation, code, message) => {
+    console.log(`${filename}:${sourceLocation ? `${sourceLocation.line0 + 1}:${sourceLocation.column0 + 1}` : "0"} ${code} ${message}`);
+};
 const externalLinkPattern = /^\w+:/;
 const isExternalLink = (t) => externalLinkPattern.test(t);
 const main = async () => {
@@ -40,7 +43,7 @@ const main = async () => {
                 const resolved = path.join(dirname(parsedFile.filename), img.src);
                 const exists = lowercaseGitFiles.includes(resolved.toLocaleLowerCase());
                 if (!exists) {
-                    console.log(`error BROKEN-INTERNAL-IMAGE ${parsedFile.filename}:0 Broken internal image reference ${img.src}`);
+                    showError(parsedFile.filename, img.sourceLocation, "VL002/missing-image-source", `Image source does not exist ${img.src}`);
                     ++errors;
                 }
             }
@@ -65,7 +68,7 @@ const main = async () => {
                     : `${resolved.toLocaleLowerCase()}/`;
                 const isDirectory = lowercaseGitFiles.some((s) => s.startsWith(resolvedWithTrailingSlash));
                 if (!isFile && !isDirectory) {
-                    console.log(`error BROKEN-INTERNAL-LINK ${parsedFile.filename}:0 Link target does not exist: ${target}`);
+                    showError(parsedFile.filename, link.sourceLocation, "VL001/missing-link-target", `Link target does not exist: ${target}`);
                     ++errors;
                 }
             }

gulpfile.ts

@@ -0,0 +1,20 @@
+import { watch } from "gulp";
+import { spawn } from "node:child_process";
+
+export const lint = () =>
+  new Promise<void>((resolve, _reject) => {
+    const child = spawn("./lint", { stdio: ["ignore", "inherit", "inherit"] });
+
+    child.on("close", (_code, _signal) => {
+      // if (code) reject(new Error(`./lint failed with exit code ${code}`));
+      // if (signal) reject(new Error(`./lint was killed by signal ${signal}`));
+      resolve();
+    });
+  });
+
+export const lintWatch = () => {
+  watch(["**/*", "!.git/**", "!node_modules/**"], lint);
+  lint();
+};
+
+export default lintWatch;

lint

@@ -10,9 +10,11 @@ else
     if [ $? -ne 0 ] ; then
       echo "Try '\''./lint --fix'\'' to see if any automatic fixes are possible"
     fi
+    echo "lint END"
   ' 0
 
   rc=0
+  echo "lint START"
 
   echo "validateLinks: ..."
   if npm exec -- node dist/validateLinks.js ; then