@hapergg/harness-comet-cli 0.1.0

package/dist/templates/playwright-mode.js

@@ -0,0 +1,225 @@
+export function playwrightHarnessCometConfigTemplate(testDir = "tests") {
+    return `export default {
+  schemaVersion: 1,
+  mode: "playwright",
+  playwright: {
+    configFile: "playwright.config.ts",
+    testDir: "${testDir}",
+    testMatch: ["**/*.spec.ts"],
+    assetRoots: ["${testDir}"],
+    resultsFile: "test-results/harness-comet/results.json"
+  },
+  docs: {
+    testingDir: "docs/testing"
+  },
+  incidents: {
+    directory: "${testDir}/incidents",
+    requireIssueUrl: false,
+    requireReadme: true
+  },
+  validation: {
+    forbidOnly: true,
+    longWaitWarningMs: 5000
+  }
+};
+`;
+}
+export function playwrightConfigTemplate(testDir = "tests") {
+    return `import { defineConfig } from "@playwright/test";
+
+export default defineConfig({
+  testDir: "${testDir}",
+  testMatch: ["**/*.spec.ts"],
+  fullyParallel: true,
+  forbidOnly: Boolean(process.env.CI),
+  retries: process.env.CI ? 2 : 0,
+  workers: process.env.CI ? 2 : undefined,
+  reporter: [["list"], ["html", { open: "never" }], ["@hapergg/harness-comet-playwright/reporter"]],
+  expect: {
+    timeout: 10_000
+  },
+  use: {
+    headless: true,
+    viewport: { width: 1440, height: 900 },
+    actionTimeout: 15_000,
+    navigationTimeout: 30_000,
+    baseURL: process.env.PLAYWRIGHT_BASE_URL ?? "http://localhost:3000",
+    trace: "on-first-retry",
+    screenshot: "only-on-failure",
+    video: "retain-on-failure"
+  },
+  projects: [
+    {
+      name: "chromium",
+      use: { browserName: "chromium" }
+    }
+  ]
+});
+`;
+}
+export function playwrightExampleSpecTemplate() {
+    return `import { expect, test } from "@playwright/test";
+import input from "../data/example-input.json" with { type: "json" };
+import expectedPayload from "../data/example-expected-payload.json" with { type: "json" };
+import { attachJson } from "../support/attachments";
+import { mockJson } from "../support/mock-api";
+
+test(
+  "Example save flow",
+  {
+    tag: ["@harness", "@annotation-save"]
+  },
+  async ({ page }, testInfo) => {
+    const captured: unknown[] = [];
+
+    await mockJson(page, "**/api/bootstrap", {
+      featureFlags: { annotationSave: true }
+    });
+
+    await page.route("**/api/annotations", async (route) => {
+      const request = route.request();
+      captured.push(JSON.parse(request.postData() ?? "{}"));
+      await route.fulfill({
+        status: 200,
+        contentType: "application/json",
+        body: JSON.stringify({ ok: true, saved: true })
+      });
+    });
+
+    await page.setContent(\`
+      <main>
+        <h1>Annotation Editor</h1>
+        <label>
+          Label
+          <input data-testid="label" />
+        </label>
+        <label>
+          Comment
+          <textarea data-testid="comment"></textarea>
+        </label>
+        <button data-testid="save">Save</button>
+        <output data-testid="status"></output>
+      </main>
+      <script>
+        async function bootstrap() {
+          const response = await fetch('/api/bootstrap');
+          window.__bootstrap = await response.json();
+        }
+        document.querySelector('[data-testid="save"]').addEventListener('click', async () => {
+          const payload = {
+            id: "annotation-1",
+            label: document.querySelector('[data-testid="label"]').value,
+            comment: document.querySelector('[data-testid="comment"]').value
+          };
+          await fetch('/api/annotations', {
+            method: 'POST',
+            headers: { 'content-type': 'application/json' },
+            body: JSON.stringify(payload)
+          });
+          document.querySelector('[data-testid="status"]').textContent = 'Saved';
+        });
+        bootstrap();
+      </script>
+    \`);
+
+    await expect
+      .poll(() => page.evaluate(() => Boolean(window.__bootstrap?.featureFlags?.annotationSave)))
+      .toBe(true);
+    await page.getByTestId("label").fill((input as { label: string }).label);
+    await page.getByTestId("comment").fill((input as { comment: string }).comment);
+    await page.getByTestId("save").click();
+
+    await expect(page.getByTestId("status")).toHaveText("Saved");
+    expect(captured[0]).toEqual(expectedPayload);
+    await attachJson(testInfo, "captured-payload", captured[0]);
+  }
+);
+`;
+}
+export function playwrightFixturesTemplate() {
+    return `export const harnessBaseUrl = process.env.PLAYWRIGHT_BASE_URL ?? "http://localhost:3000";
+`;
+}
+export function playwrightMockApiTemplate() {
+    return `import type { Page } from "@playwright/test";
+
+export async function mockJson(
+  page: Page,
+  url: string,
+  body: unknown,
+  status = 200
+): Promise<void> {
+  await page.route(url, async (route) => {
+    await route.fulfill({
+      status,
+      contentType: "application/json",
+      body: JSON.stringify(body)
+    });
+  });
+}
+`;
+}
+export function playwrightAttachmentsTemplate() {
+    return `import type { TestInfo } from "@playwright/test";
+
+export async function attachJson(testInfo: TestInfo, name: string, value: unknown): Promise<void> {
+  await testInfo.attach(\`\${name}.json\`, {
+    body: Buffer.from(JSON.stringify(value, null, 2)),
+    contentType: "application/json"
+  });
+}
+`;
+}
+export function playwrightIncidentReadmeTemplate() {
+    return `# Incident Tests
+
+Store incident-focused Playwright assets here. Each incident should have:
+
+- an incident metadata file
+- a focused spec
+- input and expected payload fixtures
+- a README describing reproduction and verification notes
+`;
+}
+export function playwrightAuthoringGuideTemplate() {
+    return `# Authoring Guide
+
+Prefer one business behavior per Playwright test file. Keep the test focused on:
+
+- deterministic fixtures
+- request mocking
+- payload capture
+- clear assertions
+- attached JSON evidence
+`;
+}
+export function playwrightIncidentGuideTemplate() {
+    return `# Incident Guide
+
+Use \`harness-comet create incident <id>\` to scaffold incident assets, then keep the spec and fixture files close to the incident metadata.
+`;
+}
+export function playwrightAcceptanceCriteriaTemplate() {
+    return `# Acceptance Criteria
+
+Every Playwright Harness change should leave behind:
+
+- declared target tests
+- verification evidence
+- results JSON
+- a markdown verify report
+- a receipt that archive-check can validate
+`;
+}
+export function testingReadmeTemplate() {
+    return `# Testing
+
+This project uses Playwright mode for Harness-Comet.
+
+Playwright owns test execution through \`playwright.config.ts\`.
+Harness-Comet owns business scenario metadata, Comet impact decisions, verification evidence, and archive checks.
+
+Keep tests focused on business behavior. Add helper files and directories only when the project needs them.
+`;
+}
+//# sourceMappingURL=playwright-mode.js.map

package/dist/templates/playwright-mode.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"playwright-mode.js","sourceRoot":"","sources":["../../src/templates/playwright-mode.ts"],"names":[],"mappings":"AAAA,MAAM,UAAU,oCAAoC,CAAC,OAAO,GAAG,OAAO;IACpE,OAAO;;;;;gBAKO,OAAO;;oBAEH,OAAO;;;;;;;kBAOT,OAAO;;;;;;;;;CASxB,CAAC;AACF,CAAC;AAED,MAAM,UAAU,wBAAwB,CAAC,OAAO,GAAG,OAAO;IACxD,OAAO;;;cAGK,OAAO;;;;;;;;;;;;;;;;;;;;;;;;;;;CA2BpB,CAAC;AACF,CAAC;AAED,MAAM,UAAU,6BAA6B;IAC3C,OAAO;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CA4ER,CAAC;AACF,CAAC;AAED,MAAM,UAAU,0BAA0B;IACxC,OAAO;CACR,CAAC;AACF,CAAC;AAED,MAAM,UAAU,yBAAyB;IACvC,OAAO;;;;;;;;;;;;;;;;CAgBR,CAAC;AACF,CAAC;AAED,MAAM,UAAU,6BAA6B;IAC3C,OAAO;;;;;;;;CAQR,CAAC;AACF,CAAC;AAED,MAAM,UAAU,gCAAgC;IAC9C,OAAO;;;;;;;;CAQR,CAAC;AACF,CAAC;AAED,MAAM,UAAU,gCAAgC;IAC9C,OAAO;;;;;;;;;CASR,CAAC;AACF,CAAC;AAED,MAAM,UAAU,+BAA+B;IAC7C,OAAO;;;CAGR,CAAC;AACF,CAAC;AAED,MAAM,UAAU,oCAAoC;IAClD,OAAO;;;;;;;;;CASR,CAAC;AACF,CAAC;AAED,MAAM,UAAU,qBAAqB;IACnC,OAAO;;;;;;;;CAQR,CAAC;AACF,CAAC"}

package/package.json

@@ -0,0 +1,58 @@
+{
+  "name": "@hapergg/harness-comet-cli",
+  "version": "0.1.0",
+  "description": "Command line interface for initializing, validating, and running Harness Comet projects.",
+  "license": "MIT",
+  "type": "module",
+  "engines": {
+    "node": ">=20"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/HarperGG/harness-comet.git",
+    "directory": "packages/cli"
+  },
+  "homepage": "https://github.com/HarperGG/harness-comet#readme",
+  "bugs": {
+    "url": "https://github.com/HarperGG/harness-comet/issues"
+  },
+  "files": [
+    "dist",
+    "bin"
+  ],
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  },
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "default": "./dist/index.js"
+    }
+  },
+  "bin": {
+    "harness-comet": "./bin/harness-comet.js"
+  },
+  "dependencies": {
+    "commander": "^14.0.2",
+    "execa": "^9.6.0",
+    "picocolors": "^1.1.1",
+    "@hapergg/harness-comet-adapter-playwright": "0.1.0",
+    "@hapergg/harness-comet-schema": "0.1.0",
+    "@hapergg/harness-comet-adapter-memory": "0.1.0",
+    "@hapergg/harness-comet-core": "0.1.0",
+    "@hapergg/harness-comet-comet-adapter": "0.1.0"
+  },
+  "devDependencies": {
+    "typescript": "^5.9.3",
+    "vitest": "^4.0.14"
+  },
+  "scripts": {
+    "clean": "rm -rf dist tsconfig.tsbuildinfo",
+    "build": "tsc -b && chmod +x bin/harness-comet.js",
+    "test": "vitest run"
+  }
+}