testeranto 0.146.2 → 0.146.5

package/docs.html

@@ -19,7 +19,7 @@
     <div class="parallax-background"></div>
     <div id="container">
         <h1>Testeranto docs and core concepts</h1>
-<p>Testeranto&#39;s type system provides a rigorous framework for Behavior-Driven Development (BDD) testing. While powerful, the API can initially seem complex but everything you need to know can be summed up in <strong>3 core functions and 5 essential types</strong>. Follow these patterns, and TypeScript&#39;s type checker will guide you through the rest.</p>
+<p>Testeranto&#39;s type system provides a rigorous framework for Behavior-Driven Development (BDD) testing. The API may seem complex but everything you need to know can be summed up in <strong>1 function, 3 runtimes and 5 essential types, and 1 optional type</strong>. Follow these patterns, and TypeScript&#39;s type checker will guide you through the rest.</p>
 <h3>⚠️ this doc is a work in progress. It is 99% accurate but needs some attention to be complete. ⚠️</h3>
 <p>Let&#39;s break down the key components using a Rectangle class example.</p>
 <h3>The Test Subject</h3>
@@ -36,12 +36,24 @@
   getArea() {
     return this.width * this.height;
   }
-}</code></pre><h3>Testeranto&#39;s 3 functions</h3>
+}</code></pre><h3>Testeranto&#39;s 1 function</h3>
+<p>Testeranto has 1 function. This function launches and runs the tests. It is here that all 5 types converge and if you can type this function call correctly, the TS type system should guide you through the rest.</p>
+<pre>async <I extends Ibdd_in_any, O extends Ibdd_out, M>(
+  input: I["iinput"],
+  testSpecification: ITestSpecification<I, O>,
+  testImplementation: ITestImplementation<I, O, M>,
+  testInterface: Partial<ITestInterface<I>>,
+  testResourceRequirement: ITTestResourceRequest = defaultTestResourceRequirement
+): Promise<Testeranto<I, O, M>></pre><h3>Testeranto&#39;s 3 runtimes</h3>
 <p>For each of testeranto&#39;s runtime, there is a specific Testeranto main function. Each is it&#39;s own import but all 3 are called in the same way.</p>
 <h4>Node</h4>
 <pre>import Testeranto from "testeranto/src/Node"; // <- import the Node main function
 // below this point, all runtimes are identical!
 
+import { implementation } from "./Rectangle.test.implementation";
+import { specification } from "./Rectangle.test.specification";
+import { interface } from "./Rectangle.test.interface";
+
 // Note the type parameters I, O, and M: these will be important later
 export default Testeranto<
   I extends Ibdd_in,
@@ -88,36 +100,15 @@ export default Testeranto<
     specification,
     implementation,
     interface
-);</pre><h3>Testeranto&#39;s 5 Essential Types</h3>
-<p>Every testeranto test is built around these 5 types that form a complete testing pipeline:</p>
-<ol>
-<li><strong>ITestSpecification</strong> - The &quot;what&quot; of your tests (business requirements)</li>
-<li><strong>ITestImplementation</strong> - The &quot;how&quot; of your tests (concrete operations)</li>
-<li><strong>ITestInterface</strong> - The &quot;glue&quot; between specs and implementation</li>
-<li><strong>Ibdd_in</strong> - Defines the internal test flow shape</li>
-<li><strong>Ibdd_out</strong> - Defines the external test interface</li>
-</ol>
-<pre class="mermaid">flowchart LR
-    S[ITestSpecification] -->|defines| O[Ibdd_out]
-    I[ITestImplementation] -->|uses| O
-    I -->|uses| M[Modifier]
-    T[ITestInterface] -->|connects| N[Ibdd_in]
-    S -->|flows through| N
-    I -->|flows through| N
-
-    style S fill:#2aa198,stroke:#073642
-    style I fill:#859900,stroke:#073642
-    style T fill:#b58900,stroke:#073642
-    style O fill:#d33682,stroke:#073642
-    style N fill:#cb4b16,stroke:#073642
-    style M fill:#6c71c4,stroke:#073642</pre><h4>The Specification (ITestSpecification)</h4>
+);</pre><h3>Testeranto&#39;s 5 essential types</h3>
+<p>Every testeranto test is built around these 5 types that form a complete testing pipeline.</p>
+<h4>The Specification (ITestSpecification)</h4>
 <p>The Specification defines the business requirements in plain language, completely separate from implementation details. This is where you describe <strong>what</strong> should be tested without worrying about <strong>how</strong>.</p>
 <ul>
 <li>Pure business logic</li>
 <li>Human-readable test descriptions</li>
 <li>Defines test suites, scenarios (Given/When/Then)</li>
 <li>Maps directly to BDD concepts</li>
-<li>Uses Ibdd_out for type safety</li>
 </ul>
 <pre class="language-typescript line-numbers"><code class="language-typescript">import {
   Ibdd_in,
@@ -220,9 +211,8 @@ export const implementation: ITestImplementation<
     Default: () => new Rectangle(2, 2),
   },
 };</pre><h4>The Interface aka ITestInterface</h4>
-<p>The test interface is code which is NOT BDD . The interface adapts your test subject so that the BDD hooks can be applied. The interface implements the traditional BDD steps &quot;before all&quot;, &quot;after all&quot;, &quot;before each&quot;, &quot;after each&quot;, etc</p>
-<pre>
-import {
+<p>The test interface is code which is NOT business logic. The interface adapts your test subject so that the BDD hooks can be applied. The interface implements the traditional BDD steps &quot;before all&quot;, &quot;after all&quot;, &quot;before each&quot;, &quot;after each&quot;, etc</p>
+<pre>import {
   Ibdd_in,
   ITestInterface,
 } from "testeranto/src/CoreTypes";
@@ -246,7 +236,7 @@ export const testInterface: ITestInterface<
   afterAll: () => {},
   assertThis: (x: any, y) => {},
 };</pre><h4>type I aka Ibdd_in</h4>
-<p>this type describes the &quot;inner&quot; shape of your BDD tests.</p>
+<p>This type describes the &quot;inner&quot; shape of your BDD tests. Over the course of the execution of the test, the subject will change shapes- this test describe those changes.</p>
 <pre>import { Ibdd_in } from "testeranto/src/CoreTypes";
 
 // TODO this is inaccurate
@@ -259,7 +249,7 @@ export type I = Ibdd_in<
   (...x) => (rectangle: Rectangle, utils: IPM) => Rectangle,
   (rectangle: Rectangle, utils: IPM) => Rectangle
 >;</pre><h4>type O aka Ibdd_out</h4>
-<p>this type describes the &quot;outer&quot; shape of your BDD tests.</p>
+<p>This type describes the &quot;outer&quot; shape of your BDD tests. This type describes the set of legal BDD clauses.</p>
 <pre>import { Ibdd_out } from "testeranto/src/CoreTypes";
 
 export type O = Ibdd_out<
@@ -295,7 +285,8 @@ export type O = Ibdd_out<
     WidthOfOneAndHeightOfOne;
     WidthAndHeightOf: [number, number];
   }
->;</pre><h4>type M (optional)</h4>
+>;</pre><h3>Testeranto&#39;s 1 optional type</h3>
+<h4>type M (optional)</h4>
 <p>this type describes the modifications to the shape of the &quot;specification&quot;. It can be used to make your BDD tests DRYer but is not necessary</p>
 <pre>export type M = {
   givens: {
@@ -515,7 +506,18 @@ export default Testeranto<
 );
 
 
-</pre>
+</pre><h2>Trouble shooting</h2>
+<h3>Double check your runtimes.</h3>
+<p>Every test has a runtime, which must defined in 2 places. Both must match.</p>
+<ol>
+<li>The import of the runtime</li>
+<li>The runtime defined alongside the test in testeranto.config.ts</li>
+</ol>
+<p>By convention, test filenames reveal their runtime. Ex: <code>__tests__/yourClass.node.test</code>. This is ONLY a convention. It has no real bearing on the runtime.</p>
+<h2>Dos and Don&#39;ts</h2>
+<h3>Do pass your test subject to the main testeranto function.</h3>
+<h3>Don&#39;t import your test subject elsewhere in your tests.</h3>
+
     </div>
     <!-- Prism.js JS -->
     <script src="https://cdnjs.cloudflare.com/ajax/libs/prism/1.29.0/prism.min.js"></script>

package/index.html

@@ -20,24 +20,24 @@
     <div id="container">
         <h1>testeranto</h1>
 <h2>The AI-powered BDD test framework for TypeScript projects</h2>
-<h4>🚧 WARNING: Testeranto is still under development and is not ready for production yet. 🚧</h4>
+<h4>🚧 WARNING: Testeranto is still under development but is not ready for production yet. I am rapidly working to release a beta ASAP. If you are interested in joining this beta program, please contact me. 🚧</h4>
 <ul>
-<li>README: <a href="https://adamwong246.github.io/testeranto/">index.html</a></li>
+<li>README: <a href="https://adamwong246.github.io/testeranto/testeranto">adamwong246.github.io/testeranto/testeranto</a></li>
 <li>demo: <a href="https://www.youtube.com/embed/WvU5xMqGi6Q">youtube</a></li>
 <li>source: <a href="https://github.com/adamwong246/testeranto">github.com/adamwong246/testeranto</a></li>
 <li>npm: <a href="https://www.npmjs.com/package/testeranto">npmjs.com/package/testeranto</a></li>
-<li>dev: <a href="https://github.dev/adamwong246/testeranto">github.dev/adamwong246/testeranto</a></li>
 <li>example repo: <a href="https://github.com/adamwong246/testeranto-starter">testeranto-starter</a></li>
+<li>tests report: <a href="https://adamwong246.github.io/testeranto/testeranto/index.html">adamwong246.github.io/testeranto/testeranto</a></li>
 </ul>
 <h2>What is testeranto?</h2>
 <ul>
-<li>Testeranto produces test results which can be fed to Aider.ai to automatically fix failing tests.</li>
-<li>Testeranto tests are specified in a strongly-typed gherkin-like syntax. Rather than testing your code directly, Testeranto requires you wrap your code with a semantic interface which is based on TS type signatures.</li>
-<li>Testeranto can run tests in the frontend or the backend, or both.</li>
+<li>Testeranto produces test results that can be fed to Aider.ai to automatically fix failing tests.</li>
+<li>Testeranto tests are specified in a strongly-typed gherkin-like syntax. Rather than testing your code directly, Testeranto requires you to wrap your code with a semantic interface that is based on TS type signatures.</li>
+<li>Testeranto can run tests in the frontend, the backend, or both.</li>
 <li>Testeranto can be used to test anything that can be bundled with esbuild.</li>
 <li>Testeranto connects &quot;features&quot; to &quot;tests&quot;. This allows the AI to read feature documentation from external systems, like Jira.</li>
-<li>Testeranto generates test results into static a website which can be deployed to github pages easily.</li>
-<li>Testeranto uses esbuild to bundle it&#39;s tests. The result is used to refine the list of files added to the context of the AI. <strong>The consequence of this is that you can fit all relevant files, and ONLY the relevant files, into the LLMs context.</strong></li>
+<li>Testeranto generates test results as a static website that can be easily deployed to GitHub Pages.</li>
+<li>Testeranto uses esbuild to bundle its tests. The result is used to refine the list of files added to the AI&#39;s context. <strong>The consequence of this is that you can fit all relevant files, and only the relevant files, into the LLM&#39;s context.</strong></li>
 </ul>
 <h2>Key Technologies</h2>
 <table>
@@ -75,10 +75,6 @@
 <td>tsc</td>
 <td>Type checking of test files</td>
 </tr>
-<tr>
-<td>Markdown</td>
-<td>Feature documentation format</td>
-</tr>
 </tbody></table>
 <h2>Quick Start</h2>
 <ol>
@@ -113,28 +109,24 @@ yarn t-run rectangle.test.ts yourProject dev</pre><p>or build and run your tests
 <thead>
 <tr>
 <th></th>
-<th>Runs on</th>
 <th>You should use this runtime for...</th>
 <th>Important differences</th>
 </tr>
 </thead>
 <tbody><tr>
-<td><strong>Node</strong></td>
-<td>node V8 with fork</td>
+<td><strong>Node</strong> : node V8 with fork</td>
 <td>testing backend code, Node APIs (like <code>fs</code> and <code>crypto</code>), or anything needing filesystem access</td>
 <td>has access to the filesystem and io</td>
 </tr>
 <tr>
-<td><strong>Web</strong></td>
-<td>chrome browser</td>
+<td><strong>Web</strong> : chrome browser</td>
 <td>testing frontend code, anything that uses <code>document</code> or <code>window</code>, UI interactions, or visual regression</td>
 <td>can take screenshots/recordings</td>
 </tr>
 <tr>
-<td><strong>Pure</strong></td>
-<td>node v8, dynamically imported</td>
-<td>testing code which can run on both node-v8 and the the browser</td>
-<td>Very similar to &quot;Node&quot; but has no IO access and thus, no console.log. This runtime is theoretically faster.</td>
+<td><strong>Pure</strong> : node v8, dynamically imported</td>
+<td>testing code that can run on both node-v8 and the browser</td>
+<td>Very similar to &quot;Node&quot; but has no IO access and thus no console.log. This runtime is theoretically faster.</td>
 </tr>
 </tbody></table>
 <h2>CLI Commands</h2>
@@ -185,7 +177,7 @@ yarn t-run test/rectangle.test.ts once
 # Get AI help with failures
 yarn t-aider</pre><h2>Aider</h2>
 <p>Testeranto generates a &quot;prompt&quot; alongside test results. This prompt is passed to aider as input.</p>
-<pre>// input src files which can be edited by aider
+<pre>// input src files that can be edited by Aider
 /add test/node.ts
 
 // test report files that inform aider but should not be edited
@@ -214,18 +206,19 @@ test0: Given.Default(
   [Then.getWidth(4), Then.getHeight(19)]
 ),
 ...
-</code></pre><h2>Sidecars (COMING SOON)</h2>
-<p>Along side your test, you can include a number of &quot;sidecars&quot; which are other bundled javascript assets upon which your test depends. For example, suppose you have an app with a frontend and backend component. You could run a react test in the web and include the node http server as a sidecar.</p>
-<h2><code>eslint</code> and <code>tsc</code></h2>
-<p>Alongside the bdd tests, testeranto runs eslint and tsc upon the input files to generate a list of static analysis errors and a list of type errors, respectively.</p>
+</code></pre><h2><code>eslint</code> and <code>tsc</code></h2>
+<p>Alongside the BDD tests, Testeranto runs ESLint and tsc on the input files to generate a list of static analysis errors and type errors, respectively.</p>
+<hr>
+<h2>Sidecars (COMING SOON)</h2>
+<p>Alongside your test, you can include a number of &quot;sidecars&quot; - other bundled JavaScript assets upon which your test depends. For example, suppose you have an app with frontend and backend components. You could run a React test in the web and include the Node HTTP server as a sidecar.</p>
 <h2>Subprojects</h2>
-<p>Testeranto has a core repo, but there are also subprojects which implement tests by type and by technology</p>
+<p>Testeranto has a core repo, but there are also sub-projects which implement tests by type and by technology</p>
 <h3>testeranto-solidity</h3>
-<p>Test a solidity contract. Also included is an example of deploying a contrct to a ganache server.</p>
+<p>Test a solidity contract. Also included is an example of deploying a contract to a ganache server.</p>
 <h3>testeranto-reduxtoolkit</h3>
-<p>Test a redux store.</p>
+<p>Tests a Redux store.</p>
 <h3>testeranto-http</h3>
-<p>Test a node http server.</p>
+<p>Tests a Node HTTP server.</p>
 <h3>testeranto-react (COMING SOON)</h3>
 <p>Test a react component. You can choose from a variety of types (jsx functions, class style, etc) and you can test with <code>react</code>, <code>react-dom</code>, or <code>react-test-renderer</code></p>
 <h3>testeranto-express (COMING SOON)</h3>

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "testeranto",
   "description": "the AI powered BDD test framework for typescript projects",
-  "version": "0.146.2",
+  "version": "0.146.5",
   "engines": {
     "node": "18.18.0"
   },
@@ -132,7 +132,8 @@
     "t-run": "tsx src/run.ts",
     "t-init": "tsx dist/prebuild/init-docs.mjs",
     "t-report": "tsx dist/prebuild/ReportServer.mjs",
-    "build-docs": "node scripts/compile-docs.js"
+    "build-docs": "node scripts/compile-docs.js",
+    "do_it": "clear && rm -rf testeranto/** && yarn build && yarn t-init && yarn t-build allTests once && yarn t-run allTests once && yarn build-docs && yarn type-check"
   },
   "peerDependencies": {
     "@types/react": "18.2.0",
@@ -145,6 +146,9 @@
     "typescript": "4.8.2",
     "typescript-eslint": "^8.29.0"
   },
+  "dependenciesPurpose": {
+    "express": "Used in unfinished feature 'mothership'"
+  },
   "devDependencies": {
     "@eslint/js": "^9.23.0",
     "@swc/core": "^1.3.26",
@@ -159,8 +163,6 @@
     "@typescript-eslint/eslint-plugin": "^5.46.0",
     "@typescript-eslint/parser": "^5.46.0",
     "marked": "^12.0.2",
-    "testeranto-solidity": "latest",
-    "testeranto_with_reduxjs_toolkit": "latest",
     "ts-node": "^10.9.1",
     "typescript": "^5.8.2"
   },
@@ -176,7 +178,6 @@
     "bootstrap": "^5.3.4",
     "chai": "^5.2.0",
     "chromium": "^3.0.3",
-    "dot-prop": "^9.0.0",
     "esbuild": "0.17.5",
     "esbuild-plugin-external-package": "^1.0.0",
     "esbuild-plugin-import-map": "^2.1.0",
@@ -190,30 +191,19 @@
     "express": "^4.21.2",
     "fs-extra": "^11.2.0",
     "fs.promises.exists": "^1.1.4",
-    "glob": "^10.3.12",
-    "is-path-inside": "^4.0.0",
-    "iterm-tab": "^0.4.0",
-    "live-server": "^1.2.2",
     "mermaid": "^11.8.1",
     "mermaid-isomorphic": "^3.0.4",
     "node-static": "^0.7.11",
-    "octokit": "^4.1.2",
     "puppeteer": "^24.4.0",
     "puppeteer-core": "24.4.0",
     "react": "18.2.0",
     "react-bootstrap": "^2.10.9",
     "react-dom": "18.2.0",
-    "react-router-dom": "6.29.0",
-    "react-test-renderer": "18.2.0",
-    "recursive-watch": "^1.1.4",
-    "rpc-over-ipc": "^1.0.0",
-    "testeranto": "^0.125.3",
+    "testeranto": "",
     "tsc-prog": "^2.3.0",
     "tsx": "^4.19.3",
     "typescript-eslint": "^8.29.1",
     "url": "^0.11.4",
-    "uuid": "^10.0.0",
-    "why-is-node-running": "^3.2.2",
-    "ws": "^8.16.0"
+    "uuid": "^10.0.0"
   }
 }

package/src/lib/basebuilder.ts

@@ -130,30 +130,6 @@ export abstract class BaseBuilder<
 
           await puppetMaster.writeFileSync(`bdd_errors.txt`, fails.toString());
 
-          //           await puppetMaster.writeFileSync(
-          //             `index.html`,
-          //             `
-          // <!DOCTYPE html>
-          // <html lang="en">
-
-          // <head>
-          //   <meta name="description" content="Webpage description goes here" />
-          //   <meta charset="utf-8" />
-          //   <title>kokomoBay - testeranto</title>
-          //   <meta name="viewport" content="width=device-width, initial-scale=1" />
-          //   <meta name="author" content="" />
-
-          //   <link rel="stylesheet" href="/kokomoBay/testeranto/TestReport.css" />
-          //   <script src="/kokomoBay/testeranto/TestReport.js"></script>
-
-          // </head>
-
-          // <body>
-          //   <div id="root"/>
-          // </body>
-          //             `
-          //           );
-
           await puppetMaster.writeFileSync(
             `tests.json`,
             JSON.stringify(this.toObj(), null, 2)

package/testeranto/Project.css

@@ -2030,10 +2030,6 @@ progress {
   display: block;
   padding: 0;
 }
-.form-control::-moz-placeholder {
-  color: var(--bs-secondary-color);
-  opacity: 1;
-}
 .form-control::placeholder {
   color: var(--bs-secondary-color);
   opacity: 1;
@@ -2513,19 +2509,10 @@ textarea.form-control-lg {
 .form-floating > .form-control-plaintext {
   padding: 1rem .75rem;
 }
-.form-floating > .form-control-plaintext::-moz-placeholder,
-.form-floating > .form-control::-moz-placeholder {
-  color: transparent;
-}
 .form-floating > .form-control-plaintext::placeholder,
 .form-floating > .form-control::placeholder {
   color: transparent;
 }
-.form-floating > .form-control-plaintext:not(:-moz-placeholder),
-.form-floating > .form-control:not(:-moz-placeholder) {
-  padding-top: 1.625rem;
-  padding-bottom: .625rem;
-}
 .form-floating > .form-control-plaintext:focus,
 .form-floating > .form-control-plaintext:not(:placeholder-shown),
 .form-floating > .form-control:focus,
@@ -2543,9 +2530,6 @@ textarea.form-control-lg {
   padding-bottom: .625rem;
   padding-left: .75rem;
 }
-.form-floating > .form-control:not(:-moz-placeholder) ~ label {
-  transform: scale(.85) translateY(-.5rem) translateX(.15rem);
-}
 .form-floating > .form-control-plaintext ~ label,
 .form-floating > .form-control:focus ~ label,
 .form-floating > .form-control:not(:placeholder-shown) ~ label,
@@ -2555,15 +2539,6 @@ textarea.form-control-lg {
 .form-floating > .form-control:-webkit-autofill ~ label {
   transform: scale(.85) translateY(-.5rem) translateX(.15rem);
 }
-.form-floating > textarea:not(:-moz-placeholder) ~ label::after {
-  position: absolute;
-  inset: 1rem 0.375rem;
-  z-index: -1;
-  height: 1.5em;
-  content: "";
-  background-color: var(--bs-body-bg);
-  border-radius: var(--bs-border-radius);
-}
 .form-floating > textarea:focus ~ label::after,
 .form-floating > textarea:not(:placeholder-shown) ~ label::after {
   position: absolute;
@@ -11360,7 +11335,7 @@ footer {
 
 bootstrap/dist/css/bootstrap.min.css:
   (*!
-  * Bootstrap  v5.3.4 (https://getbootstrap.com/)
+  * Bootstrap  v5.3.5 (https://getbootstrap.com/)
   * Copyright 2011-2025 The Bootstrap Authors
   * Licensed under MIT (https://github.com/twbs/bootstrap/blob/main/LICENSE)
   *)