@sun-asterisk/sungen 2.5.2 → 2.6.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (170) hide show
  1. package/dist/cli/commands/add-flow.d.ts +3 -0
  2. package/dist/cli/commands/add-flow.d.ts.map +1 -0
  3. package/dist/cli/commands/add-flow.js +27 -0
  4. package/dist/cli/commands/add-flow.js.map +1 -0
  5. package/dist/cli/commands/delivery.d.ts.map +1 -1
  6. package/dist/cli/commands/delivery.js +95 -60
  7. package/dist/cli/commands/delivery.js.map +1 -1
  8. package/dist/cli/commands/generate.d.ts.map +1 -1
  9. package/dist/cli/commands/generate.js +38 -6
  10. package/dist/cli/commands/generate.js.map +1 -1
  11. package/dist/cli/index.js +3 -1
  12. package/dist/cli/index.js.map +1 -1
  13. package/dist/generators/test-generator/adapters/adapter-interface.d.ts +1 -0
  14. package/dist/generators/test-generator/adapters/adapter-interface.d.ts.map +1 -1
  15. package/dist/generators/test-generator/adapters/playwright/playwright-adapter.d.ts +1 -0
  16. package/dist/generators/test-generator/adapters/playwright/playwright-adapter.d.ts.map +1 -1
  17. package/dist/generators/test-generator/adapters/playwright/playwright-adapter.js.map +1 -1
  18. package/dist/generators/test-generator/adapters/playwright/templates/imports.hbs +2 -2
  19. package/dist/generators/test-generator/adapters/playwright/templates/steps/actions/alert-accept-action.hbs +1 -1
  20. package/dist/generators/test-generator/adapters/playwright/templates/steps/actions/alert-dismiss-action.hbs +1 -1
  21. package/dist/generators/test-generator/adapters/playwright/templates/steps/actions/alert-fill-action.hbs +1 -1
  22. package/dist/generators/test-generator/adapters/playwright/templates/steps/assertions/alert-text-assertion.hbs +2 -2
  23. package/dist/generators/test-generator/adapters/playwright/templates/steps/assertions/column-cell-assertion.hbs +1 -0
  24. package/dist/generators/test-generator/adapters/playwright/templates/steps/navigation/navigation.hbs +2 -1
  25. package/dist/generators/test-generator/adapters/playwright/templates/steps/navigation/route-assertion.hbs +1 -2
  26. package/dist/generators/test-generator/adapters/playwright/templates/steps/navigation/wait-timeout.hbs +1 -1
  27. package/dist/generators/test-generator/code-generator.d.ts +1 -0
  28. package/dist/generators/test-generator/code-generator.d.ts.map +1 -1
  29. package/dist/generators/test-generator/code-generator.js +30 -12
  30. package/dist/generators/test-generator/code-generator.js.map +1 -1
  31. package/dist/generators/test-generator/step-mapper.d.ts +4 -0
  32. package/dist/generators/test-generator/step-mapper.d.ts.map +1 -1
  33. package/dist/generators/test-generator/step-mapper.js +7 -0
  34. package/dist/generators/test-generator/step-mapper.js.map +1 -1
  35. package/dist/generators/test-generator/template-engine.d.ts +1 -0
  36. package/dist/generators/test-generator/template-engine.d.ts.map +1 -1
  37. package/dist/generators/test-generator/template-engine.js +1 -1
  38. package/dist/generators/test-generator/template-engine.js.map +1 -1
  39. package/dist/generators/test-generator/utils/data-resolver.d.ts +3 -20
  40. package/dist/generators/test-generator/utils/data-resolver.d.ts.map +1 -1
  41. package/dist/generators/test-generator/utils/data-resolver.js +23 -66
  42. package/dist/generators/test-generator/utils/data-resolver.js.map +1 -1
  43. package/dist/generators/test-generator/utils/selector-resolver.d.ts +2 -6
  44. package/dist/generators/test-generator/utils/selector-resolver.d.ts.map +1 -1
  45. package/dist/generators/test-generator/utils/selector-resolver.js +18 -80
  46. package/dist/generators/test-generator/utils/selector-resolver.js.map +1 -1
  47. package/dist/orchestrator/ai-rules-updater.d.ts.map +1 -1
  48. package/dist/orchestrator/ai-rules-updater.js +4 -0
  49. package/dist/orchestrator/ai-rules-updater.js.map +1 -1
  50. package/dist/orchestrator/flow-manager.d.ts +22 -0
  51. package/dist/orchestrator/flow-manager.d.ts.map +1 -0
  52. package/dist/orchestrator/flow-manager.js +251 -0
  53. package/dist/orchestrator/flow-manager.js.map +1 -0
  54. package/dist/orchestrator/project-initializer.d.ts.map +1 -1
  55. package/dist/orchestrator/project-initializer.js +1 -0
  56. package/dist/orchestrator/project-initializer.js.map +1 -1
  57. package/dist/orchestrator/templates/ai-instructions/claude-cmd-add-flow.md +88 -0
  58. package/dist/orchestrator/templates/ai-instructions/claude-cmd-create-test.md +11 -8
  59. package/dist/orchestrator/templates/ai-instructions/claude-cmd-review.md +8 -6
  60. package/dist/orchestrator/templates/ai-instructions/claude-cmd-run-test.md +15 -11
  61. package/dist/orchestrator/templates/ai-instructions/claude-config.md +41 -10
  62. package/dist/orchestrator/templates/ai-instructions/claude-skill-capture-live.md +12 -0
  63. package/dist/orchestrator/templates/ai-instructions/claude-skill-delivery.md +19 -18
  64. package/dist/orchestrator/templates/ai-instructions/claude-skill-error-mapping.md +12 -0
  65. package/dist/orchestrator/templates/ai-instructions/claude-skill-gherkin-syntax.md +52 -0
  66. package/dist/orchestrator/templates/ai-instructions/claude-skill-selector-fix.md +31 -3
  67. package/dist/orchestrator/templates/ai-instructions/claude-skill-selector-keys.md +45 -0
  68. package/dist/orchestrator/templates/ai-instructions/claude-skill-tc-generation.md +69 -0
  69. package/dist/orchestrator/templates/ai-instructions/claude-skill-tc-review.md +30 -0
  70. package/dist/orchestrator/templates/ai-instructions/copilot-cmd-add-flow.md +86 -0
  71. package/dist/orchestrator/templates/ai-instructions/copilot-cmd-create-test.md +13 -10
  72. package/dist/orchestrator/templates/ai-instructions/copilot-cmd-delivery.md +16 -15
  73. package/dist/orchestrator/templates/ai-instructions/copilot-cmd-review.md +9 -7
  74. package/dist/orchestrator/templates/ai-instructions/copilot-cmd-run-test.md +21 -17
  75. package/dist/orchestrator/templates/ai-instructions/copilot-config.md +40 -9
  76. package/dist/orchestrator/templates/ai-instructions/github-skill-sungen-capture-live.md +12 -0
  77. package/dist/orchestrator/templates/ai-instructions/github-skill-sungen-delivery.md +19 -18
  78. package/dist/orchestrator/templates/ai-instructions/github-skill-sungen-error-mapping.md +12 -0
  79. package/dist/orchestrator/templates/ai-instructions/github-skill-sungen-gherkin-syntax.md +52 -0
  80. package/dist/orchestrator/templates/ai-instructions/github-skill-sungen-selector-fix.md +31 -3
  81. package/dist/orchestrator/templates/ai-instructions/github-skill-sungen-selector-keys.md +45 -0
  82. package/dist/orchestrator/templates/ai-instructions/github-skill-sungen-tc-generation.md +70 -0
  83. package/dist/orchestrator/templates/ai-instructions/github-skill-sungen-tc-review.md +30 -0
  84. package/dist/orchestrator/templates/playwright.config.d.ts.map +1 -1
  85. package/dist/orchestrator/templates/playwright.config.js +3 -1
  86. package/dist/orchestrator/templates/playwright.config.js.map +1 -1
  87. package/dist/orchestrator/templates/playwright.config.ts +4 -1
  88. package/dist/orchestrator/templates/specs-base.d.ts.map +1 -1
  89. package/dist/orchestrator/templates/specs-base.js +11 -56
  90. package/dist/orchestrator/templates/specs-base.js.map +1 -1
  91. package/dist/orchestrator/templates/specs-base.ts +11 -61
  92. package/dist/orchestrator/templates/specs-test-data.d.ts +3 -1
  93. package/dist/orchestrator/templates/specs-test-data.d.ts.map +1 -1
  94. package/dist/orchestrator/templates/specs-test-data.js +10 -2
  95. package/dist/orchestrator/templates/specs-test-data.js.map +1 -1
  96. package/dist/orchestrator/templates/specs-test-data.ts +9 -2
  97. package/package.json +1 -1
  98. package/src/cli/commands/add-flow.ts +25 -0
  99. package/src/cli/commands/delivery.ts +109 -58
  100. package/src/cli/commands/generate.ts +43 -6
  101. package/src/cli/index.ts +3 -1
  102. package/src/generators/test-generator/adapters/adapter-interface.ts +1 -1
  103. package/src/generators/test-generator/adapters/playwright/playwright-adapter.ts +1 -1
  104. package/src/generators/test-generator/adapters/playwright/templates/imports.hbs +2 -2
  105. package/src/generators/test-generator/adapters/playwright/templates/steps/actions/alert-accept-action.hbs +1 -1
  106. package/src/generators/test-generator/adapters/playwright/templates/steps/actions/alert-dismiss-action.hbs +1 -1
  107. package/src/generators/test-generator/adapters/playwright/templates/steps/actions/alert-fill-action.hbs +1 -1
  108. package/src/generators/test-generator/adapters/playwright/templates/steps/assertions/alert-text-assertion.hbs +2 -2
  109. package/src/generators/test-generator/adapters/playwright/templates/steps/assertions/column-cell-assertion.hbs +1 -0
  110. package/src/generators/test-generator/adapters/playwright/templates/steps/navigation/navigation.hbs +2 -1
  111. package/src/generators/test-generator/adapters/playwright/templates/steps/navigation/route-assertion.hbs +1 -2
  112. package/src/generators/test-generator/adapters/playwright/templates/steps/navigation/wait-timeout.hbs +1 -1
  113. package/src/generators/test-generator/code-generator.ts +32 -14
  114. package/src/generators/test-generator/step-mapper.ts +8 -0
  115. package/src/generators/test-generator/template-engine.ts +2 -2
  116. package/src/generators/test-generator/utils/data-resolver.ts +25 -77
  117. package/src/generators/test-generator/utils/selector-resolver.ts +23 -109
  118. package/src/orchestrator/ai-rules-updater.ts +5 -0
  119. package/src/orchestrator/flow-manager.ts +243 -0
  120. package/src/orchestrator/project-initializer.ts +1 -0
  121. package/src/orchestrator/templates/ai-instructions/claude-cmd-add-flow.md +88 -0
  122. package/src/orchestrator/templates/ai-instructions/claude-cmd-create-test.md +11 -8
  123. package/src/orchestrator/templates/ai-instructions/claude-cmd-review.md +8 -6
  124. package/src/orchestrator/templates/ai-instructions/claude-cmd-run-test.md +15 -11
  125. package/src/orchestrator/templates/ai-instructions/claude-config.md +41 -10
  126. package/src/orchestrator/templates/ai-instructions/claude-skill-capture-live.md +12 -0
  127. package/src/orchestrator/templates/ai-instructions/claude-skill-delivery.md +19 -18
  128. package/src/orchestrator/templates/ai-instructions/claude-skill-error-mapping.md +12 -0
  129. package/src/orchestrator/templates/ai-instructions/claude-skill-gherkin-syntax.md +52 -0
  130. package/src/orchestrator/templates/ai-instructions/claude-skill-selector-fix.md +31 -3
  131. package/src/orchestrator/templates/ai-instructions/claude-skill-selector-keys.md +45 -0
  132. package/src/orchestrator/templates/ai-instructions/claude-skill-tc-generation.md +69 -0
  133. package/src/orchestrator/templates/ai-instructions/claude-skill-tc-review.md +30 -0
  134. package/src/orchestrator/templates/ai-instructions/copilot-cmd-add-flow.md +86 -0
  135. package/src/orchestrator/templates/ai-instructions/copilot-cmd-create-test.md +13 -10
  136. package/src/orchestrator/templates/ai-instructions/copilot-cmd-delivery.md +16 -15
  137. package/src/orchestrator/templates/ai-instructions/copilot-cmd-review.md +9 -7
  138. package/src/orchestrator/templates/ai-instructions/copilot-cmd-run-test.md +21 -17
  139. package/src/orchestrator/templates/ai-instructions/copilot-config.md +40 -9
  140. package/src/orchestrator/templates/ai-instructions/github-skill-sungen-capture-live.md +12 -0
  141. package/src/orchestrator/templates/ai-instructions/github-skill-sungen-delivery.md +19 -18
  142. package/src/orchestrator/templates/ai-instructions/github-skill-sungen-error-mapping.md +12 -0
  143. package/src/orchestrator/templates/ai-instructions/github-skill-sungen-gherkin-syntax.md +52 -0
  144. package/src/orchestrator/templates/ai-instructions/github-skill-sungen-selector-fix.md +31 -3
  145. package/src/orchestrator/templates/ai-instructions/github-skill-sungen-selector-keys.md +45 -0
  146. package/src/orchestrator/templates/ai-instructions/github-skill-sungen-tc-generation.md +70 -0
  147. package/src/orchestrator/templates/ai-instructions/github-skill-sungen-tc-review.md +30 -0
  148. package/src/orchestrator/templates/playwright.config.ts +4 -1
  149. package/src/orchestrator/templates/specs-base.ts +11 -61
  150. package/src/orchestrator/templates/specs-test-data.ts +9 -2
  151. package/dist/utils/feature-finder.d.ts +0 -9
  152. package/dist/utils/feature-finder.d.ts.map +0 -1
  153. package/dist/utils/feature-finder.js +0 -67
  154. package/dist/utils/feature-finder.js.map +0 -1
  155. package/dist/utils/screen-paths.d.ts +0 -10
  156. package/dist/utils/screen-paths.d.ts.map +0 -1
  157. package/dist/utils/screen-paths.js +0 -73
  158. package/dist/utils/screen-paths.js.map +0 -1
  159. package/dist/utils/selector-loader.d.ts +0 -6
  160. package/dist/utils/selector-loader.d.ts.map +0 -1
  161. package/dist/utils/selector-loader.js +0 -20
  162. package/dist/utils/selector-loader.js.map +0 -1
  163. package/dist/utils/test-data-loader.d.ts +0 -6
  164. package/dist/utils/test-data-loader.d.ts.map +0 -1
  165. package/dist/utils/test-data-loader.js +0 -20
  166. package/dist/utils/test-data-loader.js.map +0 -1
  167. package/src/utils/feature-finder.ts +0 -33
  168. package/src/utils/screen-paths.ts +0 -37
  169. package/src/utils/selector-loader.ts +0 -23
  170. package/src/utils/test-data-loader.ts +0 -23
@@ -0,0 +1,243 @@
1
+ /**
2
+ * Flow Manager
3
+ * Manages flow definition files in qa/flows directory
4
+ * Flows are independent E2E test journeys spanning multiple screens
5
+ */
6
+
7
+ import * as fs from 'fs';
8
+ import * as path from 'path';
9
+
10
+ export interface FlowOptions {
11
+ name: string;
12
+ path?: string;
13
+ description?: string;
14
+ }
15
+
16
+ export class FlowManager {
17
+ private cwd: string;
18
+ private flowsDir: string;
19
+
20
+ constructor() {
21
+ this.cwd = process.cwd();
22
+ this.flowsDir = path.join(this.cwd, 'qa', 'flows');
23
+ }
24
+
25
+ async addFlow(options: FlowOptions): Promise<void> {
26
+ this.validateFlowName(options.name);
27
+
28
+ const flowName = this.normalizeFlowName(options.name);
29
+ const flowDir = path.join(this.flowsDir, flowName);
30
+
31
+ const featuresDir = path.join(flowDir, 'features');
32
+ const selectorsDir = path.join(flowDir, 'selectors');
33
+ const testDataDir = path.join(flowDir, 'test-data');
34
+ const requirementsDir = path.join(flowDir, 'requirements');
35
+ const requirementsUiDir = path.join(requirementsDir, 'ui');
36
+
37
+ const featurePath = path.join(featuresDir, `${flowName}.feature`);
38
+ const selectorPath = path.join(selectorsDir, `${flowName}.yaml`);
39
+ const testDataPath = path.join(testDataDir, `${flowName}.yaml`);
40
+
41
+ if (fs.existsSync(flowDir)) {
42
+ console.error(`Error: Flow "${options.name}" already exists at ${flowDir}`);
43
+ process.exit(1);
44
+ }
45
+
46
+ console.log(`Creating flow: ${options.name}\n`);
47
+
48
+ try {
49
+ if (!fs.existsSync(this.flowsDir)) {
50
+ fs.mkdirSync(this.flowsDir, { recursive: true });
51
+ }
52
+ fs.mkdirSync(featuresDir, { recursive: true });
53
+ fs.mkdirSync(selectorsDir, { recursive: true });
54
+ fs.mkdirSync(testDataDir, { recursive: true });
55
+ fs.mkdirSync(requirementsUiDir, { recursive: true });
56
+ } catch (error) {
57
+ console.error(`Error: Failed to create directories`);
58
+ console.error(` ${error instanceof Error ? error.message : String(error)}`);
59
+ process.exit(1);
60
+ }
61
+
62
+ fs.writeFileSync(featurePath, this.generateFeatureTemplate(options, flowName), 'utf-8');
63
+
64
+ const startPath = options.path || '/login';
65
+ fs.writeFileSync(selectorPath, [
66
+ `# ${options.name} Flow Selectors`,
67
+ `# Namespace keys by screen to avoid duplicates: "login:submit", "awards:submit"`,
68
+ ``,
69
+ `# --- Login screen ---`,
70
+ `login:`,
71
+ ` type: 'page'`,
72
+ ` value: '${startPath}'`,
73
+ ``,
74
+ `# "login:email":`,
75
+ `# type: 'testid'`,
76
+ `# value: 'email-input'`,
77
+ ``,
78
+ `# "login:submit":`,
79
+ `# type: 'role'`,
80
+ `# value: 'button'`,
81
+ `# name: 'Login'`,
82
+ ``,
83
+ ].join('\n'), 'utf-8');
84
+
85
+ fs.writeFileSync(testDataPath, [
86
+ `# ${options.name} Flow Test Data`,
87
+ `# Namespace by phase: login.email, submission.nominee`,
88
+ `# Reference in features using {{variable}} syntax`,
89
+ ``,
90
+ ].join('\n'), 'utf-8');
91
+
92
+ const specPath = path.join(requirementsDir, 'spec.md');
93
+ fs.writeFileSync(specPath, this.generateSpecTemplate(options, flowName), 'utf-8');
94
+
95
+ const viewpointPath = path.join(requirementsDir, 'test-viewpoint.md');
96
+ fs.writeFileSync(viewpointPath, this.generateViewpointTemplate(options), 'utf-8');
97
+
98
+ console.log(`Created files:`);
99
+ console.log(` ${path.relative(this.cwd, featurePath)}`);
100
+ console.log(` ${path.relative(this.cwd, selectorPath)}`);
101
+ console.log(` ${path.relative(this.cwd, testDataPath)}`);
102
+ console.log(` ${path.relative(this.cwd, specPath)}`);
103
+ console.log(` ${path.relative(this.cwd, viewpointPath)}`);
104
+ console.log(` ${path.relative(this.cwd, requirementsUiDir)}/`);
105
+ console.log('');
106
+
107
+ console.log('Next steps:');
108
+ console.log(` 1. Fill requirements/spec.md with flow specification (screens, transitions, business rules)`);
109
+ console.log(` Optionally add UI designs to requirements/ui/`);
110
+ console.log(` 2. Generate test cases: /sungen:create-test ${flowName}`);
111
+ console.log(` 3. Compile: sungen generate --flow ${flowName}`);
112
+ console.log(` 4. Run: npx playwright test\n`);
113
+ }
114
+
115
+ private validateFlowName(name: string): void {
116
+ if (!name || name.trim().length === 0) {
117
+ console.error('Error: Flow name cannot be empty');
118
+ process.exit(1);
119
+ }
120
+ if (!/[a-zA-Z0-9]/.test(name)) {
121
+ console.error('Error: Flow name must contain at least one alphanumeric character');
122
+ process.exit(1);
123
+ }
124
+ }
125
+
126
+ private normalizeFlowName(name: string): string {
127
+ return name
128
+ .toLowerCase()
129
+ .replace(/[^a-z0-9]+/g, '-')
130
+ .replace(/^-+|-+$/g, '')
131
+ .replace(/-+/g, '-');
132
+ }
133
+
134
+ private generateSpecTemplate(options: FlowOptions, flowName: string): string {
135
+ const startPath = options.path || '/login';
136
+ return `# ${options.name} Flow Specification
137
+
138
+ ## Overview
139
+ - **Start URL:** ${startPath}
140
+ - **Auth Required:** no
141
+ - **Platform:** web
142
+
143
+ ## Screens in Flow
144
+ <!-- List all screens this flow visits, in order -->
145
+
146
+ | # | Screen | URL Path | Description |
147
+ |---|--------|----------|-------------|
148
+ | 1 | [Screen Name] | ${startPath} | [What user does here] |
149
+
150
+ ## Flow Steps
151
+
152
+ ### Step 1: [Screen Name]
153
+ - **Action:** [What the user does]
154
+ - **Expected:** [What should happen]
155
+ - **Transition:** Navigates to Step 2
156
+
157
+ ## Business Rules
158
+ <!-- Rules that affect the flow: permissions, conditions, limits -->
159
+ - [Rule 1]
160
+
161
+ ## Notes
162
+ <!-- Edge cases, known issues, environment-specific behavior -->
163
+ - [Note 1]
164
+ `;
165
+ }
166
+
167
+ private generateViewpointTemplate(options: FlowOptions): string {
168
+ return [
169
+ `# ${options.name} Flow — Test Viewpoints`,
170
+ '',
171
+ '## Edge Cases',
172
+ '',
173
+ '<!-- Sample — replace with actual edge cases for this flow:',
174
+ '- Network drops between screen transitions — should resume or show error?',
175
+ '- Session expires mid-flow — should redirect to login and preserve progress?',
176
+ '- Browser back button at step 3 — should return to step 2 with data intact?',
177
+ '- Complete flow twice rapidly — should prevent duplicate submissions',
178
+ '-->',
179
+ '',
180
+ '## Known Issues',
181
+ '',
182
+ '<!-- Sample — replace with actual known issues:',
183
+ '- [BUG-001] Form data lost if user navigates away and returns',
184
+ '- [BUG-002] Confirmation page shows stale data on slow connections',
185
+ '-->',
186
+ '',
187
+ '## Design Decisions',
188
+ '',
189
+ '<!-- Sample — replace with actual design decisions:',
190
+ '- Flow requires completing all steps in order (no skip)',
191
+ '- Draft is auto-saved at each step transition',
192
+ '- Cancel at any step discards the entire flow',
193
+ '-->',
194
+ '',
195
+ '## Cross-Screen Concerns',
196
+ '',
197
+ '<!-- Sample — replace with actual cross-screen concerns:',
198
+ '- Auth role must remain consistent across all screens',
199
+ '- Data entered in step 1 must be visible in confirmation (step 3)',
200
+ '- Error in step 2 should allow returning to step 1 without re-entering data',
201
+ '-->',
202
+ '',
203
+ '## Priority Viewpoints',
204
+ '',
205
+ '<!-- Rate importance for this flow (High / Medium / Low / Skip):',
206
+ '',
207
+ '| VP | Priority | Reason |',
208
+ '|---|----------|--------|',
209
+ '| VP-UI | Medium | Standard forms across screens |',
210
+ '| VP-VAL | High | Cross-screen validation rules |',
211
+ '| VP-LOGIC | High | Multi-step business logic, state transitions |',
212
+ '| VP-SEC | Medium | Auth must persist, role-based access at each screen |',
213
+ '-->',
214
+ '',
215
+ ].join('\n');
216
+ }
217
+
218
+ private generateFeatureTemplate(options: FlowOptions, flowName: string): string {
219
+ const description = options.description || `complete the ${options.name} flow`;
220
+
221
+ return `@flow
222
+ Feature: ${options.name} Flow
223
+
224
+ As a user
225
+ I want to ${description}
226
+ So that I can accomplish my end-to-end goal
227
+
228
+ Background:
229
+ Given User is on [Login] page
230
+
231
+ @high @auth:user
232
+ Scenario: User login successfully
233
+ When User fill [Login:Email] field with {{login.email}}
234
+ And User fill [Login:Password] field with {{login.password}}
235
+ And User click [Login:Submit] button
236
+ Then User see [Dashboard] page
237
+
238
+ Scenario: Sample next step for ${options.name}
239
+ When User click [Dashboard:Element] button
240
+ Then User see "expected result" text
241
+ `;
242
+ }
243
+ }
@@ -90,6 +90,7 @@ export class ProjectInitializer {
90
90
  const dirs = [
91
91
  'qa',
92
92
  'qa/screens',
93
+ 'qa/flows',
93
94
  'specs',
94
95
  'specs/generated',
95
96
  'specs/storage',
@@ -0,0 +1,88 @@
1
+ ---
2
+ name: add-flow
3
+ description: 'Add a new Sungen flow — scaffolds directories for E2E cross-screen testing, helps fill spec.md, and can capture visuals via the capture skills'
4
+ argument-hint: [flow-name] [--path <start-url>]
5
+ allowed-tools: Read, Grep, Bash, Glob, Edit, Write, AskUserQuestion, mcp__playwright__browser_navigate, mcp__playwright__browser_take_screenshot, mcp__playwright__browser_snapshot, mcp__figma__get_design_context, mcp__figma__get_variable_defs, mcp__figma__get_screenshot
6
+ ---
7
+
8
+ You are adding a new Sungen flow for E2E cross-screen test generation.
9
+
10
+ ## Parameters
11
+
12
+ Parse from `$ARGUMENTS`:
13
+ - **flow** — flow name (e.g., `award-submission`, `user-onboarding`)
14
+ - **--path \<url\>** — starting page URL path (default: `/login`)
15
+ - **--description \<text\>** — flow description (optional)
16
+
17
+ If **flow** is missing, ask: "What is the flow name? (e.g., `award-submission`, `user-onboarding`)"
18
+ If **path** is missing, ask: "What is the starting URL path? (e.g., `/login`)"
19
+
20
+ ## Steps
21
+
22
+ ### 1. Scaffold the flow
23
+
24
+ ```bash
25
+ sungen add-flow --flow <name> --path <path>
26
+ ```
27
+
28
+ This creates:
29
+ ```
30
+ qa/flows/<name>/
31
+ ├── features/<name>.feature # Gherkin with @flow tag, Background, sample scenarios
32
+ ├── selectors/<name>.yaml # Namespaced keys: "login:submit", "awards:submit"
33
+ ├── test-data/<name>.yaml # Namespaced data: login.email, submission.nominee
34
+ └── requirements/
35
+ ├── spec.md # Flow specification
36
+ └── ui/ # Screenshots, mockups
37
+ ```
38
+
39
+ ### 1a. Identify the screens in the flow
40
+
41
+ Ask the user: "Which screens does this flow visit, in order? (e.g., login → dashboard → award-form → confirmation)"
42
+
43
+ Record the screen list — you will need it for:
44
+ - Filling `spec.md` (Step 3)
45
+ - Suggesting `[Screen:Element]` namespace prefixes
46
+ - Capturing visuals per screen (Step 2)
47
+
48
+ ### 2. Capture visual source
49
+
50
+ Use `AskUserQuestion`: *"Pick a visual source for this flow's screens:"*
51
+ - **Figma designs** (Recommended for pre-launch) — invoke `sungen-capture-figma` skill for each screen
52
+ - **Live page scan** (dev/staging is up) — invoke `sungen-capture-live` skill for each screen URL
53
+ - **Local images** — invoke `sungen-capture-local` skill to load from `requirements/ui/`
54
+ - **Skip** — user will drop images manually into `requirements/ui/` later
55
+
56
+ Each capture skill writes outputs into `qa/flows/<name>/requirements/ui/` and reports back a summary. Do not inline capture logic here — always delegate to the skill so behavior stays consistent with `/sungen:create-test`.
57
+
58
+ ### 3. Fill spec.md
59
+
60
+ Use `AskUserQuestion`: *"Fill `spec.md` now? (You can reference the captured visuals)"* — offer **Yes, fill now (Recommended)** / **Skip, fill later**.
61
+
62
+ If yes → open `qa/flows/<name>/requirements/spec.md` and help the user fill:
63
+ - **Screens list** — ordered list of screens with URL paths
64
+ - **Flow steps** — what the user does at each screen
65
+ - **Transitions** — what triggers navigation between screens
66
+ - **Business rules** — cross-screen validation, state that persists
67
+ - **Test data** — what data is entered at each screen
68
+
69
+ Reference the captured visuals from Step 2 to suggest field names, form elements, and UI states.
70
+
71
+ ### 4. Next steps
72
+
73
+ Tell the user what was created, then use `AskUserQuestion` to offer next steps:
74
+
75
+ - **`/sungen:create-test <name>`** — Create test scenarios for the flow (Recommended)
76
+ - **Done for now** — I'll come back later
77
+
78
+ If user picks `/sungen:create-test`, **you MUST use the Skill tool** to invoke it. Do NOT generate test cases yourself — the skill auto-loads `sungen-gherkin-syntax` and `sungen-tc-generation`.
79
+
80
+ ## Key Rules
81
+
82
+ - Flows are **independent** from screens — own selectors, own test-data
83
+ - Selectors use `[Screen:Element]` namespace format with colon
84
+ - YAML keys must be **quoted** due to colon: `"login:submit":`
85
+ - Test data namespaced by phase: `login.email`, `submission.nominee`
86
+ - `@flow` tag required at feature level
87
+ - `Background:` should only contain the starting page navigation
88
+ - Each scenario = one phase of the journey
@@ -19,13 +19,16 @@ You are a **Senior QA Engineer** specialized in test case design. You structure
19
19
 
20
20
  ## Parameters
21
21
 
22
- Parse **screen** from `$ARGUMENTS`. If missing, ask the user.
22
+ Parse **name** from `$ARGUMENTS`. If missing, ask the user.
23
+
24
+ **Auto-detect context**: check if `qa/flows/<name>/` exists → flow mode. Else check `qa/screens/<name>/` → screen mode. This determines paths, generation strategy, and CLI commands.
23
25
 
24
26
  ## Steps
25
27
 
26
- 1. Verify `qa/screens/<screen>/` exists. If not → `/sungen:add-screen` first.
28
+ 1. **Flow**: Verify `qa/flows/<name>/` exists. If not → `/sungen:add-flow` first.
29
+ **Screen**: Verify `qa/screens/<name>/` exists. If not → `/sungen:add-screen` first.
27
30
  2. Check if `.feature` file already has scenarios. If yes → use `AskUserQuestion` to ask the update mode (see `sungen-tc-generation` skill for details). If no → fresh creation.
28
- 3. **Read requirements & resolve visual source** — check `qa/screens/<screen>/requirements/`:
31
+ 3. **Read requirements & resolve visual source** — check `qa/<screens|flows>/<name>/requirements/`:
29
32
  - If `spec.md` exists → read it as PRIMARY source (sections, fields, validation rules, business rules, states).
30
33
  - If `test-viewpoint.md` exists → read it. If it only contains HTML comments (scaffold template), use `AskUserQuestion` to ask:
31
34
  - **Fill test-viewpoint.md first** — I'll help you identify edge cases, known issues, and design decisions for this screen before generating tests
@@ -44,13 +47,13 @@ Parse **screen** from `$ARGUMENTS`. If missing, ask the user.
44
47
 
45
48
  Summarize what you found in requirements and present to the user.
46
49
 
47
- 4. Follow the `sungen-tc-generation` skill for section identification, viewpoint generation, and output format. When requirements exist, use the "Requirements-Driven Generation" strategy.
48
- 5. Generate or update `.feature` + `test-data.yaml` following `sungen-gherkin-syntax` and `sungen-tc-generation` skills.
50
+ 4. Follow the `sungen-tc-generation` skill for section identification, viewpoint generation, and output format. **For flows**, use the "Flow Test Generation" section in the skill. When requirements exist, use the "Requirements-Driven Generation" strategy.
51
+ 5. Generate or update `.feature` + `test-data.yaml` following `sungen-gherkin-syntax` and `sungen-tc-generation` skills. **For flows**: use `[Screen:Element]` namespace format, namespace test-data by phase, add `@flow` tag.
49
52
  6. Show summary, then use `AskUserQuestion` to offer next steps:
50
53
 
51
- - **`/sungen:review <screen>`** — Review syntax, coverage, viewpoint quality (Recommended)
52
- - **`/sungen:run-test <screen>`** — Skip review, generate selectors and run tests now
53
- - **`/sungen:create-test <screen>`** — Expand coverage: add @normal + @low scenarios
54
+ - **`/sungen:review <name>`** — Review syntax, coverage, viewpoint quality (Recommended)
55
+ - **`/sungen:run-test <name>`** — Skip review, generate selectors and run tests now
56
+ - **`/sungen:create-test <name>`** — Expand coverage: add @normal + @low scenarios
54
57
  - **Done for now** — I'll come back later
55
58
 
56
59
  **No selectors.yaml** — selectors are generated during `/sungen:run-test`.
@@ -11,17 +11,19 @@ You are a **Senior QA Reviewer**. You evaluate Gherkin test cases using the `sun
11
11
 
12
12
  ## Parameters
13
13
 
14
- Parse **screen** from `$ARGUMENTS`. If missing, ask the user.
14
+ Parse **name** from `$ARGUMENTS`. If missing, ask the user.
15
+
16
+ **Auto-detect context**: check if `qa/flows/<name>/` exists → flow mode (base path: `qa/flows/<name>/`). Else check `qa/screens/<name>/` → screen mode (base path: `qa/screens/<name>/`).
15
17
 
16
18
  ## Steps
17
19
 
18
- 1. Read `qa/screens/<screen>/features/<screen>.feature` and `qa/screens/<screen>/test-data/<screen>.yaml`. If missing → `/sungen:create-test` first.
19
- 2. Follow the `sungen-tc-review` skill — score 3 dimensions: Syntax (30pts), Coverage (40pts), Viewpoint (30pts). Use `sungen-viewpoint` for pattern checklists.
20
- 3. **Unverified Selectors check** — if `qa/screens/<screen>/selectors/<screen>.yaml` exists, count lines matching `@needs-live-verify`. Include in the review report as a non-scoring metric (see `sungen-tc-review` skill for report format). Does NOT affect the 60% threshold.
20
+ 1. Read `<base>/<name>/features/<name>.feature` and `<base>/<name>/test-data/<name>.yaml`. If missing → `/sungen:create-test` first.
21
+ 2. Follow the `sungen-tc-review` skill — score 3 dimensions: Syntax (30pts), Coverage (40pts), Viewpoint (30pts). **For flows**, also apply the "Flow Review Additions" section. Use `sungen-viewpoint` for pattern checklists.
22
+ 3. **Unverified Selectors check** — if `<base>/<name>/selectors/<name>.yaml` exists, count lines matching `@needs-live-verify`. Include in the review report as a non-scoring metric. Does NOT affect the 60% threshold.
21
23
  4. Output review report per `sungen-tc-review` format. **>= 60%**: PASS. **< 60%**: FAIL with recommendations.
22
24
  5. If FAIL and user confirms → update test cases following `sungen-gherkin-syntax` and `sungen-tc-generation` skills, then re-review.
23
25
  6. After PASS (or user decides to proceed), use `AskUserQuestion` to offer next steps:
24
26
 
25
- - **`/sungen:run-test <screen>`** — Generate selectors, compile, and run tests (Recommended)
26
- - **`/sungen:create-test <screen>`** — Add more test cases before running
27
+ - **`/sungen:run-test <name>`** — Generate selectors, compile, and run tests (Recommended)
28
+ - **`/sungen:create-test <name>`** — Add more test cases before running
27
29
  - **Done for now** — I'll come back later
@@ -11,11 +11,13 @@ You are a **Senior Developer**. Use `sungen-selector-fix`, `sungen-selector-keys
11
11
 
12
12
  ## Parameters
13
13
 
14
- Parse **screen** from `$ARGUMENTS`. If missing, ask the user.
14
+ Parse **name** from `$ARGUMENTS`. If missing, ask the user.
15
+
16
+ **Auto-detect context**: check if `qa/flows/<name>/` exists → flow mode (base path: `qa/flows/<name>/`). Else check `qa/screens/<name>/` → screen mode (base path: `qa/screens/<name>/`).
15
17
 
16
18
  ## Pre-run (phased — per `sungen-selector-fix` skill)
17
19
 
18
- 1. Verify `qa/screens/<screen>/` has `.feature` + `test-data.yaml`.
20
+ 1. Verify `<base>/<name>/` has `.feature` + `test-data.yaml`.
19
21
  2. **Phase 0 — Selector Pre-gen**: if `selectors.yaml` is missing/empty or doesn't cover the feature file's `[Reference]`s, apply the following decision tree before running Phase 0 from `sungen-selector-fix`:
20
22
 
21
23
  ```
@@ -29,14 +31,14 @@ Parse **screen** from `$ARGUMENTS`. If missing, ask the user.
29
31
  2. Apply selector heuristics from sungen-figma-source skill (testid > role+name > placeholder > label > locator > text)
30
32
  3. Write selectors.yaml — every provisional entry gets this comment on the line above:
31
33
  # @needs-live-verify source=figma node_id=<id>
32
- 4. Compile: sungen generate --screen <screen> — must succeed
34
+ 4. Compile: Screen: sungen generate --screen <name>. Flow: sungen generate --flow <name> — must succeed
33
35
  5. Phase 1 smoke check runs; tests using unverified selectors may fail
34
36
  → auto-fix triggers on next run-test invocation when a live page is available
35
37
  NO → hard stop: print the following message and stop:
36
38
  "Cannot generate selectors: no live page URL and no spec_figma.md found.
37
39
  Options:
38
40
  • Provide the live URL so Playwright MCP can snapshot the page, OR
39
- • Run: sungen add --screen <screen> --figma <figma-url> to generate spec_figma.md first"
41
+ • Run: sungen add --screen <name> --figma <figma-url> to generate spec_figma.md first"
40
42
  ```
41
43
 
42
44
  **Auto-fix on subsequent runs**: when `run-test` is invoked again with a reachable live page, Phase 0 compares the DOM snapshot against existing `selectors.yaml` entries. Entries tagged `# @needs-live-verify` are treated as candidates — if the actual selector differs, the entry is replaced and the comment removed (entry becomes verified). Entries that already match are also promoted to verified (comment removed).
@@ -50,7 +52,7 @@ Parse **screen** from `$ARGUMENTS`. If missing, ask the user.
50
52
  name: "Submit"
51
53
  ```
52
54
  3. **Phase 0.5 — Auth Persistence**: if the feature has `@auth:<role>` tags and `specs/.auth/<role>.json` is missing/expired, run Phase 0.5 from `sungen-selector-fix` — user logs in manually in MCP browser → `browser_storage_state` → `specs/.auth/<role>.json`. Offer `sungen makeauth <role>` as CLI fallback only if `browser_storage_state` isn't available in this MCP version.
53
- 4. Compile: `sungen generate --screen <screen>` (default: runtime data loading from YAML). Use `--inline-data` only if user requests compile-time hardcoded values.
55
+ 4. Compile: **Screen**: `sungen generate --screen <name>`. **Flow**: `sungen generate --flow <name>`. Default: runtime data loading from YAML. Use `--inline-data` only if user requests compile-time hardcoded values.
54
56
 
55
57
  ## Run & Fix (phased — per `sungen-selector-fix` skill)
56
58
 
@@ -61,15 +63,17 @@ Parse **screen** from `$ARGUMENTS`. If missing, ask the user.
61
63
 
62
64
  ## Playwright command guidelines
63
65
 
64
- **Per-screen JSON results** — each run must write its JSON report to a dedicated path co-located with the `.spec.ts`, so `sungen delivery` can read the correct results per screen:
66
+ **Per-screen/flow JSON results** — each run must write its JSON report to a dedicated path co-located with the `.spec.ts`, so `sungen delivery` can read the correct results:
65
67
 
66
68
  ```bash
67
- # ✅ Correct — per-screen output file via env var
68
- PLAYWRIGHT_JSON_OUTPUT_NAME=specs/generated/<screen>/<screen>-test-result.json \
69
- npx playwright test specs/generated/<screen>/<screen>.spec.ts
70
- ```
69
+ # ✅ Screen
70
+ PLAYWRIGHT_JSON_OUTPUT_NAME=specs/generated/<name>/<name>-test-result.json \
71
+ npx playwright test specs/generated/<name>/<name>.spec.ts
71
72
 
72
- Output: `specs/generated/<screen>/<screen>-test-result.json`
73
+ # ✅ Flow
74
+ PLAYWRIGHT_JSON_OUTPUT_NAME=specs/generated/flows/<name>/<name>-test-result.json \
75
+ npx playwright test specs/generated/flows/<name>/<name>.spec.ts
76
+ ```
73
77
 
74
78
  **DO NOT** pass `--reporter=...` flag — it overrides the reporters from `playwright.config.ts` and disables the JSON reporter that `sungen delivery` depends on.
75
79
 
@@ -21,22 +21,28 @@ You generate 3 files for sungen — a Gherkin compiler that produces Playwright
21
21
  | `sungen-capture-live` | Capture a live running page via Playwright MCP (snapshot + screenshot) |
22
22
  | `sungen-figma-source` | Figma URL → spec_figma.md + ui/*.png + provisional selectors |
23
23
 
24
- ## Workflow (5 AI commands)
24
+ ## Workflow (6 AI commands)
25
25
 
26
26
  | Command | What it does |
27
27
  |---|---|
28
28
  | `/sungen:add-screen <name> <path>` | Scaffold `qa/screens/<name>/` directories |
29
- | `/sungen:create-test <name>` | Generate `.feature` + `test-data.yaml` (no selectors) |
30
- | `/sungen:review <name>` | Score syntax, coverage, viewpoint quality (60% threshold) |
31
- | `/sungen:run-test <name>` | Generate `selectors.yaml` from live page, compile, run, auto-fix |
29
+ | `/sungen:add-flow <name> [--path <url>]` | Scaffold `qa/flows/<name>/` directories for E2E cross-screen testing |
30
+ | `/sungen:create-test <name>` | Generate `.feature` + `test-data.yaml` (auto-detects screen or flow) |
31
+ | `/sungen:review <name>` | Score syntax, coverage, viewpoint quality (auto-detects screen or flow) |
32
+ | `/sungen:run-test <name>` | Generate `selectors.yaml`, compile, run, auto-fix (auto-detects screen or flow) |
32
33
  | `/sungen:delivery [name...]` | Export test cases → CSV for QA delivery (all screens if no arg) |
33
34
 
34
- **Order:** add-screen → create-test → review → run-test → delivery.
35
+ **Screen path:** add-screen → create-test → review → run-test → delivery.
36
+ **Flow path:** add-flow → create-test → review → run-test → delivery.
37
+
38
+ `create-test`, `review`, and `run-test` auto-detect context: if `qa/flows/<name>/` exists → flow mode, else `qa/screens/<name>/` → screen mode.
35
39
 
36
40
  After each command completes, use `AskUserQuestion` to present the next actions as selectable options. Never just print text — always give clickable choices so the user can continue the workflow seamlessly.
37
41
 
38
42
  ## File Structure
39
43
 
44
+ ### Screen (single-screen testing)
45
+
40
46
  ```
41
47
  qa/screens/<screen-name>/
42
48
  ├── features/<screen>.feature # Gherkin scenarios
@@ -47,9 +53,27 @@ qa/screens/<screen-name>/
47
53
  └── requirements/
48
54
  ├── spec.md # Screen specification (primary source)
49
55
  └── ui/ # Screenshots, mockups
56
+ ```
57
+
58
+ ### Flow (E2E cross-screen testing)
50
59
 
51
- qa/deliverables/<screen>-testcases.csv # Exported test cases (from /sungen:delivery)
52
- qa/deliverables/<screen>-testcases.xlsx # Styled workbook for client hand-off
60
+ ```
61
+ qa/flows/<flow-name>/
62
+ ├── features/<flow>.feature # Gherkin with @flow tag, [Screen:Element] refs
63
+ ├── selectors/<flow>.yaml # Namespaced keys: "login:submit", "awards:title"
64
+ ├── test-data/<flow>.yaml # Namespaced data: login.email, submission.nominee
65
+ ├── test-data/<flow>.staging.yaml # Environment override (optional)
66
+ ├── test-data/<flow>.production.yaml # Environment override (optional)
67
+ └── requirements/
68
+ ├── spec.md # Flow specification (screens, steps, transitions)
69
+ └── ui/ # Screenshots, mockups
70
+ ```
71
+
72
+ Flows are **independent** from screens — own selectors, own test-data. Selectors use colon-namespaced keys (`"login:submit":`) to avoid duplicate element names across screens.
73
+
74
+ ```
75
+ qa/deliverables/<name>-testcases.csv # Exported test cases (from /sungen:delivery)
76
+ qa/deliverables/<name>-testcases.xlsx # Styled workbook for client hand-off
53
77
  ```
54
78
 
55
79
  ## Test Data
@@ -61,11 +85,18 @@ qa/deliverables/<screen>-testcases.xlsx # Styled workbook for client hand-off
61
85
  ## CLI Commands
62
86
 
63
87
  ```bash
88
+ # Screen
64
89
  sungen add --screen <name> --path <url-path> # Scaffold screen directories
65
90
  sungen add --screen <name> --path <path> --feature <name> # Scaffold with sub-feature
66
91
  sungen generate --screen <name> # Compile .feature → .spec.ts (runtime data)
67
92
  sungen generate --screen <name> --inline-data # Compile with hardcoded data (legacy)
68
- sungen generate --all # Compile all screens
69
- sungen delivery # Export all screens → CSV + XLSX
70
- sungen delivery <screen> # Export a single screen
93
+
94
+ # Flow
95
+ sungen add-flow --flow <name> --path <start-url> # Scaffold flow directories
96
+ sungen generate --flow <name> # Compile flow .feature → .spec.ts
97
+
98
+ # All
99
+ sungen generate --all # Compile all screens and flows
100
+ sungen delivery # Export all → CSV + XLSX
101
+ sungen delivery <name> # Export a single screen or flow
71
102
  ```
@@ -61,6 +61,18 @@ Where `<timestamp>` is `YYYYMMDD-HHMM` in local time (e.g. `live-20260421-1430.p
61
61
 
62
62
  This gives users a visual record they can reference later without re-scanning.
63
63
 
64
+ ### 6a. Verify unauthenticated redirect target (flow capture only)
65
+
66
+ When capturing for a **flow** that includes security scenarios (e.g., "unauthenticated user cannot access X"):
67
+
68
+ 1. Open a **fresh incognito/unauthenticated** browser context (no storage state).
69
+ 2. `browser_navigate` to the protected route (e.g., `/dashboard`).
70
+ 3. Record the **actual redirect URL** — do NOT assume it goes to `/login`. The app may redirect to `/register`, `/`, or any other route.
71
+ 4. Report the redirect target to the caller: *"Unauthenticated access to `/dashboard` redirects to `/register`"*.
72
+ 5. The caller must use the **actual redirect URL** in Gherkin assertions (e.g., `Then User is on [Register] page`), never an assumed one.
73
+
74
+ Skip this step if the flow has no security scenarios or the user explicitly says to skip.
75
+
64
76
  ### 6. Detect discrepancies vs spec
65
77
 
66
78
  If `spec.md` exists, briefly cross-check the snapshot against spec sections: