buildanything 2.0.0 → 2.1.2
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.
- package/.claude-plugin/marketplace.json +1 -1
- package/.claude-plugin/plugin.json +9 -1
- package/README.md +57 -61
- package/agents/a11y-architect.md +2 -0
- package/agents/briefing-officer.md +172 -0
- package/agents/business-model.md +14 -12
- package/agents/code-architect.md +6 -1
- package/agents/code-reviewer.md +3 -2
- package/agents/code-simplifier.md +12 -4
- package/agents/design-brand-guardian.md +19 -0
- package/agents/design-critic.md +16 -11
- package/agents/design-inclusive-visuals-specialist.md +2 -0
- package/agents/design-ui-designer.md +17 -0
- package/agents/design-ux-architect.md +15 -0
- package/agents/design-ux-researcher.md +102 -7
- package/agents/engineering-ai-engineer.md +2 -0
- package/agents/engineering-backend-architect.md +2 -0
- package/agents/engineering-data-engineer.md +2 -0
- package/agents/engineering-devops-automator.md +2 -0
- package/agents/engineering-frontend-developer.md +13 -0
- package/agents/engineering-mobile-app-builder.md +2 -0
- package/agents/engineering-rapid-prototyper.md +15 -2
- package/agents/engineering-security-engineer.md +2 -0
- package/agents/engineering-senior-developer.md +13 -0
- package/agents/engineering-sre.md +2 -0
- package/agents/engineering-technical-writer.md +2 -0
- package/agents/feature-intel.md +8 -7
- package/agents/ios-app-review-guardian.md +2 -0
- package/agents/ios-foundation-models-specialist.md +2 -0
- package/agents/ios-product-reality-auditor.md +292 -0
- package/agents/ios-storekit-specialist.md +2 -0
- package/agents/ios-swift-architect.md +1 -0
- package/agents/ios-swift-search.md +1 -0
- package/agents/ios-swift-ui-design.md +7 -4
- package/agents/marketing-app-store-optimizer.md +2 -0
- package/agents/planner.md +6 -1
- package/agents/pr-test-analyzer.md +3 -2
- package/agents/product-feedback-synthesizer.md +62 -0
- package/agents/product-owner.md +163 -0
- package/agents/product-reality-auditor.md +216 -0
- package/agents/product-spec-writer.md +176 -0
- package/agents/refactor-cleaner.md +9 -1
- package/agents/security-reviewer.md +2 -1
- package/agents/silent-failure-hunter.md +2 -1
- package/agents/swift-build-resolver.md +2 -0
- package/agents/swift-reviewer.md +2 -1
- package/agents/tech-feasibility.md +5 -3
- package/agents/testing-api-tester.md +2 -0
- package/agents/testing-evidence-collector.md +24 -0
- package/agents/testing-performance-benchmarker.md +2 -0
- package/agents/testing-reality-checker.md +2 -1
- package/agents/visual-research.md +7 -5
- package/bin/adapters/scribe-tool.ts +4 -2
- package/bin/adapters/write-lease-tool.ts +1 -1
- package/bin/buildanything-runtime.ts +20 -107
- package/bin/graph-index.js +24 -0
- package/bin/graph-index.ts +340 -0
- package/bin/mcp-servers/graph-mcp.js +26 -0
- package/bin/mcp-servers/graph-mcp.ts +481 -0
- package/bin/mcp-servers/orchestrator-mcp.js +26 -0
- package/bin/mcp-servers/orchestrator-mcp.ts +361 -0
- package/bin/setup.js +272 -111
- package/commands/build.md +424 -177
- package/commands/idea-sweep.md +2 -2
- package/commands/setup.md +15 -4
- package/commands/ux-review.md +3 -3
- package/commands/verify.md +3 -0
- package/docs/migration/phase-graph.yaml +573 -157
- package/hooks/design-md-lint +4 -0
- package/hooks/design-md-lint.ts +295 -0
- package/hooks/pre-tool-use.ts +37 -6
- package/hooks/record-mode-transitions.ts +63 -6
- package/hooks/subagent-start.ts +3 -2
- package/package.json +3 -1
- package/protocols/agent-prompt-authoring.md +165 -0
- package/protocols/architecture-schema.md +10 -3
- package/protocols/cleanup.md +4 -0
- package/protocols/decision-log.md +8 -4
- package/protocols/design-md-authoring.md +520 -0
- package/protocols/design-md-spec.md +362 -0
- package/protocols/fake-data-detector.md +1 -1
- package/protocols/ios-fake-data-detector.md +65 -0
- package/protocols/ios-phase-branches.md +128 -43
- package/protocols/launch-readiness.md +9 -5
- package/protocols/metric-loop.md +1 -1
- package/protocols/page-spec-schema.md +234 -0
- package/protocols/product-spec-schema.md +354 -0
- package/protocols/sprint-tasks-schema.md +53 -0
- package/protocols/state-schema.json +38 -3
- package/protocols/state-schema.md +32 -2
- package/protocols/verify.md +29 -1
- package/protocols/web-phase-branches.md +246 -76
- package/skills/ios/ios-bootstrap/SKILL.md +1 -1
- package/src/graph/ids.ts +86 -0
- package/src/graph/index.ts +32 -0
- package/src/graph/parser/architecture.ts +603 -0
- package/src/graph/parser/component-manifest.ts +268 -0
- package/src/graph/parser/decisions-jsonl.ts +407 -0
- package/src/graph/parser/design-md-pass2.ts +253 -0
- package/src/graph/parser/design-md.ts +477 -0
- package/src/graph/parser/page-spec.ts +496 -0
- package/src/graph/parser/product-spec.ts +930 -0
- package/src/graph/parser/screenshot.ts +342 -0
- package/src/graph/parser/sprint-tasks.ts +317 -0
- package/src/graph/storage/index.ts +1154 -0
- package/src/graph/types.ts +432 -0
- package/src/graph/util/dhash.ts +84 -0
- package/src/lrr/aggregator.ts +105 -10
- package/src/orchestrator/hooks/context-header.ts +34 -10
- package/src/orchestrator/hooks/token-accounting.ts +25 -14
- package/src/orchestrator/mcp/cycle-counter.ts +2 -1
- package/src/orchestrator/mcp/scribe.ts +27 -16
- package/src/orchestrator/mcp/write-lease.ts +30 -13
- package/src/orchestrator/phase4-shared-context.ts +20 -4
- package/protocols/visual-dna.md +0 -185
|
@@ -0,0 +1,362 @@
|
|
|
1
|
+
<!--
|
|
2
|
+
Vendored from https://github.com/google-labs-code/design.md/blob/main/docs/spec.md
|
|
3
|
+
Pinned commit: 8ecd4645b957e6a683a05fb9c79cd6c9028873d0
|
|
4
|
+
Upstream license: Apache License 2.0 (see NOTICE for attribution)
|
|
5
|
+
Do not edit this file by hand. Re-vendor by re-running the curl command from CLAUDE.md.
|
|
6
|
+
-->
|
|
7
|
+
|
|
8
|
+
<!-- Generated from spec.mdx + spec-config.ts | version: alpha -->
|
|
9
|
+
<!-- Do not edit directly. Run `bun run spec:gen` to regenerate. -->
|
|
10
|
+
|
|
11
|
+
# DESIGN.md Format
|
|
12
|
+
|
|
13
|
+
DESIGN.md is a self-contained, plain-text representation of a design system. It defines the visual identity of a brand and product, thereby ensuring that these stylistic choices can be followed across design sessions and between different AI agents and tools. As a human-readable, open-format document, it serves as a living source of truth that both humans and AI can understand and refine.
|
|
14
|
+
|
|
15
|
+
A DESIGN.md file contains two parts: An optional YAML frontmatter, and a markdown body. The YAML front matter contains machine-readable design tokens. The markdown body sections provide human-readable design rationale and guidance. Prose may use descriptive color names (e.g., "Midnight Forest Green") that correspond to systematic token names (e.g., `primary`). The tokens are the normative values; the prose provides context for how to apply them.
|
|
16
|
+
|
|
17
|
+
# Design Tokens
|
|
18
|
+
|
|
19
|
+
DESIGN.md may embed design tokens in a structured format. The system that we use to describe design tokens is inspired by the
|
|
20
|
+
[Design Token JSON spec](https://www.designtokens.org/tr/2025.10/format/#abstract). Specifically, we adopt the concept of typed token groups (colors, typography, spacing) and the `{path.to.token}` reference syntax for cross-referencing values.
|
|
21
|
+
|
|
22
|
+
These tokens are easily converted from or to `tokens.json`, Figma variables, and Tailwind theme configs.
|
|
23
|
+
|
|
24
|
+
Design tokens are embedded as YAML front matter at the beginning of the file. The front matter block must begin with a line containing exactly `---` and end with a line containing exactly `---`. The YAML content between these delimiters is parsed according to the schema defined below.
|
|
25
|
+
|
|
26
|
+
Example:
|
|
27
|
+
|
|
28
|
+
```yaml
|
|
29
|
+
---
|
|
30
|
+
version: alpha
|
|
31
|
+
name: Daylight Prestige
|
|
32
|
+
colors:
|
|
33
|
+
primary: "#1A1C1E"
|
|
34
|
+
secondary: "#6C7278"
|
|
35
|
+
tertiary: "#B8422E"
|
|
36
|
+
typography:
|
|
37
|
+
h1:
|
|
38
|
+
fontFamily: Public Sans
|
|
39
|
+
fontSize: 48px
|
|
40
|
+
fontWeight: 600
|
|
41
|
+
lineHeight: 1.1
|
|
42
|
+
letterSpacing: -0.02em
|
|
43
|
+
---
|
|
44
|
+
```
|
|
45
|
+
|
|
46
|
+
## Schema
|
|
47
|
+
|
|
48
|
+
Below is the schema for the design tokens defined in the front matter:
|
|
49
|
+
|
|
50
|
+
```yaml
|
|
51
|
+
version: <string> # optional, current version: "alpha"
|
|
52
|
+
name: <string>
|
|
53
|
+
description: <string> # optional
|
|
54
|
+
colors:
|
|
55
|
+
<token-name>: <Color>
|
|
56
|
+
typography:
|
|
57
|
+
<token-name>: <Typography>
|
|
58
|
+
rounded:
|
|
59
|
+
<scale-level>: <Dimension>
|
|
60
|
+
spacing:
|
|
61
|
+
<scale-level>: <Dimension | number>
|
|
62
|
+
components:
|
|
63
|
+
<component-name>:
|
|
64
|
+
<token-name>: <string|token reference>
|
|
65
|
+
```
|
|
66
|
+
|
|
67
|
+
The `<scale-level>` placeholder represents a named level in a sizing or spacing scale. Common level names include `xs`, `sm`, `md`, `lg`, `xl`, and `full`. Any descriptive string key is valid.
|
|
68
|
+
|
|
69
|
+
**Color**: A color value must start with "#" followed by a hex color code in the SRGB color space.
|
|
70
|
+
|
|
71
|
+
- `fontFamily` (string)
|
|
72
|
+
- `fontSize` (Dimension)
|
|
73
|
+
- `fontWeight` (number) - A numeric font weight value (e.g., `400`, `700`). In YAML, this may be expressed as either a bare number or a quoted string; both are equivalent.
|
|
74
|
+
- `lineHeight` (Dimension | number) - Accepts either a Dimension (e.g., `24px`, `1.5rem`) or a unitless number (e.g., `1.6`). A unitless number represents a multiplier of the element's `fontSize`, which is the recommended CSS practice.
|
|
75
|
+
- `letterSpacing` (Dimension)
|
|
76
|
+
- `fontFeature` (string) - configures
|
|
77
|
+
[`font-feature-settings`](https://developer.mozilla.org/en-US/docs/Web/CSS/Reference/Properties/font-feature-settings).
|
|
78
|
+
- `fontVariation` (string) - configures
|
|
79
|
+
[`font-variation-settings`](https://developer.mozilla.org/en-US/docs/Web/CSS/Reference/Properties/font-variation-settings).
|
|
80
|
+
|
|
81
|
+
**Dimension**: A dimension value is a string with a unit suffix. Valid units are: px, em, rem.
|
|
82
|
+
|
|
83
|
+
**Token References**: A token reference must be wrapped in curly braces, and contain an object path to another value in the YAML tree. For most token groups, the reference must point to a primitive value (e.g., `colors.primary-60`), not a group (e.g., `colors`). Within the `components` section, references to composite values (e.g., `{typography.label-md}`) are permitted.
|
|
84
|
+
|
|
85
|
+
# Sections
|
|
86
|
+
|
|
87
|
+
Every `DESIGN.md` follows the same structure. Sections can be omitted if they're not relevant to your project, but those present should appear in the sequence listed below. All sections use `<h2>` (`##`) headings. An optional `<h1>` heading may appear for document titling purposes but is not parsed as a section.
|
|
88
|
+
|
|
89
|
+
### Section Order
|
|
90
|
+
|
|
91
|
+
1. **Overview** (also: "Brand & Style")
|
|
92
|
+
2. **Colors**
|
|
93
|
+
3. **Typography**
|
|
94
|
+
4. **Layout** (also: "Layout & Spacing")
|
|
95
|
+
5. **Elevation & Depth** (also: "Elevation")
|
|
96
|
+
6. **Shapes**
|
|
97
|
+
7. **Components**
|
|
98
|
+
8. **Do's and Don'ts**
|
|
99
|
+
|
|
100
|
+
### Prose and Tokens
|
|
101
|
+
|
|
102
|
+
## Overview
|
|
103
|
+
|
|
104
|
+
Also known as "Brand & Style".
|
|
105
|
+
|
|
106
|
+
This section is a holistic description of a product's look and feel. It defines the brand personality, target audience, and the emotional response the UI should evoke, such as whether it should feel playful or professional, dense or spacious. It serves as foundational context for guiding the agent's high-level stylistic decisions when a specific rule or token isn't explicitly defined.
|
|
107
|
+
|
|
108
|
+
## Colors
|
|
109
|
+
|
|
110
|
+
This section defines the color palettes for the design system.
|
|
111
|
+
|
|
112
|
+
At least the `primary` color palette must be defined, and additional color palettes may be defined as needed.
|
|
113
|
+
|
|
114
|
+
When there are multiple color palettes, the design system may assign a semantic role for each palette. A common convention is to name the palettes in this order: `primary`, `secondary`, `tertiary`, and `neutral`.
|
|
115
|
+
|
|
116
|
+
Example:
|
|
117
|
+
|
|
118
|
+
```markdown
|
|
119
|
+
## Colors
|
|
120
|
+
|
|
121
|
+
The palette is rooted in high-contrast neutrals and a single, evocative accent color.
|
|
122
|
+
|
|
123
|
+
- **Primary (#1A1C1E):** A deep ink used for headlines and core text to provide
|
|
124
|
+
maximum readability and a sense of permanence.
|
|
125
|
+
- **Secondary (#6C7278):** A sophisticated slate used primarily for utilitarian
|
|
126
|
+
elements like borders, captions, and metadata.
|
|
127
|
+
- **Tertiary (#B8422E):** A vibrant earthy red as the sole driver for
|
|
128
|
+
interaction, used exclusively for primary actions and critical highlights.
|
|
129
|
+
- **Neutral (#F7F5F2):** A warm limestone that serves as the foundation for all
|
|
130
|
+
pages, providing a softer, more organic feel than pure white.
|
|
131
|
+
```
|
|
132
|
+
|
|
133
|
+
### Design Tokens
|
|
134
|
+
|
|
135
|
+
The `colors` section defines all color design tokens. The color tokens should be derived from the key color palettes defined in the markdown prose. The exact mapping from color palettes to color tokens may follow any consistent naming convention.
|
|
136
|
+
|
|
137
|
+
It is a
|
|
138
|
+
map\<string, Color>, that maps the name of the color token to its value.
|
|
139
|
+
|
|
140
|
+
```yaml
|
|
141
|
+
colors:
|
|
142
|
+
primary: "#1A1C1E"
|
|
143
|
+
secondary: "#6C7278"
|
|
144
|
+
tertiary: "#B8422E"
|
|
145
|
+
neutral: "#F7F5F2"
|
|
146
|
+
```
|
|
147
|
+
|
|
148
|
+
## Typography
|
|
149
|
+
|
|
150
|
+
This section defines typography levels.
|
|
151
|
+
|
|
152
|
+
Most design systems have 9 - 15 typography levels. The design system may prescribe a role for each typography level.
|
|
153
|
+
|
|
154
|
+
A common naming convention for typography levels is to use semantic categories such as `headline`, `display`, `body`, `label`, `caption`. Each category may further be divided into different sizes, such as `small`, `medium`, and `large`.
|
|
155
|
+
|
|
156
|
+
Example:
|
|
157
|
+
|
|
158
|
+
```markdown
|
|
159
|
+
## Typography
|
|
160
|
+
|
|
161
|
+
The typography strategy leverages two distinct weights of **Public Sans** for
|
|
162
|
+
the narrative and **Space Grotesk** for technical data.
|
|
163
|
+
|
|
164
|
+
- **Headlines:** Set in Public Sans Semi-Bold to establish an institutional
|
|
165
|
+
and trustworthy voice.
|
|
166
|
+
- **Body:** Public Sans Regular at 16px ensures contemporary professionalism
|
|
167
|
+
and long-form readability.
|
|
168
|
+
- **Labels:** Space Grotesk is used for all technical data, timestamps, and
|
|
169
|
+
metadata. Its geometric construction evokes the precision of a digital
|
|
170
|
+
stopwatch. Labels are strictly uppercase with generous letter spacing.
|
|
171
|
+
```
|
|
172
|
+
|
|
173
|
+
### Design Tokens
|
|
174
|
+
|
|
175
|
+
The `typography` section defines the precise font properties for the typography design tokens.
|
|
176
|
+
|
|
177
|
+
It is a
|
|
178
|
+
map\<string, Typography>
|
|
179
|
+
|
|
180
|
+
```yaml
|
|
181
|
+
typography:
|
|
182
|
+
h1:
|
|
183
|
+
fontFamily: Public Sans
|
|
184
|
+
fontSize: 48px
|
|
185
|
+
fontWeight: 600
|
|
186
|
+
lineHeight: 1.1
|
|
187
|
+
letterSpacing: -0.02em
|
|
188
|
+
body-md:
|
|
189
|
+
fontFamily: Public Sans
|
|
190
|
+
fontSize: 16px
|
|
191
|
+
fontWeight: 400
|
|
192
|
+
lineHeight: 1.6
|
|
193
|
+
label-caps:
|
|
194
|
+
fontFamily: Space Grotesk
|
|
195
|
+
fontSize: 12px
|
|
196
|
+
fontWeight: 500
|
|
197
|
+
lineHeight: 1
|
|
198
|
+
letterSpacing: 0.1em
|
|
199
|
+
```
|
|
200
|
+
|
|
201
|
+
## Layout
|
|
202
|
+
|
|
203
|
+
Also known as "Layout & Spacing".
|
|
204
|
+
|
|
205
|
+
This section describes the layout and spacing strategy.
|
|
206
|
+
|
|
207
|
+
Many design systems follow a grid-based layout. Others, like Liquid Glass, use margins, safe areas, and dynamic padding.
|
|
208
|
+
|
|
209
|
+
Example:
|
|
210
|
+
|
|
211
|
+
```markdown
|
|
212
|
+
## Layout
|
|
213
|
+
|
|
214
|
+
The layout follows a **Fluid Grid** model for mobile devices and a
|
|
215
|
+
**Fixed-Max-Width Grid** for desktop (max 1200px).
|
|
216
|
+
|
|
217
|
+
A strict 8px spacing scale (with a 4px half-step for micro-adjustments) is used to maintain a consistent rhythm. Components are grouped using "containment" principles, where related items are housed in cards with generous internal padding (24px) to emphasize the soft, approachable nature of the brand.
|
|
218
|
+
```
|
|
219
|
+
|
|
220
|
+
### Design Tokens
|
|
221
|
+
|
|
222
|
+
The spacing section defines the spacing design tokens. These may include spacing units that are useful for implementing the layout model. For example, a fixed grid layout may have spacing units for column spans, gutters, and margins.
|
|
223
|
+
|
|
224
|
+
It is a
|
|
225
|
+
map\<string, Dimension | number> that maps the spacing scale identifier to a dimension value or a unitless number (e.g., column counts or ratios).
|
|
226
|
+
|
|
227
|
+
```yaml
|
|
228
|
+
spacing:
|
|
229
|
+
base: 16px
|
|
230
|
+
xs: 4px
|
|
231
|
+
sm: 8px
|
|
232
|
+
md: 16px
|
|
233
|
+
lg: 32px
|
|
234
|
+
xl: 64px
|
|
235
|
+
gutter: 24px
|
|
236
|
+
margin: 32px
|
|
237
|
+
```
|
|
238
|
+
|
|
239
|
+
## Elevation & Depth
|
|
240
|
+
|
|
241
|
+
Also known as "Elevation".
|
|
242
|
+
|
|
243
|
+
This section describes how visual hierarchy is conveyed based on the design style. If elevation is used, it defines the required styling (spread, blur, color). For flat designs, this section explains the alternative methods used to convey visual hierarchy (e.g., borders, color contrast).
|
|
244
|
+
|
|
245
|
+
Example:
|
|
246
|
+
|
|
247
|
+
```markdown
|
|
248
|
+
## Elevation & Depth
|
|
249
|
+
|
|
250
|
+
Depth is achieved through **Tonal Layers** rather than heavy shadows. The
|
|
251
|
+
background uses a soft off-white or very light green, while primary content sits on pure white cards.
|
|
252
|
+
```
|
|
253
|
+
|
|
254
|
+
## Shapes
|
|
255
|
+
|
|
256
|
+
This section describes how visual elements are shaped.
|
|
257
|
+
|
|
258
|
+
Example:
|
|
259
|
+
|
|
260
|
+
```markdown
|
|
261
|
+
## Shapes
|
|
262
|
+
|
|
263
|
+
The shape language is defined by **Architectural Sharpness**. All interactive
|
|
264
|
+
elements, containers, and inputs utilize a minimal **4px corner radius**. This
|
|
265
|
+
provides just enough softness to feel modern while maintaining a rigid,
|
|
266
|
+
engineered aesthetic.
|
|
267
|
+
```
|
|
268
|
+
|
|
269
|
+
### Design Tokens
|
|
270
|
+
|
|
271
|
+
The `rounded` section defines the design tokens for rounded corners used in
|
|
272
|
+
buttons, cards, and other rectangular shapes.
|
|
273
|
+
|
|
274
|
+
It is a map\<string, Dimension>.
|
|
275
|
+
|
|
276
|
+
```yaml
|
|
277
|
+
rounded:
|
|
278
|
+
sm: 4px
|
|
279
|
+
md: 8px
|
|
280
|
+
lg: 12px
|
|
281
|
+
full: 9999px
|
|
282
|
+
```
|
|
283
|
+
|
|
284
|
+
## Components
|
|
285
|
+
|
|
286
|
+
This section provides style guidance for component atoms within the design system. The following are common component types. Design systems are encouraged to define additional components relevant to their domain.
|
|
287
|
+
|
|
288
|
+
* **Buttons**: Covers primary, secondary, and tertiary variants, including sizing, padding, and states.
|
|
289
|
+
* **Chips**: Covers selection chips, filter chips, and action chips.
|
|
290
|
+
* **Lists**: Covers styling for list items, dividers, and leading/trailing elements.
|
|
291
|
+
* **Tooltips**: Covers positioning, colors, and timing.
|
|
292
|
+
* **Checkboxes**: Covers checked, unchecked, and indeterminate states.
|
|
293
|
+
* **Radio buttons**: Covers selected and unselected states.
|
|
294
|
+
* **Input fields**: Covers text inputs, text areas, labels, helper text, and error states.
|
|
295
|
+
|
|
296
|
+
> **Note:** The components specification is actively evolving. The current structure provides intentional flexibility for domain-specific component definitions while the spec matures.
|
|
297
|
+
|
|
298
|
+
### Design Tokens
|
|
299
|
+
|
|
300
|
+
The components section defines a collection of design tokens used to ensure consistent styling of common components. It's a map\<string, map\<string, string>> that maps a component identifier to a group of sub token names and values. The design token values may be literal values, or references to previously defined design tokens.
|
|
301
|
+
|
|
302
|
+
**Variants**. A component may have a variant for different UI states such as active, hover, pressed, etc. Those variant components may be defined under a different but related key, for example, "button-primary", "button-primary-hover", "button-primary-active". The agent will consider all variants and make the appropriate styling decisions.
|
|
303
|
+
|
|
304
|
+
```yaml
|
|
305
|
+
components:
|
|
306
|
+
button-primary:
|
|
307
|
+
backgroundColor: "{colors.primary-60}"
|
|
308
|
+
textColor: "{colors.primary-20}"
|
|
309
|
+
rounded: "{rounded.md}"
|
|
310
|
+
padding: 12px
|
|
311
|
+
button-primary-hover:
|
|
312
|
+
backgroundColor: "{colors.primary-70}"
|
|
313
|
+
```
|
|
314
|
+
|
|
315
|
+
### Component Property Tokens
|
|
316
|
+
|
|
317
|
+
Each component has a set of properties that are themselves design tokens:
|
|
318
|
+
|
|
319
|
+
- backgroundColor: \<Color\>
|
|
320
|
+
- textColor: \<Color\>
|
|
321
|
+
- typography: \<Typography\>
|
|
322
|
+
- rounded: \<Dimension\>
|
|
323
|
+
- padding: \<Dimension\>
|
|
324
|
+
- size: \<Dimension\>
|
|
325
|
+
- height: \<Dimension\>
|
|
326
|
+
- width: \<Dimension\>
|
|
327
|
+
|
|
328
|
+
## Do's and Don'ts
|
|
329
|
+
|
|
330
|
+
This section provides practical guidelines and common pitfalls. These act as guardrails when creating designs.
|
|
331
|
+
|
|
332
|
+
```markdown
|
|
333
|
+
## Do's and Don'ts
|
|
334
|
+
|
|
335
|
+
- Do use the primary color only for the single most important action per screen
|
|
336
|
+
- Don't mix rounded and sharp corners in the same view
|
|
337
|
+
- Do maintain WCAG AA contrast ratios (4.5:1 for normal text)
|
|
338
|
+
- Don't use more than two font weights on a single screen
|
|
339
|
+
```
|
|
340
|
+
|
|
341
|
+
# Recommended Token Names (Non-Normative)
|
|
342
|
+
|
|
343
|
+
The following names are commonly used across design systems. They are not required but are provided as guidance for consistency.
|
|
344
|
+
|
|
345
|
+
**Colors:** `primary`, `secondary`, `tertiary`, `neutral`, `surface`, `on-surface`, `error`
|
|
346
|
+
|
|
347
|
+
**Typography:** `headline-display`, `headline-lg`, `headline-md`, `body-lg`, `body-md`, `body-sm`, `label-lg`, `label-md`, `label-sm`
|
|
348
|
+
|
|
349
|
+
**Rounded:** `none`, `sm`, `md`, `lg`, `xl`, `full`
|
|
350
|
+
|
|
351
|
+
# Consumer Behavior for Unknown Content
|
|
352
|
+
|
|
353
|
+
When a DESIGN.md consumer encounters content not defined by this spec:
|
|
354
|
+
|
|
355
|
+
| Scenario | Behavior | Example |
|
|
356
|
+
|---|---|---|
|
|
357
|
+
| Unknown section heading | Preserve; do not error | `## Iconography` |
|
|
358
|
+
| Unknown color token name | Accept if value is valid | `surface-container-high: '#ede7dd'` |
|
|
359
|
+
| Unknown typography token name | Accept as valid typography | `telemetry-data` |
|
|
360
|
+
| Unknown spacing value | Accept; store as string if not a valid dimension | `grid-columns: '5'` |
|
|
361
|
+
| Unknown component property | Accept with warning | `borderColor` |
|
|
362
|
+
| Duplicate section heading | Error; reject the file | Two `## Colors` headings |
|
|
@@ -51,7 +51,7 @@ Write findings to `docs/plans/.build-state.md` under `## Fake Data Detector`:
|
|
|
51
51
|
|---|-----------|---------|----------------|----------|---------------|
|
|
52
52
|
|
|
53
53
|
<HARD-GATE>
|
|
54
|
-
CRITICAL findings
|
|
54
|
+
CRITICAL findings route through the Feedback Synthesizer (Step 5.4) and Fix loop (Step 5.5) — they do NOT block inline. The synthesizer classifies and routes them like all other finding streams.
|
|
55
55
|
</HARD-GATE>
|
|
56
56
|
|
|
57
57
|
---
|
|
@@ -0,0 +1,65 @@
|
|
|
1
|
+
# iOS Fake Data Detector Protocol
|
|
2
|
+
|
|
3
|
+
You are the orchestrator. Phase 6.2d detects mock, fake, or hardcoded data masquerading as real functionality in iOS/Swift projects. This catches apps that look complete but run on canned responses, simulated delays, or placeholder content.
|
|
4
|
+
|
|
5
|
+
## When to Run
|
|
6
|
+
|
|
7
|
+
Run as a single agent in Phase 6.2d, after the eval harness and metric loop. CRITICAL findings block the Reality Checker in Step 6.3.
|
|
8
|
+
|
|
9
|
+
## Step 1: Static Analysis
|
|
10
|
+
|
|
11
|
+
Call the Agent tool — description: "Detect fake data (static, iOS)" — mode: "bypassPermissions" — prompt:
|
|
12
|
+
|
|
13
|
+
"[COMPLEXITY: M] Grep the codebase for fake data patterns. Exclude test targets (`*Tests/`, `*UITests/`), `#Preview` blocks (data defined AND consumed within the block), seed/fixture files (`**/Fixtures/`, `**/Seeds/`), `.xcconfig` files, and `Package.swift`. For each match, report file:line, the pattern matched, and why it is suspicious. Patterns to check:
|
|
14
|
+
|
|
15
|
+
1. `UUID()` generating business data IDs (prices, orders, transactions) — ignore SwiftUI view identity or test helpers
|
|
16
|
+
2. Hardcoded arrays/dictionaries posing as API responses (e.g., `let users = [User(name: "John"...)]` in production source, not inside `#Preview`)
|
|
17
|
+
3. `Task.sleep` / `Thread.sleep` faking async operations (simulating network latency or streaming that should be real API calls)
|
|
18
|
+
4. Strings: 'Lorem ipsum', 'placeholder', 'sample data', 'test data', 'TODO', 'FIXME' in user-facing `Text()`, `Label()`, `.navigationTitle()`, or `LocalizedStringKey`
|
|
19
|
+
5. `print()` / `debugPrint()` faking real output (e.g., `print("Order placed successfully")`) — ignore `#if DEBUG` guarded prints
|
|
20
|
+
6. Hardcoded URLs (`"https://..."`, `"http://..."`) not sourced from `Info.plist`, `.xcconfig`, `ProcessInfo.processInfo.environment`, or a config enum/struct
|
|
21
|
+
7. `#Preview` sample data leaking into production — data factories or static properties defined inside `#Preview` that are also referenced by production views or view models
|
|
22
|
+
8. Mock `URLSession` / `URLProtocol` subclasses included in the main app target (not test targets)
|
|
23
|
+
9. Hardcoded JSON strings as API response stubs (e.g., multi-line string literals containing `{` with key-value pairs used in `JSONDecoder().decode`)
|
|
24
|
+
10. `UserDefaults` storing structured domain data (arrays of models, user profiles, transaction history) that should live in SwiftData / CloudKit / a proper persistence layer"
|
|
25
|
+
|
|
26
|
+
## Step 2: Dynamic Analysis (Instruments / Network Trace)
|
|
27
|
+
|
|
28
|
+
Check `docs/plans/evidence/*/` for `.trace` or network capture files from Maestro/smoke tests. If none exist, skip to Step 3.
|
|
29
|
+
|
|
30
|
+
If trace files exist, call the Agent tool — description: "Detect fake data (dynamic, iOS)" — mode: "bypassPermissions" — prompt:
|
|
31
|
+
|
|
32
|
+
"[COMPLEXITY: S] Parse trace/network capture files in `docs/plans/evidence/*/`. Flag:
|
|
33
|
+
|
|
34
|
+
1. Zero external API calls during a full app exercise (all data local or hardcoded)
|
|
35
|
+
2. Identical response bodies across different endpoint calls
|
|
36
|
+
3. No error handling paths exercised (no non-200 status codes observed, no alert/error UI triggered)"
|
|
37
|
+
|
|
38
|
+
## Step 3: Classify Findings
|
|
39
|
+
|
|
40
|
+
| Severity | Criteria |
|
|
41
|
+
|----------|----------|
|
|
42
|
+
| CRITICAL | Production code using hardcoded data that should come from an API — business logic relies on `UUID()` for real IDs, hardcoded arrays substitute for real API responses |
|
|
43
|
+
| HIGH | Mock networking left in release target — `URLProtocol` subclass in main target, simulated delays via `Task.sleep` |
|
|
44
|
+
| MEDIUM | Placeholder strings in user-facing UI — 'Lorem ipsum' in `Text()`, 'TODO' in navigation titles |
|
|
45
|
+
| LOW | Debug prints in production code — `print()` / `debugPrint()` outside `#if DEBUG` |
|
|
46
|
+
|
|
47
|
+
## Step 4: Report
|
|
48
|
+
|
|
49
|
+
Write findings to `docs/plans/evidence/fake-data-audit.md`:
|
|
50
|
+
|
|
51
|
+
| # | File:Line | Pattern | Why Suspicious | Severity | Suggested Fix |
|
|
52
|
+
|---|-----------|---------|----------------|----------|---------------|
|
|
53
|
+
|
|
54
|
+
<HARD-GATE>
|
|
55
|
+
CRITICAL findings route through the Feedback Synthesizer (Step 5.4) and Fix loop (Step 5.5) — they do NOT block inline. The synthesizer classifies and routes them like all other finding streams.
|
|
56
|
+
</HARD-GATE>
|
|
57
|
+
|
|
58
|
+
---
|
|
59
|
+
|
|
60
|
+
## Rules
|
|
61
|
+
|
|
62
|
+
- ONE agent for static checks, ONE agent for dynamic checks. Do not combine.
|
|
63
|
+
- If no trace files exist, run static checks only. Do not fail the protocol for missing traces.
|
|
64
|
+
- Do NOT flag: test target code, data defined and consumed entirely within `#Preview`, seed/fixture data, `.xcconfig` values, `Package.swift` dependencies, or explicit dev mock servers behind `#if DEBUG` / compile-time flags.
|
|
65
|
+
- Every finding must include a file:line reference. No vague "the codebase has fake data" reports.
|