@doccident/doccident 0.0.2 → 0.0.4

package/dist/parse-code-snippets-from-markdown.js

@@ -1,35 +1,58 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-var isStartOfSnippet = function (line) {
-    return line.trim().match(/```\W*(JavaScript|js|es6)\s?$/i);
-};
-var isEndOfSnippet = function (line) { return line.trim() === "```"; };
-var isSkip = function (line) { return line.trim() === "<!-- skip-example -->"; };
-var isCodeSharedInFile = function (line) {
-    return line.trim() === "<!-- share-code-between-examples -->";
-};
-function startNewSnippet(snippets, fileName, lineNumber) {
-    var skip = snippets.skip;
+// Capture indentation (group 1) and language (group 2)
+const START_REGEX = /^(\s*)```\W*(JavaScript|js|es6|ts|typescript|python|py|bash|sh|zsh|shell|go|rust|rs|fortran|f90|f95|cobol|cob|c)\s?$/i;
+const isStartOfSnippet = (line) => line.match(START_REGEX);
+const isEndOfSnippet = (line) => line.trim() === "```";
+const isSkip = (line) => line.trim() === "<!-- skip-example -->";
+const isCodeSharedInFile = (line) => line.trim() === "<!-- share-code-between-examples -->";
+function startNewSnippet(snippets, fileName, lineNumber, language, indentation) {
+    const skip = snippets.skip;
     snippets.skip = false;
+    let normalizedLang = 'javascript';
+    const langLower = language.toLowerCase();
+    if (['python', 'py'].includes(langLower)) {
+        normalizedLang = 'python';
+    }
+    else if (['bash', 'sh', 'zsh', 'shell'].includes(langLower)) {
+        normalizedLang = langLower === 'shell' ? 'bash' : langLower;
+    }
+    else if (langLower === 'go') {
+        normalizedLang = 'go';
+    }
+    else if (['rust', 'rs'].includes(langLower)) {
+        normalizedLang = 'rust';
+    }
+    else if (['fortran', 'f90', 'f95'].includes(langLower)) {
+        normalizedLang = 'fortran';
+    }
+    else if (['cobol', 'cob'].includes(langLower)) {
+        normalizedLang = 'cobol';
+    }
+    else if (langLower === 'c') {
+        normalizedLang = 'c';
+    }
     return Object.assign(snippets, {
         snippets: snippets.snippets.concat([
-            { code: "", fileName: fileName, lineNumber: lineNumber, complete: false, skip: skip }
+            { code: "", language: normalizedLang, fileName, lineNumber, complete: false, skip: skip ?? false, indentation }
         ])
     });
 }
 function addLineToLastSnippet(line) {
     return function addLine(snippets) {
-        var lastSnippet = snippets.snippets[snippets.snippets.length - 1];
+        const lastSnippet = snippets.snippets[snippets.snippets.length - 1];
         if (lastSnippet && !lastSnippet.complete) {
-            lastSnippet.code += line + "\n";
+            let lineToAdd = line;
+            if (lastSnippet.indentation && line.startsWith(lastSnippet.indentation)) {
+                lineToAdd = line.slice(lastSnippet.indentation.length);
+            }
+            lastSnippet.code += lineToAdd + "\n";
         }
         return snippets;
     };
 }
-function endSnippet(snippets, fileName, lineNumber) {
-    // eslint-disable-next-line no-console
-    console.log("endSnippet", snippets, fileName, lineNumber);
-    var lastSnippet = snippets.snippets[snippets.snippets.length - 1];
+function endSnippet(snippets, _fileName, _lineNumber) {
+    const lastSnippet = snippets.snippets[snippets.snippets.length - 1];
     if (lastSnippet) {
         lastSnippet.complete = true;
     }
@@ -44,8 +67,10 @@ function shareCodeInFile(snippets) {
     return snippets;
 }
 function parseLine(line) {
-    if (isStartOfSnippet(line)) {
-        return startNewSnippet;
+    const startMatch = isStartOfSnippet(line);
+    if (startMatch) {
+        // startMatch[1] is indentation, startMatch[2] is language
+        return (snippets, fileName, lineNumber) => startNewSnippet(snippets, fileName, lineNumber, startMatch[2], startMatch[1]);
     }
     if (isEndOfSnippet(line)) {
         return endSnippet;
@@ -59,27 +84,25 @@ function parseLine(line) {
     return addLineToLastSnippet(line);
 }
 function parseCodeSnippets(args) {
-    var contents = args.contents;
-    var fileName = args.fileName;
-    var initialState = {
+    const contents = args.contents;
+    const fileName = args.fileName;
+    const initialState = {
         snippets: [],
         shareCodeInFile: false,
         complete: false
     };
-    var results = contents
+    const results = contents
         .split("\n")
         .map(parseLine)
-        .reduce(function (snippets, lineAction, index) {
-        return lineAction(snippets, fileName, index + 1);
-    }, initialState);
-    var codeSnippets = results.snippets;
-    var lastSnippet = codeSnippets[codeSnippets.length - 1];
+        .reduce((snippets, lineAction, index) => lineAction(snippets, fileName, index + 1), initialState);
+    const codeSnippets = results.snippets;
+    const lastSnippet = codeSnippets[codeSnippets.length - 1];
     if (lastSnippet && !lastSnippet.complete) {
         throw new Error("Snippet parsing was incomplete");
     }
     return {
-        fileName: fileName,
-        codeSnippets: codeSnippets,
+        fileName,
+        codeSnippets,
         shareCodeInFile: results.shareCodeInFile
     };
 }

package/dist/reporter.js

@@ -0,0 +1,78 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.printResults = printResults;
+/* eslint-disable no-console */
+const chalk_1 = __importDefault(require("chalk"));
+function printResults(results) {
+    results.filter((result) => result.status === "fail").forEach(printFailure);
+    const passingCount = results.filter((result) => result.status === "pass")
+        .length;
+    const failingCount = results.filter((result) => result.status === "fail")
+        .length;
+    const skippingCount = results.filter((result) => result.status === "skip")
+        .length;
+    function successfulRun() {
+        return failingCount === 0;
+    }
+    console.log(chalk_1.default.green("Passed: " + passingCount));
+    if (skippingCount > 0) {
+        console.log(chalk_1.default.yellow("Skipped: " + skippingCount));
+    }
+    if (successfulRun()) {
+        console.log(chalk_1.default.green("\nSuccess!"));
+    }
+    else {
+        console.log(chalk_1.default.red("Failed: " + failingCount));
+    }
+}
+function printFailure(result) {
+    console.log(chalk_1.default.red(`Failed - ${markDownErrorLocation(result)}`));
+    const stackDetails = relevantStackDetails(result.stack);
+    console.log(stackDetails);
+    const variableNotDefined = stackDetails.match(/(\w{1,256}) is not defined/);
+    if (variableNotDefined) {
+        const variableName = variableNotDefined[1];
+        console.log(`You can declare ${chalk_1.default.blue(variableName)} in the ${chalk_1.default.blue("globals")} section in ${chalk_1.default.grey(".doccident-setup.js")}`);
+        console.log(`
+For example:
+${chalk_1.default.grey("// .doccident-setup.js")}
+module.exports = {
+  globals: {
+    ${chalk_1.default.blue(variableName)}: ...
+  }
+}
+    `);
+    }
+}
+function relevantStackDetails(stack) {
+    const evalIndex = stack.indexOf("at eval");
+    if (evalIndex !== -1) {
+        return stack.substring(0, evalIndex);
+    }
+    const lines = stack.split("\n");
+    for (let i = 0; i < lines.length; i++) {
+        const line = lines[i];
+        if (line.includes("doctest.js") && line.trim().startsWith("at ")) {
+            return lines.slice(0, i).join("\n") + "\n";
+        }
+    }
+    return stack;
+}
+function markDownErrorLocation(result) {
+    const lines = result.stack.split("\n");
+    for (const line of lines) {
+        if (line.includes("eval")) {
+            const match = line.match(/<([^><]+)>:(\d+):(\d+)/);
+            if (match) {
+                const mdLineNumber = parseInt(match[2], 10);
+                const columnNumber = parseInt(match[3], 10);
+                const lineNumber = result.codeSnippet.lineNumber + mdLineNumber;
+                return `${result.codeSnippet.fileName}:${lineNumber}:${columnNumber}`;
+            }
+        }
+    }
+    return `${result.codeSnippet.fileName}:${result.codeSnippet.lineNumber}`;
+}

package/dist/types.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/utils.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.flatten = flatten;
+function flatten(arr) {
+    return Array.prototype.concat.apply([], arr);
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@doccident/doccident",
-  "version": "0.0.2",
+  "version": "0.0.4",
   "description": "Test all the code in your markdown docs!",
   "main": "dist/doctest.js",
   "files": [
@@ -12,9 +12,10 @@
   },
   "scripts": {
     "build": "tsc",
-    "lint": "eslint . --ext .ts",
-    "test": "jest",
-    "precommit": "npm run lint && npm run test",
+    "lint": "eslint .",
+    "test": "vitest run",
+    "test:readme": "node bin/cmd.js README.md",
+    "precommit": "npm run lint && npm run test && npm run test:readme",
     "clean": "rm -rf dist",
     "prepublishOnly": "npm run clean && npm run build"
   },
@@ -37,29 +38,22 @@
   },
   "homepage": "https://github.com/BillaudCipher/doccident",
   "devDependencies": {
-    "@babel/preset-typescript": "^7.27.1",
     "@eslint/eslintrc": "^3.3.1",
     "@eslint/js": "^9.23.0",
     "@types/node": "^22.15.17",
     "@typescript-eslint/eslint-plugin": "^8.32.0",
     "@typescript-eslint/parser": "^8.32.0",
+    "@vitest/coverage-v8": "^4.0.16",
     "eslint": "^9.24.0",
     "eslint-plugin-import": "^2.31.0",
-    "jest": "^29.7.0",
-    "typescript": "^5.8.3"
+    "typescript": "^5.8.3",
+    "vitest": "^4.0.16"
   },
   "dependencies": {
-    "@babel/core": "^7.27.1",
-    "@babel/preset-env": "^7.27.2",
-    "chalk": "^2.4.2",
-    "commander": "^4.1.1",
-    "glob": "^7.2.3",
+    "chalk": "^4.1.2",
+    "commander": "^14.0.2",
+    "esbuild": "^0.27.2",
+    "fast-glob": "^3.3.3",
     "globals": "^16.1.0"
-  },
-  "babel": {
-    "presets": [
-      "@babel/preset-env",
-      "@babel/preset-typescript"
-    ]
   }
 }