@sun-asterisk/sungen 3.2.33 → 3.2.34

package/src/orchestrator/trace-mode-install.ts

@@ -0,0 +1,94 @@
+/**
+ * Move an existing project's `use.trace` off the old default so local runs keep a trace.
+ *
+ * The old template paired `trace: 'on-first-retry'` with `retries: process.env.CI ? 2 : 0`: off CI
+ * there is no retry, so there is never a "first retry" and a QA fixing a test on their machine never
+ * got a trace. The template now records `on-first-retry` on CI and `retain-on-failure` locally.
+ *
+ * `playwright.config.ts` is written once at `sungen init` and never re-synced (see
+ * report-sanitize-reporter-install.ts, the same problem for the sanitize reporter), so `sungen update`
+ * calls this. It rewrites the trace line ONLY while it is still the old default — any other value is
+ * a choice the user made, and a wrong edit to a user's config is worse than a missing trace. The same
+ * goes for a `trace` inside `projects: [...]`: that is a per-project override, not the template default.
+ */
+import * as fs from 'fs';
+import * as path from 'path';
+
+/** The template's trace value: cheap on CI (retries exist there), a trace for every local failure. */
+export const TRACE_MODE_EXPRESSION = "process.env.CI ? 'on-first-retry' : 'retain-on-failure'";
+
+/**
+ *   'patched' — the old default was rewritten now
+ *   'present' — already the template expression (idempotent)
+ *   'custom'  — another value, no trace line, more than one old-default line, or one inside
+ *               `projects: [...]`; nothing written
+ *   'absent'  — no playwright.config.ts (a mobile-only project, or not a sungen project)
+ */
+export type TraceModeOutcome = 'patched' | 'present' | 'custom' | 'absent';
+
+const escapeRegExp = (s: string): string => s.replace(/[.*+?^${}()|[\]\\]/g, '\\$&');
+
+// Both are anchored to the start of a line, so a commented-out copy (`// trace: …`) never counts.
+// OLD_DEFAULT keeps the indentation in $1 and leaves the trailing comma, comment and EOL alone.
+const OLD_DEFAULT = /^([ \t]*trace:[ \t]*)(['"])on-first-retry\2/gm;
+const PRESENT = new RegExp(`^[ \\t]*trace:[ \\t]*${escapeRegExp(TRACE_MODE_EXPRESSION)}`, 'm');
+
+// The old template's one-line comment, only when it sits directly above the (patched) trace line.
+// A comment the user wrote is theirs and stays.
+const OLD_COMMENT = new RegExp(
+  `^([ \\t]*)/\\* Collect trace when retrying the failed test\\. See https://playwright\\.dev/docs/trace-viewer \\*/(\\r?\\n)(?=[ \\t]*trace:[ \\t]*${escapeRegExp(TRACE_MODE_EXPRESSION)})`,
+  'm',
+);
+const newComment = (indent: string, eol: string): string =>
+  `${indent}/* Trace for a failed test. CI: recorded on the first retry (CI retries). Local: no retries, so${eol}` +
+  `${indent}   'on-first-retry' would never record one — keep the trace of every failed test instead.${eol}` +
+  `${indent}   See https://playwright.dev/docs/trace-viewer */${eol}`;
+
+/**
+ * [start, end] offsets of each live `projects: [...]` array, matched by bracket depth. Brackets inside
+ * a `//` or `/* *\/` comment or a quoted string are skipped: one stray `]` in a note would otherwise
+ * close the span early and expose a per-project override to the patch.
+ */
+function projectsSpans(src: string): Array<[number, number]> {
+  const spans: Array<[number, number]> = [];
+  for (const m of src.matchAll(/^[ \t]*projects\s*:\s*\[/gm)) {
+    const open = m.index! + m[0].length - 1;
+    let depth = 0;
+    for (let i = open; i < src.length; i++) {
+      const ch = src[i];
+      if (ch === '/' && src[i + 1] === '/') { const nl = src.indexOf('\n', i); i = nl < 0 ? src.length : nl; continue; }
+      if (ch === '/' && src[i + 1] === '*') { const end = src.indexOf('*/', i + 2); i = end < 0 ? src.length : end + 1; continue; }
+      if (ch === "'" || ch === '"' || ch === '`') {
+        for (i++; i < src.length && src[i] !== ch; i++) if (src[i] === '\\') i++;
+        continue;
+      }
+      if (ch === '[') depth++;
+      else if (ch === ']' && --depth === 0) { spans.push([open, i]); break; }
+    }
+  }
+  return spans;
+}
+
+export function patchTraceMode(cwd: string, dryRun: boolean = false): TraceModeOutcome {
+  const configPath = path.join(cwd, 'playwright.config.ts');
+  if (!fs.existsSync(configPath)) return 'absent';
+  const src = fs.readFileSync(configPath, 'utf8');
+  if (PRESENT.test(src)) return 'present';
+  const hits = [...src.matchAll(OLD_DEFAULT)];
+  if (hits.length !== 1) return 'custom'; // none: the user's own value · several: ambiguous, don't guess
+  const at = hits[0].index!;
+  if (projectsSpans(src).some(([s, e]) => at > s && at < e)) return 'custom'; // a per-project override
+  if (!dryRun) {
+    const patched = src
+      .replace(OLD_DEFAULT, `$1${TRACE_MODE_EXPRESSION}`)
+      .replace(OLD_COMMENT, (_m, indent: string, eol: string) => newComment(indent, eol));
+    fs.writeFileSync(configPath, patched);
+  }
+  return 'patched';
+}
+
+/** `sungen update` step: patch the trace mode and say so when it changed. */
+export function installTraceMode(cwd: string, dryRun: boolean = false): void {
+  if (patchTraceMode(cwd, dryRun) !== 'patched') return;
+  console.log(`${dryRun ? '📋 would update' : '✓ updated'} playwright.config.ts: local runs now keep a trace for every failed test (trace: ${TRACE_MODE_EXPRESSION})`);
+}

package/src/orchestrator/viewpoint-pattern-catalog.ts

@@ -0,0 +1,58 @@
+/**
+ * The sungen-viewpoint pattern catalog by number — the `## N. <Name>` headings of
+ * `templates/ai-src/skills/sungen-viewpoint/group-*.md` — for the "UI Patterns Identified" table
+ * `sungen add` scaffolds into `test-viewpoint.md` (#842).
+ *
+ * The scaffold used to hard-code its own ten rows: eight of them numbered differently from the
+ * catalog (Data Table 2 vs 7, Modal 9 vs 12…), plus a "Pagination" pattern the catalog does not
+ * have, so authors copied the wrong numbers next to a skill that cites the right ones.
+ * `tests/harness/viewpoint-comments-and-patterns.run.ts` pins this list to the catalog headings.
+ */
+export interface ViewpointPattern {
+  n: number;
+  name: string;
+  /** Group F — native-app patterns, read IN ADDITION to 1–17 for a mobile screen. */
+  mobile?: boolean;
+}
+
+export const VIEWPOINT_PATTERNS: readonly ViewpointPattern[] = [
+  { n: 1, name: 'Form & Inputs' },
+  { n: 2, name: 'File Upload' },
+  { n: 3, name: 'Import / Export' },
+  { n: 4, name: 'Create / Add' },
+  { n: 5, name: 'Update / Edit' },
+  { n: 6, name: 'Delete' },
+  { n: 7, name: 'Data Table' },
+  { n: 8, name: 'Search' },
+  { n: 9, name: 'Filter' },
+  { n: 10, name: 'List / Card View' },
+  { n: 11, name: 'Chart / Analytics' },
+  { n: 12, name: 'Modal / Dialog' },
+  { n: 13, name: 'Navigation' },
+  { n: 14, name: 'Notification / Toast / Alert' },
+  { n: 15, name: 'Login / Logout' },
+  { n: 16, name: 'Register' },
+  { n: 17, name: 'Password Management' },
+  { n: 18, name: 'Bottom Sheet', mobile: true },
+  { n: 19, name: 'Tab Bar / Bottom Navigation', mobile: true },
+  { n: 20, name: 'Swipe-to-Delete Row', mobile: true },
+  { n: 21, name: 'Native Picker', mobile: true },
+  { n: 22, name: 'Permission Dialog', mobile: true },
+  { n: 23, name: 'Biometric Prompt', mobile: true },
+  { n: 24, name: 'Camera / Gallery Picker', mobile: true },
+  { n: 25, name: 'Push Notification', mobile: true },
+  { n: 26, name: 'Deep-link Entry', mobile: true },
+  { n: 27, name: 'Offline Banner', mobile: true },
+  { n: 28, name: 'Onboarding Carousel', mobile: true },
+  { n: 29, name: 'Pull-to-Refresh List', mobile: true },
+  { n: 30, name: 'Soft-Keyboard Overlap', mobile: true },
+  { n: 31, name: 'Settings Toggle List', mobile: true },
+  { n: 32, name: 'App Lifecycle & Orientation', mobile: true },
+];
+
+/** The scaffold's pattern-table rows: 1–17 for every screen, plus Group F on a mobile project. */
+export function uiPatternRows(isMobile: boolean): string[] {
+  return VIEWPOINT_PATTERNS
+    .filter((p) => isMobile || !p.mobile)
+    .map((p) => `| ${p.n} | ${p.name} | ☐ | |`);
+}