testeranto 0.135.0 → 0.140.0

package/README.md

@@ -2,33 +2,29 @@
 
 ## The AI-powered BDD test framework for TypeScript projects
 
-🚧 WARNING: Testeranto is still under development and is not ready for production yet. 🚧
+#### 🚧 WARNING: Testeranto is still under development and is not ready for production yet. 🚧
 
-demo video: [youtube](https://www.youtube.com/embed/WvU5xMqGi6Q)
-
-source: [github.com/adamwong246/testeranto](https://github.com/adamwong246/testeranto)
-
-npm: [npmjs.com/package/testeranto](https://www.npmjs.com/package/testeranto)
-
-dev: [github.dev/adamwong246/testeranto](https://github.dev/adamwong246/testeranto)
-
-example repo: [testeranto-starter](https://github.com/adamwong246/testeranto-starter)
+- demo video: [youtube](https://www.youtube.com/embed/WvU5xMqGi6Q)
+- source: [github.com/adamwong246/testeranto](https://github.com/adamwong246/testeranto)
+- npm: [npmjs.com/package/testeranto](https://www.npmjs.com/package/testeranto)
+- dev: [github.dev/adamwong246/testeranto](https://github.dev/adamwong246/testeranto)
+- example repo: [testeranto-starter](https://github.com/adamwong246/testeranto-starter)
 
 ## What is testeranto?
 
 - Testeranto produces test results which can be fed to Aider.ai to automatically fix failing tests.
 - 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.
-- Testeranto can be run in the frontend or the backend, or both.
+- Testeranto can run tests in the frontend or the backend, or both.
 - Testeranto can be used to test anything that can be bundled with esbuild.
 - Testeranto connects "features" to "tests". This allows the AI to read feature documentation from external systems, like Jira.
 - Testeranto generates test results into static a website which can be deployed to github pages easily.
+- Testeranto uses esbuild to bundle it's tests. The result is used to refine the list of files added to the context of the AI. **The consequence of this is that you can fit all relevant files, and ONLY the relevant files, into the LLMs context.**
 
 ## Key Technologies
 
-Testeranto builds on modern JavaScript/TypeScript tooling:
-
-| Technology | Purpose                                |
+|            |                                        |
 | ---------- | -------------------------------------- |
+| ESM        | Modern javascript tooling              |
 | TypeScript | Strongly-typed test definitions        |
 | Puppeteer  | Cross-runtime testing (Node & Browser) |
 | esbuild    | Fast test bundling                     |
@@ -63,138 +59,35 @@ const RectangleSpec = (Suite, Given, When, Then) => [
 ];
 ```
 
-3. Run your tests in two separate terminals:
+3. Run the tests
+
+To start testeranto in dev mode, build your tests in one terminal and execute them in another
 
 ```bash
 # Terminal 1 - Build in watch mode
-yarn t-build rectangle.test.ts dev
+yarn t-build rectangle.test.ts yourProject dev
 
 # Terminal 2 - Run in watch mode
-yarn t-run rectangle.test.ts dev
+yarn t-run rectangle.test.ts yourProject dev
 ```
 
-### Development Workflow
-
-```mermaid
-
-flowchart LR
-
-    subgraph hh["humans"]
-        direction LR
-        Human[🧑💻 ]
-    end
-
-    subgraph bb["AI"]
-        direction LR
-        Bot[🤖🧠 aider]
-    end
-
-
-    tests ---> L
-    subgraph tests
-        direction LR
-        A[Test Specification]
-        B[Test Interface]
-        C[Test Implementation]
-        K[application code]
-    end
-
-    subgraph buildSystem
-        direction TB
-        L["t-build"]
-        M[t-run]
-        L ---> M
+or build and run your tests only once
 
-        M ---> N
-        M --->O
-        M --->P
-        N["BDD tests"]
-        O["Static analysis"]
-        P["Type checking"]
-
-        Q["reports"]
-        N ---> Q
-        O ---> Q
-        P ---> Q
-    end
-
-    Q ---> bb
-
-    buildSystem ---> bb
-    bb ---> tests
-    hh ---> tests
-
-    %% Styling
-    style Human fill:#268bd2,stroke:#586e75,color:#fdf6e3
-    style Bot fill:#d33682,stroke:#586e75,color:#fdf6e3
-
-    %% Layout tweaks
-    classDef column margin-right:20px
-
-```
-
-## Architecture Overview
-
-```mermaid
-flowchart TD
-    subgraph ThreePillars["Testeranto Core"]
-        Builder[Test Builder]
-        Runner[Test Runner]
-        Aider[AI Integration]
-    end
-
-    subgraph BuilderComponents[" "]
-        Specification[Specification]
-        Implementation[Implementation]
-        Interface[Interface]
-    end
-
-    subgraph Runtimes[" "]
-        Node[Node]
-        Web[Browser]
-        Pure[JS]
-    end
-
-    Builder --> Runner
-    Runner --> Aider
-    Aider --> Builder
-
-    Builder --> BuilderComponents
-    Runner --> Runtimes
-
-    style ThreePillars fill:none,stroke:#586e75
-    style Builder fill:#268bd2,stroke:#586e75,color:#fdf6e3
-    style Runner fill:#268bd2,stroke:#586e75,color:#fdf6e3
-    style Aider fill:#b58900,stroke:#586e75,color:#002b36
-    style BuilderComponents fill:#002b36,stroke:#586e75,color:#eee8d5
-    style Runtimes fill:#073642,stroke:#586e75,color:#eee8d5
-    style Specification fill:#2aa198,stroke:#586e75,color:#002b36
-    style Implementation fill:#2aa198,stroke:#586e75,color:#002b36
-    style Interface fill:#2aa198,stroke:#586e75,color:#002b36
-    style Node fill:#859900,stroke:#586e75,color:#002b36
-    style Web fill:#859900,stroke:#586e75,color:#002b36
-    style Pure fill:#859900,stroke:#586e75,color:#002b36
+```bash
+yarn t-build rectangle.test.ts yourProject once && yarn t-run rectangle.test.ts yourProject once
 ```
 
 ## Runtime Platforms
 
-Testeranto runs tests in multiple runtime environments, each suited for different testing scenarios:
-
-| Runtime  | Description                                       | When To Use                                                            | Key Characteristics                                     |
-| -------- | ------------------------------------------------- | ---------------------------------------------------------------------- | ------------------------------------------------------- |
-| **Node** | Full IO access with Node.js built-in modules      | Testing backend code, Node APIs, or anything needing filesystem access | Runs in Node v8 via fork, has access to fs, crypto, etc |
-| **Web**  | DOM API access with browser capabilities          | Testing frontend code, UI interactions, or visual regression           | Runs in Chrome page, can take screenshots/recordings    |
-| **Pure** | Isolated JS runtime without external dependencies | Fast unit tests that don't need external resources                     | Dynamically imported into main thread, no IO access     |
-
-**Key Considerations:**
-
-- Use **Node** for testing backend services, file operations, or anything requiring Node.js APIs
-- Use **Web** when testing browser-specific code that references `document` or `window`
-- Use **Pure** for fast, isolated unit tests where you don't need console output or external resources
+|          | Runs on                       | You should use this runtime for...                                                                      | Important differences                                                                                       |
+| -------- | ----------------------------- | ------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- |
+| **Node** | node V8 with fork             | testing backend code, Node APIs (like `fs` and `crypto`), or anything needing filesystem access         | has access to the filesystem and io                                                                         |
+| **Web**  | chrome browser                | testing frontend code, anything that uses `document` or `window`, UI interactions, or visual regression | can take screenshots/recordings                                                                             |
+| **Pure** | node v8, dynamically imported | testing code which can run on both node-v8 and the the browser                                          | Very similar to "Node" but has no IO access and thus, no console.log. This runtime is theoretically faster. |
 
 ## CLI Commands
 
-| Command                               | Description                                   |
+|                                       |                                               |
 | ------------------------------------- | --------------------------------------------- |
 | `yarn t-init`                         | Create a new testeranto project               |
 | `yarn t-build <YOUR_TESTS> dev\|once` | Build test bundles (watch or single-run mode) |
@@ -202,7 +95,7 @@ Testeranto runs tests in multiple runtime environments, each suited for differen
 | `yarn t-report`                       | Launch test report server                     |
 | `yarn t-aider`                        | Fix failing tests with AI                     |
 
-Example workflow:
+## Example workflow:
 
 ```bash
 # Initialize project
@@ -224,7 +117,7 @@ yarn t-run test/rectangle.test.ts once
 yarn t-aider
 ```
 
-## AI
+## Aider
 
 Testeranto generates a "prompt" alongside test results. This prompt is passed to aider as input.
 
@@ -241,14 +134,14 @@ Testeranto generates a "prompt" alongside test results. This prompt is passed to
 /load testeranto/reports/allTests/node/test/node/featurePrompt.txt
 
 // tell the AI what to do
-/code Fix the failing tests described in testeranto/reports/allTests/node/test/node/tests.json. Correct any type signature errors described in the files testeranto/reports/allTests/test/node/node/type_errors.txt. Implement any method which throws "Function not implemented. Resolve the lint errors described in testeranto/reports/allTests/test/node/node/lint_errors.json"
+Fix the failing tests described in testeranto/reports/allTests/node/test/node/tests.json. Correct any type signature errors described in the files testeranto/reports/allTests/test/node/node/type_errors.txt. Implement any method which throws "Function not implemented. Resolve the lint errors described in testeranto/reports/allTests/test/node/node/lint_errors.json"
 ```
 
 ## "Features"
 
 Testeranto connects "features" to tests. The features may be simple strings, but they can also take the form of local markdown files, or remote URLs to external feature tracking systems. For instance, this could be a jira ticket or a github issue. These features are used to inform the AI context.
 
-```ts
+```typescript
 import someMarkdownFile from "someMarkdownFile.md";
 
 ...

package/bundle.js

@@ -25,7 +25,7 @@ await esbuild.build({
 })
 
 await esbuild.build({
-  entryPoints: ['src/ReportClient.tsx', 'src/TestReport.tsx', 'src/Project.tsx'],
+  entryPoints: ['src/TestReport.tsx', 'src/Project.tsx'],
   bundle: true,
   format: "iife",
   platform: "browser",

package/dist/common/src/Init.js

@@ -25,7 +25,10 @@ exports.default = async () => {
         }
     });
     fs_1.default.copyFileSync(`node_modules/testeranto/dist/prebuild/Project.js`, `testeranto/Project.js`);
-    fs_1.default.copyFileSync(`node_modules/testeranto/dist/prebuild/ReportClient.js`, `testeranto/ReportClient.js`);
+    // fs.copyFileSync(
+    //   `node_modules/testeranto/dist/prebuild/ReportClient.js`,
+    //   `testeranto/ReportClient.js`
+    // );
     fs_1.default.copyFileSync(`node_modules/testeranto/dist/prebuild/Project.css`, `testeranto/Project.css`);
     // fs.copyFileSync(
     //   `node_modules/testeranto/dist/prebuild/ReportClient.css`,

package/dist/common/src/Node.js

@@ -51,6 +51,6 @@ const testeranto = async (input, testSpecification, testImplementation, testInte
         //   });
         // });
     }
-    return t;
+    // return t;
 };
 exports.default = testeranto;

package/dist/common/src/PM/__tests__/nodeSidecar.testeranto.js

@@ -41,7 +41,7 @@ const implementation = {
                     return mockProcess;
                 },
                 addListener: () => mockProcess,
-                removeListener: () => mockProcess
+                removeListener: () => mockProcess,
             };
             process = mockProcess;
             let writeCalled = false;
@@ -63,7 +63,7 @@ const implementation = {
                 removeListener: () => {
                     removeListenerCalled = true;
                     return mockProcess;
-                }
+                },
             };
             process = mockProcess;
             await sidecar.send("test-command", "test");

package/dist/common/src/Web.js

@@ -1,4 +1,6 @@
 "use strict";
+/* eslint-disable @typescript-eslint/no-unused-vars */
+/* eslint-disable @typescript-eslint/no-explicit-any */
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
@@ -10,8 +12,6 @@ const index_js_1 = require("./lib/index.js");
 let errorCallback = (e) => { };
 let unhandledrejectionCallback = (event) => {
     console.log("window.addEventListener unhandledrejection", event);
-    // cb({ error: event.reason.message });
-    // throw event;
 };
 class WebTesteranto extends core_js_1.default {
     constructor(input, testSpecification, testImplementation, testResourceRequirement, testInterface) {

package/dist/common/src/build.js

@@ -48,6 +48,7 @@ const web_js_1 = __importDefault(require("./esbuildConfigs/web.js"));
 const pure_js_1 = __importDefault(require("./esbuildConfigs/pure.js"));
 const web_html_js_1 = __importDefault(require("./web.html.js"));
 const utils_js_1 = require("./utils.js");
+const buildTemplates_js_1 = require("./utils/buildTemplates.js");
 readline_1.default.emitKeypressEvents(process.stdin);
 if (process.stdin.isTTY)
     process.stdin.setRawMode(true);
@@ -144,60 +145,11 @@ Promise.resolve(`${process.cwd() + "/" + "testeranto.config.ts"}`).then(s => __i
     if (!fs_1.default.existsSync(`testeranto/reports/${testName}`)) {
         fs_1.default.mkdirSync(`testeranto/reports/${testName}`);
     }
-    fs_1.default.writeFileSync(`${process.cwd()}/testeranto/reports/${testName}/index.html`, `
-    <!DOCTYPE html>
-    <html lang="en">
-  
-    <head>
-      <meta name="description" content="Webpage description goes here" />
-      <meta charset="utf-8" />
-      <title>${pckge.name} - testeranto</title>
-      <meta name="viewport" content="width=device-width, initial-scale=1" />
-      <meta name="author" content="" />
-  
-      <link rel="stylesheet" href="../ReportClient.css" />
-      <script type="module" src="../ReportClient.js"></script>
-  
-    </head>
-  
-    <body>
-      <div id="root">
-        react is loading
-      </div>
-    </body>
-  
-    </html>
-        `);
+    fs_1.default.writeFileSync(`${process.cwd()}/testeranto/reports/${testName}/index.html`, (0, buildTemplates_js_1.testReportPage)(pckge.name, bigConfig.reportDomain));
+    fs_1.default.writeFileSync(`${process.cwd()}/testeranto/reports/${testName}/dev.html`, (0, buildTemplates_js_1.testReportPage)(pckge.name, "/"));
     fs_1.default.writeFileSync(`testeranto/reports/${testName}/config.json`, JSON.stringify(config, null, 2));
-    fs_1.default.writeFileSync(`${process.cwd()}/testeranto/index.html`, `
-  <!DOCTYPE html>
-  <html lang="en">
-
-  <head>
-    <meta name="description" content="Webpage description goes here" />
-    <meta charset="utf-8" />
-    <title>${pckge.name} - testeranto</title>
-    <meta name="viewport" content="width=device-width, initial-scale=1" />
-    <meta name="author" content="" />
-    <base href="https://adamwong246.github.io/spacetrash_v8" target="_blank">
-
-    <script type="application/json" id="bigConfig">
-      ${JSON.stringify(Object.keys(bigConfig.projects))}
-    </script>
-
-    <link rel="stylesheet" href="/reports/Project.css" />
-    <script type="module" src="/reports/Project.js"></script>
-
-  </head>
-
-  <body>
-    <div id="root">
-      react is loading
-    </div>
-  </body>
-
-  </html>
-      `);
+    fs_1.default.writeFileSync(`${process.cwd()}/testeranto/index.html`, (0, buildTemplates_js_1.testsReportPage)(pckge.name, bigConfig.reportDomain, bigConfig.projects));
+    fs_1.default.writeFileSync(`${process.cwd()}/testeranto/dev.html`, (0, buildTemplates_js_1.testsReportPage)(pckge.name, "/", bigConfig.projects));
     Promise.resolve(Promise.all([...getSecondaryEndpointsPoints("web")].map(async (sourceFilePath) => {
         const sourceFileSplit = sourceFilePath.split("/");
         const sourceDir = sourceFileSplit.slice(0, -1);
@@ -244,26 +196,8 @@ Promise.resolve(`${process.cwd() + "/" + "testeranto.config.ts"}`).then(s => __i
                 .slice(0, -1)
                 .join(".")}/${runtime}`;
             await fs_1.default.mkdirSync(folder, { recursive: true });
-            fs_1.default.writeFileSync(`${folder}/index.html`, `
-<!DOCTYPE html>
-<html lang="en">
-
-<head>
-  <meta name="description" content="Webpage description goes here" />
-  <meta charset="utf-8" />
-  <title>${testName} - testeranto</title>
-  <meta name="viewport" content="width=device-width, initial-scale=1" />
-  <meta name="author" content="" />
-
-  <link rel="stylesheet" href="../../../../../../TestReport.css" />
-  <script src="../../../../../../TestReport.js"></script>
-
-</head>
-
-<body>
-  <div id="root"/>
-</body>
-            `);
+            fs_1.default.writeFileSync(`${folder}/index.html`, (0, buildTemplates_js_1.idkPage)(testName, bigConfig.reportDomain));
+            fs_1.default.writeFileSync(`${folder}/dev.html`, (0, buildTemplates_js_1.idkPage)(testName, ""));
         });
     });
     [

package/dist/common/src/defaultConfig.js

@@ -11,7 +11,6 @@ const config = {
     nodePlugins: [],
     webPlugins: [],
     importPlugins: [],
-    externalTests: {},
     featureIngestor: function (s) {
         throw new Error("Function not implemented.");
     },

package/dist/common/src/lib/abstractBase.js

@@ -1,4 +1,6 @@
 "use strict";
+/* eslint-disable @typescript-eslint/no-unused-vars */
+/* eslint-disable @typescript-eslint/no-explicit-any */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.BaseCheck = exports.BaseThen = exports.BaseWhen = exports.BaseGiven = exports.BaseSuite = void 0;
 const pmProxy_js_1 = require("./pmProxy.js");

package/dist/common/src/lib/basebuilder.js

@@ -1,4 +1,8 @@
 "use strict";
+/* eslint-disable @typescript-eslint/no-unused-vars */
+/* eslint-disable @typescript-eslint/no-empty-object-type */
+/* eslint-disable no-async-promise-executor */
+/* eslint-disable @typescript-eslint/no-explicit-any */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.BaseBuilder = void 0;
 class BaseBuilder {

package/dist/common/src/lib/core.js

@@ -1,5 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+/* eslint-disable @typescript-eslint/no-unused-vars */
+/* eslint-disable @typescript-eslint/no-explicit-any */
 const index_js_1 = require("./index.js");
 const abstractBase_js_1 = require("./abstractBase.js");
 const classBuilder_js_1 = require("./classBuilder.js");

package/dist/common/src/run.js

@@ -49,7 +49,7 @@ process.stdin.on("keypress", (str, key) => {
         process.exit(-1);
     }
 });
-let testName = process.argv[2];
+const testName = process.argv[2];
 const mode = process.argv[3];
 if (mode !== "once" && mode !== "dev") {
     console.error("the 2nd argument should be 'dev' or 'once' ");

package/dist/common/src/utils/buildTemplates.js

@@ -0,0 +1,88 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.idkPage = exports.testsReportPage = exports.testReportPage = void 0;
+const testReportPage = (packageName, domain) => {
+    return `
+    <!DOCTYPE html>
+    <html lang="en">
+  
+    <head>
+      <meta name="description" content="Webpage description goes here" />
+      <meta charset="utf-8" />
+      <title>${packageName} - testeranto</title>
+      <meta name="viewport" content="width=device-width, initial-scale=1" />
+      <meta name="author" content="" />
+      
+      <base href="${domain}" target="_blank">
+  
+      <link rel="stylesheet" href="../ReportClient.css" />
+      <script type="module" src="../ReportClient.js"></script>
+  
+    </head>
+  
+    <body>
+      <div id="root">
+        react is loading
+      </div>
+    </body>
+  
+    </html>
+        `;
+};
+exports.testReportPage = testReportPage;
+const testsReportPage = (packageName, domain, projects) => {
+    return `
+    <!DOCTYPE html>
+    <html lang="en">
+  
+    <head>
+      <meta name="description" content="Webpage description goes here" />
+      <meta charset="utf-8" />
+      <title>${packageName} - testeranto</title>
+      <meta name="viewport" content="width=device-width, initial-scale=1" />
+      <meta name="author" content="" />
+      <base href="${domain}" target="_blank">
+  
+      <script type="application/json" id="bigConfig">
+        ${JSON.stringify(Object.keys(projects))}
+      </script>
+  
+      <link rel="stylesheet" href="./testeranto/Project.css" />
+      <script type="module" src="./testeranto/Project.js"></script>
+  
+    </head>
+  
+    <body>
+      <div id="root">
+        react is loading
+      </div>
+    </body>
+  
+    </html>
+        `;
+};
+exports.testsReportPage = testsReportPage;
+const idkPage = (testName, domain) => {
+    return `
+<!DOCTYPE html>
+<html lang="en">
+
+<head>
+  <meta name="description" content="Webpage description goes here" />
+  <base href="${domain}" target="_blank">
+  <meta charset="utf-8" />
+  <title>${testName} - testeranto</title>
+  <meta name="viewport" content="width=device-width, initial-scale=1" />
+  <meta name="author" content="" />
+
+  <link rel="stylesheet" href="./testeranto/TestReport.css" />
+  <script src="./testeranto/TestReport.js"></script>
+
+</head>
+
+<body>
+  <div id="root"/>
+</body>
+            `;
+};
+exports.idkPage = idkPage;