@thinkwise/testwise 0.2.67 → 0.2.103

package/scripts/main.js

@@ -1,63 +1,84 @@
-#!/usr/bin/env node
-import process from 'node:process';
-import { postinstall } from './postinstall.js';
-import { setup } from './setup.js';
-import { sync } from './sync.js';
-
-/**
- * Main entry point for Testwise CLI commands
- * @param {string[]} args - Command line arguments
- */
-async function main() {
-  try {
-    const command = process.argv[2];
-
-    if (!command) {
-      console.error('Error: No command provided.');
-      console.log('Usage: main.js <command>');
-      console.log('Available commands: postinstall, sync');
-      process.exit(1);
-    }
-
-    if (command === 'postinstall') {
-      await handlePostinstall();
-    } else if (command === 'sync') {
-      await handleSync();
-    } else {
-      console.error(`Error: Unknown command '${command}'.`);
-      console.log('Available commands: postinstall, sync');
-      process.exit(1);
-    }
-  } catch (error) {
-    console.error('Fatal error:', error.message);
-    process.exit(1);
-  }
-}
-
-/**
- * Handle postinstall command
- */
-async function handlePostinstall() {
-  try {
-    await setup();
-    postinstall();
-  } catch (error) {
-    console.error('Postinstall failed:', error.message);
-    process.exit(1);
-  }
-}
-
-/**
- * Handle sync command
- */
-async function handleSync() {
-  try {
-    sync();
-  } catch (error) {
-    console.error('Sync failed:', error.message);
-    process.exit(1);
-  }
-}
-
-// Start the application
-main();
+#!/usr/bin/env node
+import process from 'node:process';
+import { diagram } from './diagram.js';
+import { postinstall } from './postinstall.js';
+import { setup } from './setup.js';
+import { sync } from './sync.js';
+
+/**
+ * CLI entry point for the `testwise` command.
+ *
+ * Dispatches to the correct sub-command based on the first CLI argument:
+ *
+ * | Command | What it does |
+ * |---|---|
+ * | `testwise sync` | Runs the full artifact-builder pipeline (fetch model → generate subjects). |
+ * | `testwise setup` | Scaffolds `Testwise.json` and `tsconfig.json` in the consumer project. |
+ * | `testwise diagram` | Starts the living architecture diagram server at http://localhost:3333. |
+ * | `testwise postinstall` | Restores the artifact backup or re-runs sync (called automatically after `npm install`). |
+ *
+ * @param {string[]} args - Command line arguments
+ */
+async function main() {
+  try {
+    const command = process.argv[2];
+
+    if (!command) {
+      console.error('Error: No command provided.');
+      console.log('Usage: main.js <command>');
+      console.log('Available commands: postinstall, sync, diagram');
+      process.exit(1);
+    }
+
+    if (command === 'postinstall') {
+      await handlePostinstall();
+    } else if (command === 'sync') {
+      await handleSync();
+    } else if (command === 'diagram') {
+      await handleDiagram();
+    } else {
+      console.error(`Error: Unknown command '${command}'.`);
+      console.log('Available commands: postinstall, sync, diagram');
+      process.exit(1);
+    }
+  } catch (error) {
+    console.error('Fatal error:', error.message);
+    process.exit(1);
+  }
+}
+
+/**
+ * Handle postinstall command
+ */
+async function handlePostinstall() {
+  try {
+    await setup();
+    postinstall();
+  } catch (error) {
+    console.error('Postinstall failed:', error.message);
+    process.exit(1);
+  }
+}
+
+/**
+ * Handle sync command
+ */
+async function handleSync() {
+  try {
+    sync();
+  } catch (error) {
+    console.error('Sync failed:', error.message);
+    process.exit(1);
+  }
+}
+
+/**
+ * Handle diagram command
+ */
+async function handleDiagram() {
+  const port = parseInt(process.argv[3] ?? '3333', 10);
+  await diagram(port);
+}
+
+// Start the application
+main();

package/scripts/postinstall.js

@@ -1,42 +1,55 @@
-import { execSync } from 'node:child_process';
-import path from 'node:path';
-import process from 'node:process';
-import { fileURLToPath } from 'node:url';
-import { ArtifactManager } from '../dist/artifact-builder/index.js';
-import { testwiseConfig } from '../dist/services/ConfigBuilder.js';
-import { sync } from './sync.js';
-
-const _filename = fileURLToPath(import.meta.url);
-const _dirname = path.dirname(_filename);
-
-export async function postinstall() {
-  try {
-    const autoSync = testwiseConfig().get('featureSettings.other.autoSync') ?? true;
-    if (!autoSync) return;
-
-    const rootDir = path.resolve(_dirname, '..');
-    const artifactManager = new ArtifactManager();
-
-    if (artifactManager.backupExists()) {
-      artifactManager.restoreBackup();
-      console.info('Restored artifacts from backup.');
-
-      // eslint-disable-next-line @typescript-eslint/naming-convention
-      const { SubjectRegistration } = await import('../dist/artifact-builder/index.js');
-      const subjectRegistration = new SubjectRegistration();
-      await subjectRegistration.resetSubjectRegistry();
-      await subjectRegistration.run();
-
-      execSync('npx tsc', { cwd: rootDir, stdio: 'inherit' });
-
-      console.info('Postinstall restore process completed successfully.');
-
-      return;
-    }
-
-    await sync();
-  } catch (error) {
-    console.error('Postinstall process failed:', error.message);
-    process.exit(1);
-  }
-}
+import { execSync } from 'node:child_process';
+import path from 'node:path';
+import process from 'node:process';
+import { fileURLToPath } from 'node:url';
+import { ArtifactManager } from '../dist/artifact-builder/index.js';
+import { testwiseConfig } from '../dist/services/ConfigBuilder.js';
+import { sync } from './sync.js';
+
+const _filename = fileURLToPath(import.meta.url);
+const _dirname = path.dirname(_filename);
+
+/**
+ * Runs automatically after `npm install` as the `postinstall` lifecycle hook.
+ *
+ * **What it does:**
+ * - Checks whether `featureSettings.other.autoSync` is enabled in
+ *   `Testwise.json` (defaults to `true`).
+ * - If a backup of `test-artifacts/` exists from a previous install, it
+ *   restores it immediately so the consumer project's tests remain runnable
+ *   without waiting for a full sync.
+ * - If no backup exists (first install), it runs the full `sync` pipeline to
+ *   generate artifacts from scratch.
+ * - Can be disabled entirely by setting `autoSync: false` in `Testwise.json`.
+ */
+export async function postinstall() {
+  try {
+    const autoSync = testwiseConfig().get('featureSettings.other.autoSync') ?? true;
+    if (!autoSync) return;
+
+    const rootDir = path.resolve(_dirname, '..');
+    const artifactManager = new ArtifactManager();
+
+    if (artifactManager.backupExists()) {
+      artifactManager.restoreBackup();
+      console.info('Restored artifacts from backup.');
+
+      // eslint-disable-next-line @typescript-eslint/naming-convention
+      const { SubjectRegistration } = await import('../dist/artifact-builder/index.js');
+      const subjectRegistration = new SubjectRegistration();
+      await subjectRegistration.resetSubjectRegistry();
+      await subjectRegistration.run();
+
+      execSync('npx tsc', { cwd: rootDir, stdio: 'inherit' });
+
+      console.info('Postinstall restore process completed successfully.');
+
+      return;
+    }
+
+    await sync();
+  } catch (error) {
+    console.error('Postinstall process failed:', error.message);
+    process.exit(1);
+  }
+}

package/scripts/setup.js

@@ -1,37 +1,91 @@
-import fs from 'node:fs';
-import path from 'node:path';
-import { fileURLToPath } from 'node:url';
-import { PathResolver } from '../dist/helpers/index.js';
-
-const _filename = fileURLToPath(import.meta.url);
-const _dirname = path.dirname(_filename);
-
-export async function setup() {
-  try {
-    const consumerRoot = new PathResolver().getConsumerRootDirectory();
-    const testwiseConfigFile = path.resolve(consumerRoot, 'Testwise.json');
-    const testwiseConfigTemplateFile = path.join(_dirname, 'Testwise.template.json');
-    const tsConfigFile = path.resolve(consumerRoot, 'tsconfig.json');
-    const tsConfigTemplateFile = path.join(_dirname, 'tsconfig.template.json');
-
-    let filesCreated = false;
-
-    if (!fs.existsSync(testwiseConfigFile)) {
-      fs.copyFileSync(testwiseConfigTemplateFile, testwiseConfigFile);
-      console.info('Testwise.json config file created.');
-      filesCreated = true;
-    }
-
-    if (!fs.existsSync(tsConfigFile)) {
-      fs.copyFileSync(tsConfigTemplateFile, tsConfigFile);
-      console.info('tsconfig.json config file created.');
-      filesCreated = true;
-    }
-
-    if (!filesCreated) {
-      await new Promise((resolve) => setTimeout(resolve, 1000));
-    }
-  } catch (error) {
-    console.error('Error during installation:', error.message);
-  }
-}
+import fs from 'node:fs';
+import path from 'node:path';
+import { fileURLToPath } from 'node:url';
+import { PathResolver } from '../dist/helpers/index.js';
+
+const _filename = fileURLToPath(import.meta.url);
+const _dirname = path.dirname(_filename);
+
+/**
+ * Scaffolds the initial configuration files in a new consumer project.
+ *
+ * **What it does:** Called once via `testwise setup`. Copies template files
+ * into the consumer project root if they don't already exist:
+ * - `Testwise.json` — main configuration file (base URL, credentials, feature flags).
+ * - `tsconfig.json` — TypeScript configuration tuned for Testwise + Playwright.
+ *
+ * It never overwrites existing files, so it is safe to re-run.
+ *
+ * After running `setup`, fill in `Testwise.json` with your Indicium API URL
+ * and credentials, then run `testwise sync` to generate subject artifacts.
+ */
+export async function setup() {
+  try {
+    const consumerRoot = new PathResolver().getConsumerRootDirectory();
+    const testwiseConfigFile = path.resolve(consumerRoot, 'Testwise.json');
+    const testwiseConfigTemplateFile = path.join(_dirname, 'Testwise.template.json');
+    const tsConfigFile = path.resolve(consumerRoot, 'tsconfig.json');
+    const tsConfigTemplateFile = path.join(_dirname, 'tsconfig.template.json');
+
+    let filesCreated = false;
+
+    if (!fs.existsSync(testwiseConfigFile)) {
+      fs.copyFileSync(testwiseConfigTemplateFile, testwiseConfigFile);
+      console.info('Testwise.json config file created.');
+      filesCreated = true;
+    }
+
+    if (!fs.existsSync(tsConfigFile)) {
+      fs.copyFileSync(tsConfigTemplateFile, tsConfigFile);
+      console.info('tsconfig.json config file created.');
+      filesCreated = true;
+    }
+
+    const githubDir = path.resolve(consumerRoot, '.github');
+    const githubInstructionsDir = path.resolve(githubDir, 'instructions');
+    const githubAgentsDir = path.resolve(githubDir, 'agents');
+    const testwiseInstructionsFile = path.resolve(githubInstructionsDir, 'testwise.instructions.md');
+    const testwiseInstructionsTemplateFile = path.join(_dirname, '..', 'templates', 'copilot-instructions.md');
+    const testwiseAgentFile = path.resolve(githubAgentsDir, 'testwise-test-expert.agent.md');
+    const testwiseAgentTemplateFile = path.join(_dirname, '..', 'templates', 'testwise-test-expert.agent.md');
+
+    if (fs.existsSync(testwiseInstructionsTemplateFile)) {
+      if (!fs.existsSync(githubInstructionsDir)) {
+        fs.mkdirSync(githubInstructionsDir, { recursive: true });
+      }
+      fs.copyFileSync(testwiseInstructionsTemplateFile, testwiseInstructionsFile);
+      console.info('Testwise Copilot instructions updated at .github/instructions/testwise.instructions.md');
+      filesCreated = true;
+    }
+
+    if (fs.existsSync(testwiseAgentTemplateFile)) {
+      if (!fs.existsSync(githubAgentsDir)) {
+        fs.mkdirSync(githubAgentsDir, { recursive: true });
+      }
+      fs.copyFileSync(testwiseAgentTemplateFile, testwiseAgentFile);
+      console.info('Testwise test expert agent updated at .github/agents/testwise-test-expert.agent.md');
+      filesCreated = true;
+    }
+
+    const copilotInstructionsFile = path.resolve(githubDir, 'copilot-instructions.md');
+
+    if (!fs.existsSync(copilotInstructionsFile)) {
+      if (!fs.existsSync(githubDir)) {
+        fs.mkdirSync(githubDir, { recursive: true });
+      }
+      fs.writeFileSync(
+        copilotInstructionsFile,
+        '# Project Copilot Instructions\n\nAdd your project-specific AI instructions here.\n\n<!-- Testwise instructions are auto-loaded from .github/instructions/testwise.instructions.md -->\n',
+        'utf-8'
+      );
+      console.info('Copilot instructions starter created at .github/copilot-instructions.md');
+      filesCreated = true;
+    }
+
+    if (!filesCreated) {
+      await new Promise((resolve) => setTimeout(resolve, 1000));
+    }
+  } catch (error) {
+    console.error('Error during installation:', error.message);
+  }
+}