@doccident/doccident 0.0.2 → 0.0.3

package/README.md

@@ -1,179 +1,147 @@
-[![npm version](https://badge.fury.io/js/doccident.svg)](http://badge.fury.io/js/doccident)
-[![Build Status](https://travis-ci.org/Widdershin/doccident.svg?branch=master)](https://travis-ci.org/Widdershin/doccident)
-[![Greenkeeper badge](https://badges.greenkeeper.io/Widdershin/doccident.svg)](https://greenkeeper.io/)
-
-* * *
-
 # doccident
 
-Test all the code in your markdown docs!
-
-Why on earth?
----
-
-As an open source developer, there are few things more embarrassing than a user opening an issue to inform you that your README example is broken! With  `doccident`, you can rest easy knowing that your example code is *actually runnable*.
+[![npm version](https://badge.fury.io/js/doccident.svg)](http://badge.fury.io/js/doccident)
 
-Installation
----
-Just `npm install @doccident/doccident` and run `doccident`. It will run all of the Javascript code examples tucked away in your markdown, and let you know if any blow up.
+**Test the code examples in your Markdown documentation.**
 
-Okay, how do I use it?
----
+## Overview
 
-Let's try it on this repo!
+As an open source developer, few things are more frustrating for users than encountering broken examples in a README. `doccident` ensures your documentation remains accurate by treating your examples as testable code. It parses your Markdown files, extracts JavaScript and TypeScript code blocks, and executes them in a sandboxed environment to verify they run without errors.
 
-```js
-var a = 5;
+> **Note**: `doccident` primarily verifies that your code *runs* without throwing exceptions. While you can add assertions to your examples to test correctness, its main goal is to ensure your documentation examples are valid and runnable.
 
-var b = 10;
+## Installation
 
-console.log(a + c);
+```bash
+npm install --save-dev @doccident/doccident
 ```
 
-There's a problem with that example. `doccident` finds it for us:
+## Usage
+
+Run `doccident` in your project root. By default, it recursively checks all `.md` and `.markdown` files (excluding `node_modules`).
 
 ```bash
-$ doccident
-x..
+npx doccident
+```
 
-Failed - README.md:32:17
-evalmachine.<anonymous>:7
-console.log(a + c);
-                ^
+You can also target specific files or directories:
 
-ReferenceError: c is not defined
+```bash
+npx doccident docs/**/*.md
 ```
 
-Awesome! No excuse for broken documentation ever again, right? :wink:
+### Language Support & Recipes
 
-We can also run specific files or folders by running `doccident` with a glob, like `doccident docs/**/*.md`. By default `doccident` will recursively run all the `.md` or `.markdown` files starting with the current directory, with the exception of the `node_modules` directory.
+`doccident` executes code inside `js`, `javascript`, `es6`, `ts`, or `typescript` fenced code blocks. It automatically transforms modern JavaScript and TypeScript using **esbuild** before execution.
 
-Note: `doccident` doesn't actually attempt to provide any guarantee that your code worked, only that it didn't explode in a horrible fashion. If you would like to use `doccident` for actually testing the correctness of your code, you can add some `assert`s to your examples.
+#### JavaScript
 
-`doccident` is not a replacement for your test suite. It's designed to run with your CI build and give you peace of mind that all of your examples are at least vaguely runnable.
+Use `js`, `javascript`, or `es6` for JavaScript examples.
 
-So how do I write those examples?
----
+**Recipe:**
 
-In your markdown files, anything inside of code blocks with 'js' or 'es6' will be run. E.g:
+1.  Use `js` fenced code blocks.
+2.  Write standard JavaScript (ES6+ supported).
+3.  Use `require` to load dependencies defined in your configuration.
 
     ```js
-    console.log("Yay, tests in my docs");
+    const { sum } = require('./math-utils');
+    const result = sum(1, 2);
     ```
 
-    ```es6
-    const a = 5;
-    console.log({a, foo: 'test'});
+#### TypeScript
+
+Use `ts` or `typescript` for TypeScript examples.
+
+**Recipe:**
+
+1.  Use `ts` fenced code blocks.
+2.  Include type annotations to demonstrate correct usage.
+3.  `doccident` strips types during execution, so your examples serve as both documentation and functional tests.
+
+    ```ts
+    interface User {
+      id: number;
+      name: string;
+    }
+
+    const user: User = { id: 1, name: 'Doccident' };
+    console.log(user.name);
     ```
 
-I have a code example I don't want tested!
----
-You can tell `doccident` to skip examples by adding `<!-- skip-example -->` before the example. E.g:
+### Skipping Examples
+
+To skip a specific code block, add the `<!-- skip-example -->` comment immediately before it:
 
     <!-- skip-example -->
     ```js
-    // not a runnable example
-
-    var foo = download(...);
+    // This code will not be executed
+    fetch('https://example.com');
     ```
 
-How do requires work? And other setup logic?
----
+## Configuration
+
+Create a `.doccident-setup.js` file in your project root to configure the test environment.
 
-You can `require` any needed modules or example helpers in `.doccident-setup.js`. E.g:
+### Injecting Dependencies (`require`)
 
-<!-- skip-example -->
-```js
+If your examples use external libraries, provide them here. This allows your examples to `require` modules just like users would:
+
+```javascript
 // .doccident-setup.js
 module.exports = {
   require: {
-    Rx: require('rx')
-  },
-
-  globals: {
-    $: require('jquery')
+    // Make 'my-library' available when examples call require('my-library')
+    'my-library': require('./index.js'),
+    'lodash': require('lodash')
   }
-}
+};
 ```
 
-Anything exported under `require` will then be used by any examples that `require` that key.
-You must explicitly configure all of the dependencies used in your examples.
+### Global Variables
 
-Anything exported under `globals` will be available globally across all examples.
+Define global variables available to all snippets:
 
-You can also specify a regexRequire section to handle anything more complex than an exact string match!
-
-<!-- skip-example -->
-```js
-// .doccident-setup.js
+```javascript
 module.exports = {
-  require: {
-    Rx: require('rx')
-  },
-
-  regexRequire: {
-    'rx/(.*)': function (fullPath, matchedModuleName) {
-      return require('./dist/' + matchedModuleName);
-    }
+  globals: {
+    $: require('jquery'),
+    window: {}
   }
-}
+};
 ```
 
-Do I have to enable es6 support?
----
+### Advanced Configuration
 
-Nope, ES6 support is on by default. You can disable `babel` support
-in your `.doccident-setup.js` file.
-This will speed things up drastically:
+*   **`regexRequire`**: Handle dynamic requires that match a pattern.
+*   **`beforeEach`**: Function to run before each snippet (e.g., to reset global state).
+*   **`transformCode`**: Pre-process code before execution (e.g., to strip out display-only syntax).
 
-<!-- skip-example -->
-```js
-//.doccident-setup.js
-module.exports = {
-  babel: false
-}
-```
+## Architecture and Approach
 
-What if I have global state that needs to be reset after my examples run?
----
-<!-- skip-example -->
-```js
-//.doccident-setup.js
-module.exports = {
-  beforeEach: function () {
-    // reset your awesome global state
-  }
-}
-```
+`doccident` is designed to be a lightweight, flexible testing harness for documentation. The codebase is modularized to separate parsing, execution, and reporting, ensuring maintainability and extensibility.
 
-You can specify a function to be run before each example in your `.doccident-setup.js`.
+### Core Modules
 
-What if I want to remove custom syntax from examples before processing?
----
+1.  **Parser (`src/parse-code-snippets-from-markdown.ts`)**
+    *   Reads Markdown content line-by-line.
+    *   Uses a robust state machine to identify code fences and control comments (like `skip-example`).
+    *   Extracts valid snippets into structured objects containing code, file paths, and line numbers.
+    *   **TypeScript Support**: Now recognizes `ts` and `typescript` blocks in addition to JS.
 
-<!-- skip-example -->
-```js
-//.doccident-setup.js
-module.exports = {
-  transformCode(code) {
-    // Remove ... from code syntax
-    return code.replace(/\.\.\./g, "");
-  }
-}
-```
+2.  **Test Runner (`src/doctest.ts`)**
+    *   The orchestrator of the application.
+    *   Iterates through parsed snippets and manages the execution lifecycle.
+    *   **Sandboxing**: Uses Node.js's `vm` module (`runInNewContext`) to execute code in isolation. This prevents examples from polluting the global scope of the runner itself, while allowing controlled injection of dependencies via the configuration.
+    *   **Transformation**: Uses **esbuild** to compile modern JavaScript and TypeScript code down to a compatible format before execution. This ensures that modern syntax and type annotations run correctly in all environments, and is significantly faster than the previous Babel implementation.
+
+3.  **Reporter (`src/reporter.ts`)**
+    *   Collects execution results (pass, fail, skip).
+    *   Formats output using `chalk` for readability.
+    *   **Error Mapping**: Crucially, it maps execution errors back to the specific line number in the original Markdown file, making it easy to identify exactly which line in your documentation caused the failure.
+
+4.  **Types & Utils**
+    *   Shared interfaces (`src/types.ts`) ensure type safety across the application.
+    *   Utility functions (`src/utils.ts`) provide common helpers.
 
-Who uses doccident?
----
-
-All of these projects either run `doccident` with `npm test` or as part of their CI process:
-
-* [lodash](https://github.com/lodash/lodash)
-* [Moment](https://github.com/moment/momentjs.com)
-* [RxJS](https://github.com/ReactiveX/RxJS)
-* [most](https://github.com/cujojs/most)
-* [xstream](https://github.com/staltz/xstream)
-* [cyclejs/time](https://github.com/cyclejs/time)
-* [rx.schedulers](https://github.com/Reactive-Extensions/rx.schedulers)
-* [rx.priorityqueue](https://github.com/Reactive-Extensions/rx.priorityqueue)
-* [rx.disposables](https://github.com/Reactive-Extensions/rx.disposables)
-* [rx-undoable](https://github.com/Widdershin/rx-undoable)
+This separation of concerns allows `doccident` to be easily extended—for example, by adding new parsers for different documentation formats or custom reporters for CI environments.

package/bin/cmd.js

@@ -5,9 +5,9 @@
 
 const { version } = require('../package');
 const doctest = require('..');
-const program = require('commander');
+const { program } = require('commander');
 const path = require('path');
-const glob = require('glob');
+const fg = require('fast-glob');
 const fs = require('fs');
 const { pathToFileURL } = require('url');
 
@@ -30,15 +30,18 @@ program
     .name('doccident')
     .description('Test all the code in your markdown docs!')
     .version(version, '-v, --version', 'output the current version')
+    .argument('[glob]', 'glob pattern for files to test')
     .helpOption('-h, --help', 'output usage informations')
     .option('-c, --config <path>', 'custom config location', path.join(process.cwd(), '/.doccident-setup.js'))
     .option('--test-output', 'output the test results to the console')
     .parse(process.argv);
 
+const options = program.opts();
+
 // Parse config file
 (async () => {
-    if (program.config) {
-        const configPath = path.resolve(program.config);
+    if (options.config) {
+        const configPath = path.resolve(options.config);
 
         if (fs.existsSync(configPath)) {
             try {
@@ -51,33 +54,31 @@ program
         }
     }
 
-    if (program.testOutput) {
+    if (options.testOutput) {
         config.testOutput = true;
     }
 
     // Resolve files
-    glob(
-        program.args[0] || DEFAULT_GLOB,
-        {
-            ignore: [...config.ignore, ...DEFAULT_IGNORE]
-        },
-        (err, files) => {
-
-            if (err) {
-                console.trace(err);
+    try {
+        const files = await fg(
+            program.args[0] || DEFAULT_GLOB,
+            {
+                ignore: [...config.ignore, ...DEFAULT_IGNORE]
             }
+        );
 
-            // Run tests
-            const results = doctest.runTests(files, config);
+        // Run tests
+        const results = doctest.runTests(files, config);
 
-            console.log('\n');
-            doctest.printResults(results);
+        console.log('\n');
+        doctest.printResults(results);
 
-            // Exit with error-code if any test failed
-            const failures = results.filter(result => result.status === 'fail');
-            if (failures.length > 0) {
-                process.exit(1);
-            }
+        // Exit with error-code if any test failed
+        const failures = results.filter(result => result.status === 'fail');
+        if (failures.length > 0) {
+            process.exit(1);
         }
-    );
+    } catch (err) {
+        console.trace(err);
+    }
 })();

package/dist/doctest.js

@@ -1,57 +1,58 @@
-/* eslint-disable no-console */
 "use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.printResults = void 0;
 exports.runTests = runTests;
-exports.printResults = printResults;
-var fs_1 = require("fs");
-var vm_1 = require("vm");
-var core_1 = require("@babel/core");
-var preset_env_1 = require("@babel/preset-env");
-var chalk_1 = require("chalk");
-function flatten(arr) {
-    return Array.prototype.concat.apply([], arr);
-}
-var parse_code_snippets_from_markdown_1 = require("./parse-code-snippets-from-markdown");
+const fs_1 = require("fs");
+const vm_1 = require("vm");
+const esbuild_1 = require("esbuild");
+const chalk_1 = __importDefault(require("chalk"));
+const utils_1 = require("./utils");
+const parse_code_snippets_from_markdown_1 = __importDefault(require("./parse-code-snippets-from-markdown"));
+const reporter_1 = require("./reporter");
+Object.defineProperty(exports, "printResults", { enumerable: true, get: function () { return reporter_1.printResults; } });
 function runTests(files, config) {
-    var results = files
+    const results = files
         .map(read)
         .map(parse_code_snippets_from_markdown_1.default)
         .map(testFile(config));
-    return flatten(results);
+    return (0, utils_1.flatten)(results);
 }
 function read(fileName) {
-    return { contents: (0, fs_1.readFileSync)(fileName, "utf8"), fileName: fileName };
+    return { contents: (0, fs_1.readFileSync)(fileName, "utf8"), fileName };
 }
 function makeTestSandbox(config) {
     function sandboxRequire(moduleName) {
-        for (var regexRequire in config.regexRequire) {
-            var regex = new RegExp(regexRequire);
-            var match = regex.exec(moduleName);
-            var handler = config.regexRequire[regexRequire];
+        for (const regexRequire in config.regexRequire) {
+            const regex = new RegExp(regexRequire);
+            const match = regex.exec(moduleName);
+            const handler = config.regexRequire[regexRequire];
             if (match) {
-                return handler.apply(void 0, match);
+                return handler(...match);
             }
         }
-        if (config.require[moduleName] === undefined) {
+        if (config.require === undefined || config.require[moduleName] === undefined) {
             throw moduleNotFoundError(moduleName);
         }
         return config.require[moduleName];
     }
-    var sandboxConsole = {
-        log: function () { return null; },
+    const sandboxConsole = {
+        log: () => null,
     };
-    var sandboxGlobals = { require: sandboxRequire, console: config.testOutput ? console : sandboxConsole };
-    var sandbox = Object.assign({}, sandboxGlobals, config.globals);
+    const sandboxGlobals = { require: sandboxRequire, console: config.testOutput ? console : sandboxConsole };
+    const sandbox = Object.assign({}, sandboxGlobals, config.globals);
     return sandbox;
 }
 function testFile(config) {
     return function testFileWithConfig(args) {
-        var codeSnippets = args.codeSnippets;
-        var fileName = args.fileName;
-        var shareCodeInFile = args.shareCodeInFile;
-        var results;
+        const codeSnippets = args.codeSnippets;
+        const fileName = args.fileName;
+        const shareCodeInFile = args.shareCodeInFile;
+        let results;
         if (shareCodeInFile) {
-            var sandbox = makeTestSandbox(config);
+            const sandbox = makeTestSandbox(config);
             results = codeSnippets.map(test(config, fileName, sandbox));
         }
         else {
@@ -60,99 +61,58 @@ function testFile(config) {
         return results;
     };
 }
-function test(config, filename, sandbox) {
-    return function (codeSnippet) {
+function test(config, _filename, sandbox) {
+    return (codeSnippet) => {
         if (codeSnippet.skip) {
-            return { status: "skip", codeSnippet: codeSnippet, stack: "" };
+            return { status: "skip", codeSnippet, stack: "" };
         }
-        var success = false;
-        var stack = "";
-        var code = codeSnippet.code;
+        let success = false;
+        let stack = "";
+        let code = codeSnippet.code;
         if (config.transformCode) {
             try {
                 code = config.transformCode(code);
             }
             catch (e) {
-                return { status: "fail", codeSnippet: codeSnippet, stack: "Encountered an error while transforming snippet: \n" + e.stack };
+                return { status: "fail", codeSnippet, stack: "Encountered an error while transforming snippet: \n" + e.stack };
             }
         }
-        var perSnippetSandbox;
+        let perSnippetSandbox;
         if (sandbox === undefined) {
             perSnippetSandbox = makeTestSandbox(config);
         }
         if (config.beforeEach) {
             config.beforeEach();
         }
-        var options = {
-            presets: [preset_env_1.default],
-        };
         try {
-            if (config.babel !== false) {
-                code = (0, core_1.transformSync)(code, options).code;
-            }
+            const result = (0, esbuild_1.transformSync)(code, {
+                loader: 'ts',
+                format: 'cjs',
+                target: 'node12'
+            });
+            code = result.code || "";
             (0, vm_1.runInNewContext)(code, perSnippetSandbox || sandbox);
             success = true;
         }
         catch (e) {
             stack = e.stack || "";
         }
-        var status = success ? "pass" : "fail";
+        const status = success ? "pass" : "fail";
         process.stdout.write(success ? chalk_1.default.green(".") : chalk_1.default.red("x"));
-        return { status: status, codeSnippet: codeSnippet, stack: stack };
+        return { status, codeSnippet, stack };
     };
 }
-function printResults(results) {
-    results.filter(function (result) { return result.status === "fail"; }).forEach(printFailure);
-    var passingCount = results.filter(function (result) { return result.status === "pass"; })
-        .length;
-    var failingCount = results.filter(function (result) { return result.status === "fail"; })
-        .length;
-    var skippingCount = results.filter(function (result) { return 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 - ".concat(markDownErrorLocation(result))));
-    var stackDetails = relevantStackDetails(result.stack);
-    console.log(stackDetails);
-    var variableNotDefined = stackDetails.match(/(\w+) is not defined/);
-    if (variableNotDefined) {
-        var variableName = variableNotDefined[1];
-        console.log("You can declare ".concat(chalk_1.default.blue(variableName), " in the ").concat(chalk_1.default.blue("globals"), " section in ").concat(chalk_1.default.grey(".doccident-setup.js")));
-        console.log("\nFor example:\n".concat(chalk_1.default.grey("// .doccident-setup.js"), "\nmodule.exports = {\n  globals: {\n    ").concat(chalk_1.default.blue(variableName), ": ...\n  }\n}\n    "));
-    }
-}
-function relevantStackDetails(stack) {
-    var match = stack.match(/([\w\W]*?)at eval/) ||
-        // eslint-disable-next-line no-useless-escape
-        stack.match(/([\w\W]*)at [\w*\/]*?doctest.js/);
-    if (match !== null) {
-        return match[1];
-    }
-    return stack;
-}
 function moduleNotFoundError(moduleName) {
-    return new Error("\nAttempted to require '".concat(chalk_1.default.blue(moduleName), "' but was not found in config.\nYou need to include it in the require section of your ").concat(chalk_1.default.grey(".doccident-setup.js"), " file.\n\nFor example:\n").concat(chalk_1.default.grey("// .doccident-setup.js"), "\nmodule.exports = {\n  require: {\n    ").concat(chalk_1.default.blue("'".concat(moduleName, "': require('").concat(moduleName, "')")), "\n  }\n}\n  "));
+    return new Error(`
+Attempted to require '${chalk_1.default.blue(moduleName)}' but was not found in config.
+You need to include it in the require section of your ${chalk_1.default.grey(".doccident-setup.js")} file.
+
+For example:
+${chalk_1.default.grey("// .doccident-setup.js")}
+module.exports = {
+  require: {
+    ${chalk_1.default.blue(`'${moduleName}': require('${moduleName}')`)}
+  }
 }
-function markDownErrorLocation(result) {
-    var match = result.stack.match(/eval.*<.*>:(\d+):(\d+)/);
-    if (match) {
-        var mdLineNumber = parseInt(match[1], 10);
-        var columnNumber = parseInt(match[2], 10);
-        var lineNumber = result.codeSnippet.lineNumber + mdLineNumber;
-        return "".concat(result.codeSnippet.fileName, ":").concat(lineNumber, ":").concat(columnNumber);
-    }
-    return "".concat(result.codeSnippet.fileName, ":").concat(result.codeSnippet.lineNumber);
+  `);
 }

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

@@ -1,35 +1,29 @@
 "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 -->";
-};
+const isStartOfSnippet = (line) => line.trim().match(/```\W*(JavaScript|js|es6|ts|typescript)\s?$/i);
+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) {
-    var skip = snippets.skip;
+    const skip = snippets.skip;
     snippets.skip = false;
     return Object.assign(snippets, {
         snippets: snippets.snippets.concat([
-            { code: "", fileName: fileName, lineNumber: lineNumber, complete: false, skip: skip }
+            { code: "", fileName, lineNumber, complete: false, skip: skip ?? false }
         ])
     });
 }
 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";
         }
         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;
     }
@@ -59,27 +53,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.3",
   "description": "Test all the code in your markdown docs!",
   "main": "dist/doctest.js",
   "files": [
@@ -12,8 +12,8 @@
   },
   "scripts": {
     "build": "tsc",
-    "lint": "eslint . --ext .ts",
-    "test": "jest",
+    "lint": "eslint .",
+    "test": "vitest run",
     "precommit": "npm run lint && npm run test",
     "clean": "rm -rf dist",
     "prepublishOnly": "npm run clean && npm run build"
@@ -37,29 +37,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"
-    ]
   }
 }