@doccident/doccident 0.0.4 → 0.0.6

package/LICENSE

@@ -1,9 +1,202 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   Copyright (c) 2025 Billaud Cipher
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+
+--------------------------------------------------------------------------------
+
+This project is based on work originally licensed under the MIT License:
+
 The MIT License (MIT)
 
 Copyright (c) 2015 Nick Johnstone
 
-Copyright (c) 2025 Billaud Cipher
-
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
 in the Software without restriction, including without limitation the rights
@@ -21,4 +214,3 @@ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 SOFTWARE.
-

package/README.md

@@ -9,6 +9,12 @@
 
 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 code blocks for multiple languages, and executes them in a sandboxed environment to verify they run without errors.
 
+### The "Why"
+
+This project was born out of frustration. The author once wrote a massive technical book, only to be haunted by the realization that subtle bugs had crept into the code examples and output listings during the editing process. 
+
+`doccident` solves this by automating the verification of your documentation. It doesn't just check if your code compiles; it can **execute** your snippets and **verify their output** matches what you claim in your docs. This "living documentation" approach guarantees that your readers always see correct, working code and accurate output.
+
 **Supported Languages:**
 *   JavaScript (Node.js)
 *   TypeScript
@@ -19,6 +25,12 @@ As an open source developer, few things are more frustrating for users than enco
 *   Fortran
 *   COBOL
 *   C
+*   BASIC
+*   Java
+*   Perl
+*   C#
+*   R
+*   Pascal
 
 > **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.
 
@@ -45,6 +57,17 @@ You can also target specific files or directories:
 npx doccident docs/**/*.md
 ```
 
+### Timeout
+
+By default, each code snippet has a 5-minute (300,000ms) timeout to prevent infinite loops or hangs. You can customize this with the `--timeout` flag (in milliseconds):
+
+<!-- skip-example -->
+```bash
+npx doccident --timeout 60000  # 60 second timeout
+```
+
+If a snippet exceeds the timeout, it will fail with an error message indicating the timeout was reached.
+
 ### Language Support & Recipes
 
 `doccident` executes code inside fenced code blocks for the following languages:
@@ -58,6 +81,13 @@ npx doccident docs/**/*.md
 *   **Fortran**: `fortran`, `f90`, `f95`
 *   **COBOL**: `cobol`, `cob`
 *   **C**: `c`
+*   **BASIC**: `basic`
+*   **Java**: `java`
+*   **Perl**: `perl`, `pl`
+*   **C#**: `csharp`, `cs`
+*   **R**: `r`
+*   **Pascal**: `pascal`, `pas`
+*   **Text/Output**: `text`, `txt`, `output` (for output verification)
 
 It automatically transforms modern JavaScript and TypeScript using **esbuild** before execution.
 
@@ -167,9 +197,10 @@ Writes code to a temporary file and executes it via `go run`.
 1.  Use `go` fenced code blocks.
 2.  You can provide a full program (including `package main`) OR a simple snippet.
 3.  Simple snippets (without `package main`) are automatically wrapped in a `main` function and include `import "fmt"`.
-4.  **Note**: `<!-- share-code-between-examples -->` is **not** supported for Go.
+4.  **Note**: `<!-- share-code-between-examples -->` is supported for Go snippets (auto-wrapped). Declarations (`func`, `type`, `import`) are extracted to top-level.
 
     **Simple Snippet:**
+    <!-- skip-example -->
     ```go
     fmt.Println("Hello Go")
     ```
@@ -191,9 +222,10 @@ Compiles the code using `rustc` into a temporary binary, then executes the binar
 1.  Use `rust` fenced code blocks.
 2.  You can provide a full program (including `fn main()`) OR a simple snippet.
 3.  Simple snippets (without `fn main`) are automatically wrapped in a `main` function.
-4.  **Note**: `<!-- share-code-between-examples -->` is **not** supported for Rust.
+4.  **Note**: `<!-- share-code-between-examples -->` is supported for Rust. Attributes like `#![...]` and `extern crate` are hoisted to the crate root. Other code is wrapped in `fn main()`.
 
     **Simple Snippet:**
+    <!-- skip-example -->
     ```rust
     println!("Hello Rust");
     let x = 5;
@@ -217,9 +249,10 @@ Compiles the code using `gfortran` into a temporary binary, then executes the bi
 1.  Use `fortran` fenced code blocks.
 2.  You can provide a full program (starting with `program name`) OR a simple snippet.
 3.  Simple snippets are automatically wrapped in a `program main ... end program main` block.
-4.  **Note**: `<!-- share-code-between-examples -->` is **not** supported for Fortran.
+4.  **Note**: `<!-- share-code-between-examples -->` is supported for Fortran. Modules are extracted to the top level; `use` statements are moved to the top of `program main`.
 
     **Simple Snippet:**
+    <!-- skip-example -->
     ```fortran
     print *, "Hello Fortran"
     ```
@@ -243,6 +276,7 @@ Compiles the code using `cobc -x -free` into a temporary executable, then runs i
 3.  The compiler is run in free-format mode (`-free`).
 4.  **Note**: `<!-- share-code-between-examples -->` is **not** supported for COBOL.
 
+    <!-- skip-example -->
     ```cobol
     IDENTIFICATION DIVISION.
     PROGRAM-ID. HELLO.
@@ -268,13 +302,186 @@ Compiles the code using `gcc` into a temporary binary, then executes the binary.
 1.  Use `c` fenced code blocks.
 2.  You can provide a full program (including `main()`) OR a simple snippet.
 3.  Simple snippets are automatically wrapped in a `main` function and include `stdio.h`.
-4.  **Note**: `<!-- share-code-between-examples -->` is **not** supported for C.
+4.  **Note**: `<!-- share-code-between-examples -->` is supported for C. Includes and definitions (`struct`, `func`) are hoisted; statements are placed in `main()`.
 
     **Simple Snippet:**
     ```c
     printf("Hello C\n");
     ```
 
+#### BASIC
+
+Use `basic` for BASIC examples.
+
+**Prerequisites:**
+*   `cbmbasic` must be installed and available in your system path.
+    *   **macOS**: `brew install cbmbasic`
+    *   **Ubuntu/Debian**: Build from source (see `test.yml` for example).
+
+**Execution Model:**
+Spawns a `cbmbasic` subprocess with the code piped to stdin.
+
+**Recipe:**
+
+1.  Use `basic` fenced code blocks.
+2.  Write standard Commodore BASIC V2 code.
+3.  State can be shared between blocks using `<!-- share-code-between-examples -->`.
+
+    <!-- skip-example -->
+    ```basic
+    10 PRINT "HELLO BASIC"
+    20 END
+    ```
+
+#### Java
+
+Use `java` for Java examples.
+
+**Prerequisites:**
+*   `javac` and `java` must be installed and available in your system path.
+    *   **macOS**: `brew install openjdk`
+    *   **Ubuntu/Debian**: `sudo apt-get install default-jdk`
+
+**Execution Model:**
+Compiles the code using `javac` into a temporary class file in a unique directory, then executes it with `java`.
+
+**Recipe:**
+
+1.  Use `java` fenced code blocks.
+2.  You can provide a full class (e.g. `public class MyClass { ... }`) OR a simple snippet.
+3.  Simple snippets are automatically wrapped in a `public class Main { public static void main(String[] args) { ... } }`.
+4.  **Note**: `<!-- share-code-between-examples -->` is **not** supported for Java.
+
+    **Simple Snippet:**
+    <!-- skip-example -->
+    ```java
+    System.out.println("Hello Java");
+    ```
+
+    **Full Class:**
+    <!-- skip-example -->
+    ```java
+    public class Greeting {
+        public static void main(String[] args) {
+            System.out.println("Hello from Greeting class");
+        }
+    }
+    ```
+
+#### Perl
+
+Use `perl` or `pl` for Perl examples.
+
+**Prerequisites:**
+*   `perl` must be installed and available in your system path.
+    *   **macOS**: Pre-installed or `brew install perl`
+    *   **Ubuntu/Debian**: Pre-installed or `sudo apt-get install perl`
+
+**Execution Model:**
+Spawns a `perl` subprocess with the code piped to stdin.
+
+**Recipe:**
+
+1.  Use `perl` fenced code blocks.
+2.  Standard library imports work out of the box.
+3.  State can be shared between blocks using `<!-- share-code-between-examples -->`.
+
+    ```perl
+    print "Hello Perl\n";
+    ```
+
+#### C#
+
+Use `csharp` or `cs` for C# examples.
+
+**Prerequisites:**
+*   `mono` (includes `mcs` compiler) must be installed and available in your system path.
+    *   **macOS**: `brew install mono`
+    *   **Ubuntu/Debian**: `sudo apt-get install mono-devel`
+
+**Execution Model:**
+Compiles the code using `mcs` into a temporary executable, then runs it with `mono`.
+
+**Recipe:**
+
+1.  Use `csharp` fenced code blocks.
+2.  You can provide a full class (e.g. `public class Program { ... }`) OR a simple snippet.
+3.  Simple snippets are automatically wrapped in a `public class Program { public static void Main(string[] args) { ... } }` and include `using System;`.
+4.  **Note**: `<!-- share-code-between-examples -->` is **not** supported for C#.
+
+    **Simple Snippet:**
+    <!-- skip-example -->
+    ```csharp
+    Console.WriteLine("Hello C#");
+    ```
+
+    **Full Class:**
+    <!-- skip-example -->
+    ```csharp
+    using System;
+    public class Test {
+        public static void Main(string[] args) {
+            Console.WriteLine("Hello from Test class");
+        }
+    }
+    ```
+
+#### R
+
+Use `r` for R examples.
+
+**Prerequisites:**
+*   `Rscript` must be installed and available in your system path.
+    *   **macOS**: `brew install r`
+    *   **Ubuntu/Debian**: `sudo apt-get install r-base`
+
+**Execution Model:**
+Spawns an `Rscript` subprocess with the code piped to stdin.
+
+**Recipe:**
+
+1.  Use `r` fenced code blocks.
+2.  Standard R syntax works out of the box.
+3.  State can be shared between blocks using `<!-- share-code-between-examples -->`.
+
+    ```r
+    print("Hello R")
+    ```
+
+#### Pascal
+
+Use `pascal` or `pas` for Pascal examples.
+
+**Prerequisites:**
+*   `fpc` (Free Pascal Compiler) must be installed and available in your system path.
+    *   **macOS**: `brew install fpc`
+    *   **Ubuntu/Debian**: `sudo apt-get install fpc`
+
+**Execution Model:**
+Compiles the code using `fpc` into a temporary executable, then runs it.
+
+**Recipe:**
+
+1.  Use `pascal` fenced code blocks.
+2.  You can provide a full program (including `program Name;`) OR a simple snippet.
+3.  Simple snippets are automatically wrapped in a `program TestProgram; begin ... end.` block.
+4.  **Note**: `<!-- share-code-between-examples -->` is **not** supported for Pascal.
+
+    **Simple Snippet:**
+    <!-- skip-example -->
+    ```pascal
+    writeln('Hello Pascal');
+    ```
+
+    **Full Program:**
+    <!-- skip-example -->
+    ```pascal
+    program Hello;
+    begin
+        writeln('Hello from Pascal program');
+    end.
+    ```
+
 ### Skipping Examples
 
 To skip a specific code block, add the `<!-- skip-example -->` comment immediately before it:
@@ -289,7 +496,7 @@ To skip a specific code block, add the `<!-- skip-example -->` comment immediate
 
 By default, each code block is executed in isolation. To share state (variables, functions, classes) between multiple code blocks in the same file, add the `<!-- share-code-between-examples -->` comment. This applies to the entire file.
 
-> **Note**: This feature is currently supported for JavaScript, TypeScript, Python, and Shell, but **not** compiled languages like Go, Rust, Fortran, COBOL, and C.
+> **Note**: This feature is currently supported for JavaScript, TypeScript, Python, Shell, BASIC, Perl, R, Go, Rust, Fortran, and C, but **not** compiled languages like COBOL, Java, C#, and Pascal.
 
     <!-- share-code-between-examples -->
 
@@ -302,6 +509,93 @@ By default, each code block is executed in isolation. To share state (variables,
     assert x == 10
     ```
 
+### Configuration Comments
+
+You can configure execution behavior for specific snippets using comments immediately preceding the code block.
+
+**Arguments:** Pass arguments to the compiler or interpreter.
+
+    <!-- args: -v -->
+    ```python
+    import sys
+    print("Running with verbose output")
+    ```
+
+**Environment Variables:** Set environment variables for the execution.
+
+    <!-- env: API_KEY=secret123 MODE=test -->
+    ```bash
+    echo "Key: $API_KEY"
+    ```
+
+### Output Verification
+
+You can verify that a code snippet produces specific output by assigning it an ID and then referencing that ID in a subsequent block.
+
+1.  Assign an ID to the code snippet using `<!-- id: my-snippet-name -->`.
+2.  Create an output block (usually `text` or `json`) and reference the ID using `<!-- output: my-snippet-name -->`.
+
+`doccident` will execute the first snippet, capture its stdout, and verify that it matches the content of the output block.
+
+**Example:**
+
+    <!-- id: hello-world -->
+    ```js
+    console.log("Hello Output");
+    ```
+
+    <!-- output: hello-world -->
+    ```text
+    Hello Output
+    ```
+
+This is useful for ensuring your documentation's "Output:" sections stay in sync with the actual code behavior.
+
+### Output Matching Modes
+
+When verifying output, you can optionally specify a matching mode to handle whitespace or dynamic content.
+
+*   `exact` (default): Exact string match (trailing whitespace is trimmed).
+*   `ignore-whitespace`: Collapses all whitespace sequences to a single space and trims ends before comparing.
+*   `match:regex`: Treats the output block content as a regular expression.
+
+**Examples:**
+
+**Ignore Whitespace:**
+
+    <!-- id: fuzzy-output -->
+    ```js
+    console.log("  A   B  \n  C  ");
+    ```
+
+    <!-- output: fuzzy-output ignore-whitespace -->
+    ```text
+    A B C
+    ```
+
+**Regex Matching:**
+
+    <!-- id: dynamic-output -->
+    ```js
+    console.log("Timestamp: " + Date.now());
+    ```
+
+    <!-- output: dynamic-output match:regex -->
+    ```text
+    ^Timestamp: \d+$
+    ```
+
+### Updating Output (Snapshots)
+
+If you want `doccident` to automatically update your output blocks with the actual output from execution, run with the `--update-output` flag.
+
+<!-- skip-example -->
+```bash
+npx doccident --update-output
+```
+
+This will replace the content of any `<!-- output: ... -->` block with the latest captured output from the corresponding ID. This is extremely useful when writing documentation: you can write the code example, add a placeholder output block, and let `doccident` fill it in for you.
+
 ## Configuration
 
 Create a `.doccident-setup.js` file in your project root to configure the test environment.
@@ -310,6 +604,7 @@ Create a `.doccident-setup.js` file in your project root to configure the test e
 
 If your examples use external libraries, provide them here. This allows your examples to `require` modules just like users would:
 
+<!-- skip-example -->
 ```javascript
 // .doccident-setup.js
 module.exports = {
@@ -325,6 +620,7 @@ module.exports = {
 
 Define global variables available to all snippets:
 
+<!-- skip-example -->
 ```javascript
 module.exports = {
   globals: {
@@ -350,13 +646,13 @@ module.exports = {
     *   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.
-    *   **Multi-Language Support**: Recognizes `js`, `ts`, `python`, `shell`, `go`, `rust`, `fortran`, `cobol`, and `c` blocks.
+    *   **Multi-Language Support**: Recognizes `js`, `ts`, `python`, `shell`, `go`, `rust`, `fortran`, `cobol`, `c`, `basic`, `java`, `perl`, `csharp`, `r`, and `pascal` blocks.
 
 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 JS/TS code in isolation.
-    *   **Subprocess Execution**: Spawns `python3`, `go`, `rustc`, `gfortran`, `cobc`, `gcc`, or shell subprocesses for non-JS languages.
+    *   **Subprocess Execution**: Spawns `python3`, `go`, `rustc`, `gfortran`, `cobc`, `gcc`, `cbmbasic`, `javac`/`java`, `perl`, `mcs`/`mono`, `Rscript`, `fpc`, or shell subprocesses for non-JS languages.
     *   **Transformation**: Uses **esbuild** to compile modern JavaScript and TypeScript code down to a compatible format before execution.
 
 3.  **Reporter (`src/reporter.ts`)**
@@ -369,3 +665,33 @@ module.exports = {
     *   Utility functions (`src/utils.ts`) provide common helpers.
 
 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.
+
+## License & History
+
+This project is licensed under the Apache License, Version 2.0.
+
+Copyright (c) 2025 Tim O'Brien
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+
+---
+
+**Note**: This project was originally forked from [markdown-doctest](https://github.com/nick-johnstone/markdown-doctest) by Nick Johnstone. While the original inspiration and some core concepts remain, the **entire codebase has been replaced** and significantly expanded by Tim O'Brien to support a wide range of compiled and interpreted languages, shared state mechanisms, and output verification. All subsequent additions and modifications are covered by the Apache 2.0 Software License.
+
+## Agentic AI Guide
+
+This repository contains a dedicated guide for AI agents to understand how to use `doccident`. If you are an AI model tasked with maintaining this project or using it to verify documentation, please refer to:
+
+[**doccident/guide/index.md**](./guide/index.md)
+
+This directory contains instructions on capabilities, verification workflows, and configuration specifically structured for machine consumption.