@tidyfactor/design 1.5.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.
- package/.tidyfactor +52 -0
- package/AGENTS.md +75 -0
- package/CHANGELOG.md +210 -0
- package/LICENSE +17 -0
- package/README.ar.md +398 -0
- package/README.de.md +44 -0
- package/README.es.md +44 -0
- package/README.fa.md +44 -0
- package/README.fr.md +44 -0
- package/README.md +418 -0
- package/README.pt.md +44 -0
- package/README.zh.md +44 -0
- package/SKILL-REGISTRY.md +69 -0
- package/SKILL.md +46 -0
- package/VISION.md +43 -0
- package/assets/blog.png +0 -0
- package/assets/content_layout.png +0 -0
- package/assets/content_output.png +0 -0
- package/assets/dark.png +0 -0
- package/assets/dashboard_layout.png +0 -0
- package/assets/dashboard_output.png +0 -0
- package/assets/ecommerce_layout.png +0 -0
- package/assets/ecommerce_output.png +0 -0
- package/assets/github-social-preview-2.png +0 -0
- package/assets/github-social-preview.png +0 -0
- package/assets/hero-banner.png +0 -0
- package/assets/light.png +0 -0
- package/assets/media_layout.png +0 -0
- package/assets/media_output.png +0 -0
- package/assets/og-default.png +0 -0
- package/assets/video.png +0 -0
- package/bin/add-skill.js +31 -0
- package/bin/create-kit.js +372 -0
- package/bin/remove-skill.js +137 -0
- package/brand.json +279 -0
- package/memory/01-design-schools.md +85 -0
- package/memory/02-design-tokens.md +41 -0
- package/memory/03-narrative-conversion.md +47 -0
- package/memory/04-motion-principles.md +44 -0
- package/memory/05-component-anatomy.md +34 -0
- package/memory/06-quality-bar.md +83 -0
- package/memory/07-consistency-contract.md +33 -0
- package/memory/08-arabic-bilingual.md +54 -0
- package/memory/09-prototype-flow.md +36 -0
- package/memory/10-python-tooling.md +64 -0
- package/memory/11-brand-json-v2.md +86 -0
- package/memory/12-typography-matrix.md +31 -0
- package/memory/13-layout-archetypes.md +30 -0
- package/memory/14-nav-footer-catalog.md +26 -0
- package/memory/15-performance-budget.md +18 -0
- package/memory/16-design-movements-guide.md +1084 -0
- package/memory/17-storytelling-industries-ux.md +143 -0
- package/memory/18-design-decision-engine.md +81 -0
- package/package.json +64 -0
- package/references/commands/_template.md +27 -0
- package/references/commands/assets.md +35 -0
- package/references/commands/audit.md +15 -0
- package/references/commands/brand.md +85 -0
- package/references/commands/brief.md +107 -0
- package/references/commands/clone.md +26 -0
- package/references/commands/components.md +46 -0
- package/references/commands/dashboard.md +45 -0
- package/references/commands/deploy.md +45 -0
- package/references/commands/flow.md +44 -0
- package/references/commands/handoff.md +53 -0
- package/references/commands/i18n.md +64 -0
- package/references/commands/init.md +30 -0
- package/references/commands/layout.md +81 -0
- package/references/commands/motion.md +62 -0
- package/references/commands/nav-footer.md +54 -0
- package/references/commands/page.md +45 -0
- package/references/commands/palette.md +35 -0
- package/references/commands/perf.md +57 -0
- package/references/commands/retrofit.md +15 -0
- package/references/commands/school.md +41 -0
- package/references/commands/states.md +48 -0
- package/references/commands/study.md +98 -0
- package/references/commands/tokens.md +45 -0
- package/references/commands/typography.md +87 -0
- package/references/foundations/daisyui.md +44 -0
- package/references/foundations/hybrid.md +32 -0
- package/references/foundations/native.md +31 -0
- package/references/foundations/tailwind-utility.md +43 -0
- package/references/memory/01-design-schools.md +85 -0
- package/references/memory/02-design-tokens.md +41 -0
- package/references/memory/03-narrative-conversion.md +47 -0
- package/references/memory/04-motion-principles.md +44 -0
- package/references/memory/05-component-anatomy.md +34 -0
- package/references/memory/06-quality-bar.md +83 -0
- package/references/memory/07-consistency-contract.md +33 -0
- package/references/memory/08-arabic-bilingual.md +54 -0
- package/references/memory/09-prototype-flow.md +36 -0
- package/references/memory/10-python-tooling.md +64 -0
- package/references/memory/11-brand-json-v2.md +86 -0
- package/references/memory/12-typography-matrix.md +31 -0
- package/references/memory/13-layout-archetypes.md +30 -0
- package/references/memory/14-nav-footer-catalog.md +26 -0
- package/references/memory/15-performance-budget.md +18 -0
- package/references/memory/16-design-movements-guide.md +1084 -0
- package/references/memory/17-storytelling-industries-ux.md +143 -0
- package/references/memory/18-design-decision-engine.md +81 -0
- package/references/memory/architecture.md +39 -0
- package/references/memory/decision-points.md +50 -0
- package/references/memory/foundations.md +15 -0
- package/references/memory/quality-bar.md +20 -0
- package/references/tidyfactor-vision.md +66 -0
- package/references/workflow.md +49 -0
- package/references/workflows/audit-prototype.md +26 -0
- package/references/workflows/brief.md +30 -0
- package/references/workflows/clone-prototype.md +27 -0
- package/references/workflows/init-prototype.md +28 -0
- package/references/workflows/retrofit-prototype.md +25 -0
- package/scripts/__pycache__/_utils.cpython-312.pyc +0 -0
- package/scripts/_utils.py +60 -0
- package/scripts/build.py +194 -0
- package/scripts/check_alpha.py +52 -0
- package/scripts/extract_palette.py +139 -0
- package/scripts/generate_transitions.py +105 -0
- package/scripts/inspect_images.py +48 -0
- package/scripts/minify_assets.py +140 -0
- package/scripts/optimize_assets.py +91 -0
- package/scripts/optimize_images.py +176 -0
- package/scripts/prepare_images.py +67 -0
- package/scripts/remove_backgrounds.py +61 -0
- package/scripts/test_build.py +228 -0
- package/templates/design-system/base.css +75 -0
- package/templates/design-system/components.css +229 -0
- package/templates/design-system/interactions.js +31 -0
- package/templates/design-system/motion.js +42 -0
- package/templates/design-system/tokens.css +81 -0
- package/templates/design-system/utilities.css +47 -0
- package/templates/index.html +84 -0
- package/templates/proto-nav.js +56 -0
- package/tools/build-skill.js +126 -0
- package/tools/validate-skill.js +144 -0
- package/tools/validate_skill.py +121 -0
package/README.md
ADDED
|
@@ -0,0 +1,418 @@
|
|
|
1
|
+
<div align="center">
|
|
2
|
+
|
|
3
|
+
<p align="center">
|
|
4
|
+
<img src="assets/hero-banner.png" alt="TidyFactor Design Hero Banner" width="100%">
|
|
5
|
+
</p>
|
|
6
|
+
|
|
7
|
+
# 🎨 TidyFactor Design `v1.5.0`
|
|
8
|
+
### Code-Native UI Design Lifecycle Engine & Anti-Slop Design System Suite
|
|
9
|
+
|
|
10
|
+
**The official UI design & interactive prototyping foundation for the TidyFactor Ecosystem.**
|
|
11
|
+
|
|
12
|
+
[](https://www.npmjs.com/package/@tidyfactor/design)
|
|
13
|
+
[](LICENSE)
|
|
14
|
+
[](README.ar.md)
|
|
15
|
+
[](#-anti-slop-governance--quality-bar-rule-8)
|
|
16
|
+
[-green.svg?style=for-the-badge)](#-license--governance)
|
|
17
|
+
|
|
18
|
+
[✨ Live Demo](https://alwkala.com/tidyfactor-design/) • [🖼️ Visual Showcase](#%EF%B8%8F-visual-showcase--surface-demos) • [⚡ 24 Slash Commands](#-the-7-ui-design-lifecycle-stages--24-command-registry) • [🎨 8 CSS Foundations](#-8-pluggable-css-foundations) • [🛡️ Anti-Slop Rules](#-anti-slop-governance--quality-bar-rule-8) • [📖 بالعربية](README.ar.md)
|
|
19
|
+
|
|
20
|
+
</div>
|
|
21
|
+
|
|
22
|
+
---
|
|
23
|
+
|
|
24
|
+
> [!NOTE]
|
|
25
|
+
> **TidyFactor Design** is an AI-era, code-native alternative to Figma and complete UI Design Lifecycle Engine. It empowers developers, design engineers, and AI coding agents (*Google Antigravity, Claude Code, Cursor, Codex, Windsurf*) to manage all 7 stages of UI design—from initial discovery through developer handoff—using clean, interactive HTML/CSS/JS with zero build steps and zero per-page CSS/JS drift.
|
|
26
|
+
|
|
27
|
+
---
|
|
28
|
+
|
|
29
|
+
## 🌟 Value Proposition & Why TidyFactor Design?
|
|
30
|
+
|
|
31
|
+
| For Developers | For Design Engineers | For AI Coding Agents |
|
|
32
|
+
|---|---|---|
|
|
33
|
+
| **Zero Build Step**: No webpack/vite compilation needed; open `.html` files directly in any browser. | **Figma Alternative**: Design directly in production-ready code with responsive live interactivity. | **Token-Efficient**: Modular slash commands load only necessary context (~350 tokens) per task. |
|
|
34
|
+
| **Zero Per-Page Drift**: All visual styles and components live strictly inside `design-system/`. | **8 Pluggable Foundations**: Choose Native CSS, Tailwind, daisyUI, shadcn/ui, Pico, Bootstrap, or Alpine. | **Anti-Slop Certified**: Structurally blocks generic AI design tells via 16 mechanical quality rules. |
|
|
35
|
+
| **Production Handoff**: Clean, predictable CSS variables and HTML markup ready for framework integration. | **Native RTL & Arabic**: Bidi-first layout support with El Messiri + Tajawal typography pairing. | **Deterministic Workflows**: 100% compliance across 24 commands with automated validation tooling. |
|
|
36
|
+
|
|
37
|
+
---
|
|
38
|
+
|
|
39
|
+
## 🖼️ Visual Showcase & Surface Demos
|
|
40
|
+
|
|
41
|
+
`tidyfactor-design` generates rich, responsive, anti-slop visual surfaces tailored to specific domain registers:
|
|
42
|
+
|
|
43
|
+
### 1. Dual-Mode Design System (Light & Dark)
|
|
44
|
+
*Dynamic theme switching powered by `brand.json` v2 token mappings (`colors.light` & `colors.dark`) without page reloads.*
|
|
45
|
+
|
|
46
|
+
| Light Mode Surface | Dark Mode Surface |
|
|
47
|
+
|---|---|
|
|
48
|
+
|  |  |
|
|
49
|
+
|
|
50
|
+
---
|
|
51
|
+
|
|
52
|
+
### 2. Application & Analytics Dashboards
|
|
53
|
+
*Data-rich layouts featuring tabular numeric formatting, KPI stat cards, filters, and shell rails.*
|
|
54
|
+
|
|
55
|
+

|
|
56
|
+
|
|
57
|
+
---
|
|
58
|
+
|
|
59
|
+
### 3. E-Commerce & Product Showcase
|
|
60
|
+
*High-conversion commerce surfaces with gallery previews, spec tables, variant selectors, and CTAs.*
|
|
61
|
+
|
|
62
|
+

|
|
63
|
+
|
|
64
|
+
---
|
|
65
|
+
|
|
66
|
+
### 4. Editorial & Magazine Publishing
|
|
67
|
+
*Literary typography hierarchy featuring Markazi Text / El Messiri headings, multi-column storytelling, and colophons.*
|
|
68
|
+
|
|
69
|
+

|
|
70
|
+
|
|
71
|
+
---
|
|
72
|
+
|
|
73
|
+
### 5. Atmospheric & Cinematic Showcase
|
|
74
|
+
*Full-bleed atmospheric storytelling with ambient background color shifts, canvas scroll-film reveals, and specular sheens.*
|
|
75
|
+
|
|
76
|
+

|
|
77
|
+
|
|
78
|
+
---
|
|
79
|
+
|
|
80
|
+
## 🔄 The 7 UI Design Lifecycle Stages & 24 Command Registry
|
|
81
|
+
|
|
82
|
+
`tidyfactor-design` structures the entire design workflow into **7 sequential stages**, providing 24 specialized slash commands that load precise operational memory without context bloat:
|
|
83
|
+
|
|
84
|
+
```mermaid
|
|
85
|
+
graph LR
|
|
86
|
+
S1["1. Discovery"] --> S2["2. Foundation"]
|
|
87
|
+
S2 --> S3["3. Architecture"]
|
|
88
|
+
S3 --> S4["4. Components"]
|
|
89
|
+
S4 --> S5["5. Motion"]
|
|
90
|
+
S5 --> S6["6. Quality"]
|
|
91
|
+
S6 --> S7["7. Delivery"]
|
|
92
|
+
```
|
|
93
|
+
|
|
94
|
+
---
|
|
95
|
+
|
|
96
|
+
### Stage 1: Discovery & Research
|
|
97
|
+
*Extract design DNA, establish context, and determine visual fit before writing code.*
|
|
98
|
+
|
|
99
|
+
| Command | Signature Syntax | What It Loads | Output & Value |
|
|
100
|
+
|---|---|---|---|
|
|
101
|
+
| **`/study`** | `/study [url\|image]` | `memory/01-design-schools.md`<br>`memory/06-quality-bar.md` | **Design DNA Report**: Samples computed styles (`getComputedStyle()`), font family declarations, and macrostructure without copying raw layout or text. |
|
|
102
|
+
| **`/brief`** | `/brief` | `memory/01-design-schools.md`<br>`memory/13-layout-archetypes.md` | **Design Context Gate**: Executes 3-question context gate (Audience mode: inspire/evaluate/act/learn, Surface type, Tone school) & Fit Test filter. |
|
|
103
|
+
|
|
104
|
+
---
|
|
105
|
+
|
|
106
|
+
### Stage 2: Foundation & System Setup
|
|
107
|
+
*Scaffold identity tokens, brand schema, color systems, typography pairings, and design schools.*
|
|
108
|
+
|
|
109
|
+
| Command | Signature Syntax | What It Loads | Output & Value |
|
|
110
|
+
|---|---|---|---|
|
|
111
|
+
| **`/init`** | `/init [dir] [--foundation=name]` | `references/workflows/init-prototype.md`<br>`references/memory/architecture.md` | **Project Scaffold**: Scaffolds clean `design-system/` directory, locked CSS foundation, `brand.json`, and initial index page. |
|
|
112
|
+
| **`/brand`** | `/brand` | `memory/11-brand-json-v2.md`<br>`memory/02-design-tokens.md` | **Brand Schema v2**: Configures dual-mode `colors.light/dark` (16 tokens each), `shadows.focusRing`, motion tokens, and accessibility floors. |
|
|
113
|
+
| **`/typography`** | `/typography` | `memory/12-typography-matrix.md`<br>`memory/08-arabic-bilingual.md` | **Typography Matrix**: Routes to 7 curated Arabic + Latin font pairings (e.g. El Messiri/Tajawal, Markazi Text/IBM Plex, Jomhuria display). |
|
|
114
|
+
| **`/school`** | `/school [movement]` | `memory/01-design-schools.md` | **Visual Movement**: Locks design language direction (Minimalist, Brutalism, Glassmorphism, Neumorphism, Swiss, Luxury). |
|
|
115
|
+
| **`/tokens`** | `/tokens` | `memory/02-design-tokens.md`<br>`references/memory/architecture.md` | **Token Single Source**: Manages `design-system/tokens.css` custom properties and mapping rules. |
|
|
116
|
+
| **`/palette`** | `/palette <image>` | `memory/02-design-tokens.md`<br>`memory/10-python-tooling.md` | **Palette Extractor**: Runs `extract_palette.py` to derive dominant brand colors and WCAG 2.1 AA contrast scores. |
|
|
117
|
+
| **`/assets`** | `/assets` | `memory/10-python-tooling.md` | **Asset Hygiene**: Automated background removal (`rembg`), WebP compression, and image optimization (`optimize_images.py`). |
|
|
118
|
+
|
|
119
|
+
---
|
|
120
|
+
|
|
121
|
+
### Stage 3: Architecture & Layout Structuring
|
|
122
|
+
*Blueprint page macrostructures, navigation patterns, and surface layouts.*
|
|
123
|
+
|
|
124
|
+
| Command | Signature Syntax | What It Loads | Output & Value |
|
|
125
|
+
|---|---|---|---|
|
|
126
|
+
| **`/layout`** | `/layout [archetype]` | `memory/13-layout-archetypes.md`<br>`references/memory/architecture.md` | **Layout Archetypes**: Applies 8 specialized blueprints (`fullbleed`, `editorial`, `spatial`, `interface`, `minimal`, `product`, `store`, `auto`). |
|
|
127
|
+
| **`/nav-footer`** | `/nav-footer` | `memory/14-nav-footer-catalog.md`<br>`memory/06-quality-bar.md` | **Nav & Footer Catalog**: Selects Navigation (N1–N9, e.g. Floating Pill, Newspaper Masthead) & Footer (Ft1–Ft8) avoiding generic AI templates. |
|
|
128
|
+
| **`/page`** | `/page <name>` | `references/workflows/init-prototype.md`<br>`memory/05-component-anatomy.md` | **Marketing Screen**: Scaffolds content or landing page markup ONLY (`pages/<name>.html`) with zero inline CSS/JS. |
|
|
129
|
+
| **`/dashboard`** | `/dashboard <name>` | `references/workflows/init-prototype.md`<br>`memory/05-component-anatomy.md` | **Application Screen**: Scaffolds data dashboard or web app shell with stat cards, data tables, and filters. |
|
|
130
|
+
|
|
131
|
+
---
|
|
132
|
+
|
|
133
|
+
### Stage 4: Component Design & State Matrix
|
|
134
|
+
*Build reusable UI component classes with complete interactive state handling.*
|
|
135
|
+
|
|
136
|
+
| Command | Signature Syntax | What It Loads | Output & Value |
|
|
137
|
+
|---|---|---|---|
|
|
138
|
+
| **`/components`** | `/components` | `memory/05-component-anatomy.md`<br>`references/memory/architecture.md` | **Component Library**: Builds reusable classes in `design-system/components.css` and generates 8-State Demo Wrappers (`.preview.html`). |
|
|
139
|
+
| **`/states`** | `/states` | `memory/05-component-anatomy.md`<br>`memory/07-consistency-contract.md` | **State Matrix**: Enforces 8 interactive component states (Default, Hover, Active, Focus-Visible, Disabled, Loading, Error, Success). |
|
|
140
|
+
|
|
141
|
+
---
|
|
142
|
+
|
|
143
|
+
### Stage 5: Motion & Interactive Experience
|
|
144
|
+
*Choreograph entrance reveals, scroll-driven effects, micro-interactions, and localization.*
|
|
145
|
+
|
|
146
|
+
| Command | Signature Syntax | What It Loads | Output & Value |
|
|
147
|
+
|---|---|---|---|
|
|
148
|
+
| **`/motion`** | `/motion` | `memory/04-motion-principles.md` | **Motion Choreography**: Implements 4-tier whimsy taxonomy, background `#ambient` color shifts, canvas scroll-film engines, and z-stack layers. |
|
|
149
|
+
| **`/flow`** | `/flow` | `memory/09-prototype-flow.md` | **Interactive Flow**: Wires floating prototype navigation toolbar (`proto-nav.js`) for screen-to-screen clickable testing. |
|
|
150
|
+
| **`/i18n`** | `/i18n` | `memory/08-arabic-bilingual.md` | **Arabic & RTL Engine**: Configures `dir="rtl"` logical properties, Arabic typography, and cultural modesty guidelines. |
|
|
151
|
+
|
|
152
|
+
---
|
|
153
|
+
|
|
154
|
+
### Stage 6: Quality Assurance & Audit
|
|
155
|
+
*Verify performance budgets, enforce anti-slop rules, and reverse-engineer legacy sites.*
|
|
156
|
+
|
|
157
|
+
| Command | Signature Syntax | What It Loads | Output & Value |
|
|
158
|
+
|---|---|---|---|
|
|
159
|
+
| **`/perf`** | `/perf` | `memory/15-performance-budget.md` | **Performance Budget Audit**: Generates data table verifying asset weight limits (hero cutout ≤ 400KB, fonts ≤ 3 families/4 weights, logo ≤ 40KB). |
|
|
160
|
+
| **`/audit`** | `/audit` | `references/workflows/audit-prototype.md`<br>`memory/06-quality-bar.md` | **Quality Bar Audit**: Executes read-only compliance report against 16 AI anti-pattern tells and structural consistency contract. |
|
|
161
|
+
| **`/clone`** | `/clone <url>` | `references/workflows/clone-prototype.md`<br>`memory/03-narrative-conversion.md` | **Design System Extraction**: Reverse-engineers external sites by sampling computed styles and token mapping into `brand.json`. |
|
|
162
|
+
| **`/retrofit`** | `/retrofit` | `references/workflows/retrofit-prototype.md`<br>`memory/07-consistency-contract.md` | **Prototype Unification**: Refactors drifted multi-page prototypes to adopt a central shared `design-system/`. |
|
|
163
|
+
|
|
164
|
+
---
|
|
165
|
+
|
|
166
|
+
### Stage 7: Delivery & Developer Handoff
|
|
167
|
+
*Package production assets, export documentation, and run deployment servers.*
|
|
168
|
+
|
|
169
|
+
| Command | Signature Syntax | What It Loads | Output & Value |
|
|
170
|
+
|---|---|---|---|
|
|
171
|
+
| **`/handoff`** | `/handoff` | `memory/11-brand-json-v2.md`<br>`memory/05-component-anatomy.md` | **Developer Handoff Package**: Exports token mapping tables, 8-state component specs, grid container rules, and motion curves into `docs/handoff/`. |
|
|
172
|
+
| **`/deploy`** | `/deploy` | `memory/06-quality-bar.md`<br>`memory/10-python-tooling.md` | **Production Export**: Launches local preview server, runs `test_build.py`, asset minification, and generates release bundle (`build.py`). |
|
|
173
|
+
|
|
174
|
+
---
|
|
175
|
+
|
|
176
|
+
## 🎨 8 Pluggable CSS Foundations
|
|
177
|
+
|
|
178
|
+
Lock a CSS foundation once per project during `/init`. Never mix foundations in the same project:
|
|
179
|
+
|
|
180
|
+
| Foundation | Command Flag | Best For | Architecture Details |
|
|
181
|
+
|---|---|---|---|
|
|
182
|
+
| **Native CSS** | `--foundation=native` | Pure zero-dependency design systems | Custom CSS variables & semantic component classes in `tokens.css` & `components.css`. |
|
|
183
|
+
| **Tailwind Utility** | `--foundation=tailwind` | Fast utility-first prototyping | Tailwind v4 utility engine via CDN with custom design-token utility mappings. |
|
|
184
|
+
| **daisyUI** | `--foundation=daisyui` | Rapid web application screens | Tailwind CDN + daisyUI component library themed via custom token CSS variables. |
|
|
185
|
+
| **Hybrid** | `--foundation=hybrid` | Signature brand apps & dashboards | daisyUI composite application widgets + Native CSS for signature brand components. |
|
|
186
|
+
| **shadcn/ui** | `--foundation=shadcn` | Accessible primitive tokens | Tailwind v4 + Radix UI accessible token mapping & design primitive styles. |
|
|
187
|
+
| **Pico CSS v2** | `--foundation=pico` | Ultra-fast semantic minimalist sites | Semantic HTML5 tags styled cleanly without utility class bloat. |
|
|
188
|
+
| **Bootstrap 5.3** | `--foundation=bootstrap` | Enterprise apps & dark themes | Enterprise CSS variables with native `data-bs-theme="dark"` theme switching. |
|
|
189
|
+
| **Alpine + Tailwind** | `--foundation=alpine` | Interactive client micro-interactions | Alpine.js reactive state directives (`x-data`, `x-on`) paired with Tailwind v4 utilities. |
|
|
190
|
+
|
|
191
|
+
---
|
|
192
|
+
|
|
193
|
+
## 🛡️ Anti-Slop Governance & Quality Bar (Rule 8)
|
|
194
|
+
|
|
195
|
+
`tidyfactor-design` enforces strict anti-slop rules derived from premier design engineering standards (*Taste-Skill*, *Hallmark*, *Anthropic Frontend-Design*, *Website Cloner*).
|
|
196
|
+
|
|
197
|
+
> [!IMPORTANT]
|
|
198
|
+
> **Pre-Emit Self-Critique Stamp**: Every generated prototype page or component is evaluated on 6 axes: **Philosophy (P)**, **Hierarchy (H)**, **Execution (E)**, **Specificity (S)**, **Restraint (R)**, and **Variety (V)**. Scores < 3 trigger an automatic revision pass before emission:
|
|
199
|
+
> `/* Pre-emit critique: P5 H4 E5 S4 R5 V5 */`
|
|
200
|
+
|
|
201
|
+
### ⚙️ The Three-Dial System (`brand.json`)
|
|
202
|
+
Configure layout asymmetry, animation depth, and data density dynamically:
|
|
203
|
+
|
|
204
|
+
```json
|
|
205
|
+
{
|
|
206
|
+
"dials": {
|
|
207
|
+
"designVariance": 8,
|
|
208
|
+
"motionIntensity": 6,
|
|
209
|
+
"visualDensity": 4
|
|
210
|
+
}
|
|
211
|
+
}
|
|
212
|
+
```
|
|
213
|
+
|
|
214
|
+
### ⛔ 16 Auto-Rejected AI Anti-Patterns
|
|
215
|
+
|
|
216
|
+
| Anti-Pattern Tell | Why It Fails | Mechanical Quality Rule |
|
|
217
|
+
|---|---|---|
|
|
218
|
+
| **Purple-Gradient Hero** | Most recognized AI template tell | Single anchor hue; no gradient hero backgrounds. |
|
|
219
|
+
| **Inter-Everywhere** | Unpaired single-font layout | Pair distinctive display + body faces (`El Messiri` / `Tajawal` / `Outfit`). |
|
|
220
|
+
| **3-Column Feature Grid** | Generic 3-equal card row | Asymmetric grid, variable card heights, or inline icon lists. |
|
|
221
|
+
| **Card-in-Card Bloat** | Unnecessary nested container cards | Banned. Flat borders or surface tinting without extra containers. |
|
|
222
|
+
| **Gradient Headline Fill** | `background-clip: text` linear gradient | Solid high-contrast text; reserve gold gradient for dark luxury accents. |
|
|
223
|
+
| **Side-Stripe Card** | 4–6px thick border on left edge of card | Banned. Clean 1px border or subtle elevation shadow. |
|
|
224
|
+
| **Full-Viewport Hero** | `min-height: 100vh` centered short sentence | Hero desktop top padding capped at `pt-24` (6rem); headline max 2 lines. |
|
|
225
|
+
| **Pure Black / White** | Pure `#000000` or `#ffffff` flat surfaces | Must use tinted neutrals (`#0F172A`, `#F8FAFC`). |
|
|
226
|
+
| **Default Sameness** | Same macrostructure across consecutive pages | Vary layout archetypes across project screens (`memory/13-layout-archetypes.md`). |
|
|
227
|
+
| **Specimen Fall-Through**| Defaulting to editorial `01 - HELLO` specimen | Match surface archetype to domain register (e.g. `interface` for SaaS). |
|
|
228
|
+
| **The AI Nav** | Wordmark left, 4 links center, CTA right | Banned. Use N1–N9 catalog (e.g. N1 Floating Pill or N5 Edge-Aligned). |
|
|
229
|
+
| **The AI Footer** | 4 equal columns + social row + copyright | Banned. Use Ft1–Ft8 catalog (e.g. Ft1 Mast-Headed or Ft5 Letter Close). |
|
|
230
|
+
| **Aurora-Blob Background** | Organic mesh blobs drifting behind hero | Banned. Use soft radial `#glow` layer or clean ambient ground. |
|
|
231
|
+
| **Floating-Orb Decoration** | Blurred 3D spheres drifting behind text | Banned. Keep background clean and focused on copy/media. |
|
|
232
|
+
| **Italic Header Trick** | Flipping one word in header to italic | Banned. Rely on genuine typographic hierarchy and weight contrast. |
|
|
233
|
+
| **Lazy-Loaded LCP** | Adding `loading="lazy"` to hero image | Banned. Hero LCP images must load eager; lazy-load below-the-fold only. |
|
|
234
|
+
|
|
235
|
+
---
|
|
236
|
+
|
|
237
|
+
## 🏛️ System Architecture & File Structure
|
|
238
|
+
|
|
239
|
+
```mermaid
|
|
240
|
+
graph TD
|
|
241
|
+
A["User Prompt / Command"] --> B["SKILL.md (~350 Tokens Load)"]
|
|
242
|
+
B --> C["24 Runtime Commands across 7 Lifecycle Stages"]
|
|
243
|
+
C --> D["Outcome Workflows (references/workflows/)"]
|
|
244
|
+
C --> E["Operational Memory (memory/ & references/memory/)"]
|
|
245
|
+
|
|
246
|
+
D --> F["Shared Design System (design-system/)"]
|
|
247
|
+
F --> G["tokens.css & brand.json (v2)"]
|
|
248
|
+
F --> H["components.css & base.css"]
|
|
249
|
+
F --> I["motion.js & interactions.js"]
|
|
250
|
+
|
|
251
|
+
G --> J["Markup-Only Pages (pages/*.html)"]
|
|
252
|
+
H --> J
|
|
253
|
+
I --> J
|
|
254
|
+
```
|
|
255
|
+
|
|
256
|
+
### 📁 Project Directory Layout
|
|
257
|
+
|
|
258
|
+
```
|
|
259
|
+
my-prototype/
|
|
260
|
+
├── design-system/
|
|
261
|
+
│ ├── tokens.css ← Single source of truth: color, typography, spacing, radius, motion
|
|
262
|
+
│ ├── base.css ← CSS reset, typography inheritance & dark mode rules
|
|
263
|
+
│ ├── components.css ← Shared component library (buttons, cards, navbars, modals)
|
|
264
|
+
│ ├── utilities.css ← Spatial layout & container helper classes
|
|
265
|
+
│ ├── motion.js ← Shared scroll-reveals, ambient color shifts & choreography
|
|
266
|
+
│ ├── interactions.js ← Shared dropdowns, tabs, modals & toggle behavior
|
|
267
|
+
│ └── brand.json ← Identity tokens, voice registers & brand dials (v2 schema)
|
|
268
|
+
├── pages/
|
|
269
|
+
│ ├── index.html ← Landing page markup ONLY (zero inline CSS/JS)
|
|
270
|
+
│ ├── dashboard.html ← App dashboard markup ONLY
|
|
271
|
+
│ └── pricing.html ← Pricing table markup ONLY
|
|
272
|
+
├── scripts/ ← Python Power Tools (palette extraction, BG removal, WebP compression)
|
|
273
|
+
├── docs/ ← Handoff specs and research documentation
|
|
274
|
+
├── proto-nav.js ← Dev-only floating prototype toolbar
|
|
275
|
+
└── brand.json ← Project-root brand identity configuration
|
|
276
|
+
```
|
|
277
|
+
|
|
278
|
+
---
|
|
279
|
+
|
|
280
|
+
## 🇸🇦 Native Arabic & RTL System
|
|
281
|
+
|
|
282
|
+
`tidyfactor-design` provides first-class support for bilingual Middle Eastern digital products:
|
|
283
|
+
|
|
284
|
+
- **Typography Rules**: Headings = **El Messiri**, Body = **Tajawal**. Never Amiri for headings above 24px.
|
|
285
|
+
- **RTL Logical Properties**: Layout direction switching (`dir="rtl"` / `dir="ltr"`) uses CSS logical properties (`margin-inline-start`, `padding-inline`, `border-inline-end`).
|
|
286
|
+
- **Modesty Guidelines**: Cultural visual rules for regional targets (modest photography selection, proper emblem placement).
|
|
287
|
+
- **RTL Nav & Toolbar**: Floating prototype toolbar (`proto-nav.js`) automatically mirrors alignment in RTL mode.
|
|
288
|
+
|
|
289
|
+
---
|
|
290
|
+
|
|
291
|
+
## 🚀 Quick Start & CLI Workflows
|
|
292
|
+
|
|
293
|
+
Published on NPM as [**`@tidyfactor/design`**](https://www.npmjs.com/package/@tidyfactor/design).
|
|
294
|
+
|
|
295
|
+
### 1. Interactive Scaffold CLI
|
|
296
|
+
|
|
297
|
+
```bash
|
|
298
|
+
# Scaffold new prototype workspace
|
|
299
|
+
npx @tidyfactor/cli-design my-proto
|
|
300
|
+
|
|
301
|
+
# Specify CSS Foundation (--foundation=native|tailwind|daisyui|hybrid|shadcn|pico|bootstrap|alpine)
|
|
302
|
+
npx @tidyfactor/cli-design my-app --foundation=native --school=luxury
|
|
303
|
+
|
|
304
|
+
# Automated AI Agent / CI mode (zero prompts)
|
|
305
|
+
npx @tidyfactor/cli-design my-design-system --yes
|
|
306
|
+
```
|
|
307
|
+
|
|
308
|
+
### 2. Inject Agent Skill into Existing Workspace
|
|
309
|
+
|
|
310
|
+
```bash
|
|
311
|
+
npx @tidyfactor/cli-design add-skill
|
|
312
|
+
```
|
|
313
|
+
*Injects `.agents/skills/tidyfactor-design/`, `.claude-skill/`, `memory/`, `templates/`, and `AGENTS.md` directly into your existing repo.*
|
|
314
|
+
|
|
315
|
+
### 3. Local Preview & Development Server
|
|
316
|
+
|
|
317
|
+
```bash
|
|
318
|
+
# Launch zero-dependency local preview server
|
|
319
|
+
python -m http.server 8123
|
|
320
|
+
|
|
321
|
+
# Open browser at http://localhost:8123
|
|
322
|
+
```
|
|
323
|
+
|
|
324
|
+
---
|
|
325
|
+
|
|
326
|
+
## 🏛️ TidyFactor Skill Methodology & 8/8 Governance Architecture
|
|
327
|
+
|
|
328
|
+
You will notice the badge **`Architect Score: 8/8 Pass (100%)`** across TidyFactor repositories. What does this mean?
|
|
329
|
+
|
|
330
|
+
The **TidyFactor Skill Methodology** (governed by [`tidyfactor-skill-architect`](file:///c:/wamp64/www/TidyFactor/Skills/Skills-LAB/.agents/skills/tidyfactor-skill-architect/)) is an opinionated, production-grade architectural framework for building AI Agent Skills. It guarantees that an agent skill is not a giant, uncontrolled prompt or a random file dump, but a structured, deterministic runtime system optimized for low latency, zero context bloat, and strict execution quality.
|
|
331
|
+
|
|
332
|
+
### 📋 The 8 Architectural Rules Every TidyFactor Skill Must Pass
|
|
333
|
+
|
|
334
|
+
| # | Governance Rule | Mechanical Specification | Value to User & AI Agents |
|
|
335
|
+
|---|---|---|---|
|
|
336
|
+
| **1** | **Dispatcher Discipline** | `SKILL.md` acts strictly as an entry-point command dispatcher (~350 tokens). It declares what commands exist and routes to workflow/memory files without carrying task execution instructions itself. | **Zero Context Waste**: Your AI Agent loads only ~350 tokens on startup instead of parsing 2,000+ lines of domain rules. |
|
|
337
|
+
| **2** | **One Workflow = One Outcome** | Every workflow file (`references/workflows/`) owns exactly one outcome and ends with an explicit, mechanical validation checklist. | **Deterministic Results**: Prevents AI hallucination or half-finished steps; guarantees tasks complete against a checklist. |
|
|
338
|
+
| **3** | **Operational Memory** | Files in `memory/` contain pure facts, rules, matrices, templates, and schemas — zero prose or narrative. | **High Signal-to-Noise**: Injects crisp, actionable domain constraints directly into the prompt without token bloat. |
|
|
339
|
+
| **4** | **No Empty Structures** | Folder hierarchies (`references/commands/`, `references/workflows/`, `memory/`) exist only when holding multiple items. | **Clean Repository**: Eliminates unnecessary file nesting and maintains portable simplicity. |
|
|
340
|
+
| **5** | **Philosophy Isolation** | Branding rationale, manifestos, or methodologies belong in optional `memory/philosophy.md` — never inside operational execution files. | **Pure Technical Execution**: Agents read only execution rules without parsing marketing philosophy. |
|
|
341
|
+
| **6** | **Trigger-Justified Growth** | New commands and memory files are added strictly when triggered by quantifiable lifecycle needs (e.g. 7-stage lifecycle expansion). | **No Speculative Bloat**: Keeps the skill lean, fast, and maintainable. |
|
|
342
|
+
| **7** | **Anti-Slop & Quality Bar** | Frontend generation workflows enforce Pre-Emit Self-Critique (1-5 scoring on 6 axes: P, H, E, S, R, V) and 16 mechanical AI anti-pattern checks. | **Guaranteed Aesthetic Quality**: Blocks generic "AI-looking" code, purple hero gradients, wrapped CTAs, and duplicate UI patterns. |
|
|
343
|
+
| **8** | **Multi-Target Parity Validation** | 100% parity across Agent skill targets (`.agents`, `.claude-skill`, and root repo files) verified automatically via `node tools/validate-skill.js`. | **Cross-Platform Compatibility**: Works identically in Antigravity, Claude Code, Cursor, Codex, and Windsurf. |
|
|
344
|
+
|
|
345
|
+
---
|
|
346
|
+
|
|
347
|
+
|
|
348
|
+
---
|
|
349
|
+
|
|
350
|
+
## 🏛️ TidyFactor Ecosystem Architecture
|
|
351
|
+
|
|
352
|
+
**TidyFactor** is a modular web architecture and AI coding agent skill ecosystem built on clear separation of concerns across the product lifecycle:
|
|
353
|
+
|
|
354
|
+
```
|
|
355
|
+
TidyFactor Organization (github.com/TidyFactor)
|
|
356
|
+
│
|
|
357
|
+
├── Design Skills
|
|
358
|
+
│ ├── Cinematic → Experience / "Wow" (Apple × Cartier Scroll-Driven Landing Pages)
|
|
359
|
+
│ ├── Design → Prototype / "Build" (Code-Native UI Design Engine & Figma Alternative)
|
|
360
|
+
│ └── Styler → Production / "Ship" (Framework Styler & RTL Polish Engine)
|
|
361
|
+
│
|
|
362
|
+
├── Development Skills
|
|
363
|
+
│ ├── HTML → Content & Static (Semantic SEO & Static Platform Starter)
|
|
364
|
+
│ ├── HTMX → Hypermedia (Server-Driven Micro-Interactions)
|
|
365
|
+
│ ├── JS → Vanilla SPA (Framework-Free Reactive ES Modules)
|
|
366
|
+
│ ├── PHP → Server-Rendered (Modern PHP 8.x Component UI & Architecture)
|
|
367
|
+
│ └── Next → Multi-Tenant SaaS (Next.js 16, React 19, Supabase RLS & Dev-Perf)
|
|
368
|
+
│
|
|
369
|
+
└── Growth Skills
|
|
370
|
+
└── Marketing → Growth / Revenue (Direct Response, Pillar SEO & Content Lifecycles)
|
|
371
|
+
```
|
|
372
|
+
|
|
373
|
+
### 💎 Frontend Triad
|
|
374
|
+
|
|
375
|
+
```
|
|
376
|
+
TidyFactor
|
|
377
|
+
│
|
|
378
|
+
┌─────────┼─────────┐
|
|
379
|
+
│ │ │
|
|
380
|
+
Cinematic Design Styler
|
|
381
|
+
│ │ │
|
|
382
|
+
Experience Prototype Production
|
|
383
|
+
│ │ │
|
|
384
|
+
"Wow" "Build" "Ship"
|
|
385
|
+
```
|
|
386
|
+
|
|
387
|
+
### 📦 Community Package & Skill Parity
|
|
388
|
+
|
|
389
|
+
| Track | Category | GitHub Repository | Agent Skill | NPM Package |
|
|
390
|
+
| :--- | :--- | :--- | :--- | :--- |
|
|
391
|
+
| **Cinematic** | Design | [`TidyFactor/Cinematic`](https://github.com/TidyFactor/Cinematic) | `tidyfactor-cinematic` | [`@tidyfactor/cinematic`](https://www.npmjs.com/package/@tidyfactor/cinematic) |
|
|
392
|
+
| **Design** | Design | [`TidyFactor/Design`](https://github.com/TidyFactor/Design) | `tidyfactor-design` | [`@tidyfactor/design`](https://www.npmjs.com/package/@tidyfactor/design) |
|
|
393
|
+
| **Styler** | Design | [`TidyFactor/Styler`](https://github.com/TidyFactor/Styler) | `tidyfactor-styler` | [`@tidyfactor/styler`](https://www.npmjs.com/package/@tidyfactor/styler) |
|
|
394
|
+
| **Next** | Development | [`TidyFactor/Next`](https://github.com/TidyFactor/Next) | `tidyfactor-next` | [`@tidyfactor/next`](https://www.npmjs.com/package/@tidyfactor/next) |
|
|
395
|
+
| **HTML** | Development | [`TidyFactor/HTML`](https://github.com/TidyFactor/HTML) | `tidyfactor-html` | [`@tidyfactor/html`](https://www.npmjs.com/package/@tidyfactor/html) |
|
|
396
|
+
| **HTMX** | Development | [`TidyFactor/HTMX`](https://github.com/TidyFactor/HTMX) | `tidyfactor-htmx` | [`@tidyfactor/htmx`](https://www.npmjs.com/package/@tidyfactor/htmx) |
|
|
397
|
+
| **JS** | Development | [`TidyFactor/JS`](https://github.com/TidyFactor/JS) | `tidyfactor-js` | [`@tidyfactor/js`](https://www.npmjs.com/package/@tidyfactor/js) |
|
|
398
|
+
| **PHP** | Development | [`TidyFactor/PHP`](https://github.com/TidyFactor/PHP) | `tidyfactor-php` | [`@tidyfactor/php`](https://www.npmjs.com/package/@tidyfactor/php) |
|
|
399
|
+
| **Marketing** | Growth | [`TidyFactor/Marketing`](https://github.com/TidyFactor/Marketing) | `tidyfactor-marketing` | [`@tidyfactor/marketing`](https://www.npmjs.com/package/@tidyfactor/marketing) |
|
|
400
|
+
|
|
401
|
+
---
|
|
402
|
+
|
|
403
|
+
## 👨💻 Organization & Support
|
|
404
|
+
|
|
405
|
+
- 🌐 **Official Website:** [https://tidyfactor.com/](https://tidyfactor.com/)
|
|
406
|
+
- 📚 **Official Documentation:** [https://tidyfactor.com/documentation](https://tidyfactor.com/documentation)
|
|
407
|
+
- 🤝 **Official Partner Website:** [Alwkala Digital Agency](https://alwkala.com/)
|
|
408
|
+
- 🐙 **GitHub Organization:** [github.com/TidyFactor](https://github.com/TidyFactor)
|
|
409
|
+
- 📧 **Business Inquiries:** [hello@tidyfactor.com](mailto:hello@tidyfactor.com)
|
|
410
|
+
- 📱 **WhatsApp:** [+20 101 665 6899](https://wa.me/201016656899)
|
|
411
|
+
- 📞 **Phone:** +20 101 665 6899
|
|
412
|
+
- 📍 **Location:** Cairo, Egypt
|
|
413
|
+
|
|
414
|
+
---
|
|
415
|
+
|
|
416
|
+
## 📜 License
|
|
417
|
+
|
|
418
|
+
Licensed under the **Apache License 2.0**. Copyright (c) 2026 [TidyFactor](https://tidyfactor.com) & [Alwkala](https://alwkala.com).
|
package/README.pt.md
ADDED
|
@@ -0,0 +1,44 @@
|
|
|
1
|
+
<div align="center">
|
|
2
|
+
|
|
3
|
+
# tidyfactor-design `v1.5.0`
|
|
4
|
+
|
|
5
|
+
**Motor de Ciclo de Vida de Design UI Nativo em Código e Prototipagem Interativa para Agentes de IA**
|
|
6
|
+
|
|
7
|
+
[](https://www.npmjs.com/package/@tidyfactor/design)
|
|
8
|
+
[](LICENSE)
|
|
9
|
+
|
|
10
|
+
[ English ](README.md) • [ العربية ](README.ar.md) • [ فارسی ](README.fa.md) • [ Español ](README.es.md) • [ Português ](README.pt.md) • [ 简体中文 ](README.zh.md) • [ Deutsch ](README.de.md) • [ Français ](README.fr.md)
|
|
11
|
+
|
|
12
|
+
</div>
|
|
13
|
+
|
|
14
|
+
---
|
|
15
|
+
|
|
16
|
+
## ⚡ Início Rápido (Quickstart)
|
|
17
|
+
|
|
18
|
+
```bash
|
|
19
|
+
# Instalação e execução via NPX
|
|
20
|
+
npx @tidyfactor/cli-design
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
Ou execute diretamente dentro do seu assistente de IA (*Google Antigravity, Claude Code, Cursor, Codex*):
|
|
24
|
+
```text
|
|
25
|
+
/tidyfactor-design
|
|
26
|
+
```
|
|
27
|
+
|
|
28
|
+
---
|
|
29
|
+
|
|
30
|
+
## 📋 Matriz de Comandos Principais
|
|
31
|
+
|
|
32
|
+
| Comando | Objetivo e Resultado | Fluxo de Trabalho |
|
|
33
|
+
|---|---|---|
|
|
34
|
+
| `/brief` | Briefing de diseño y descubrimiento de marca | `workflows/brief.md` |
|
|
35
|
+
| `/tokens` | Generación de design tokens y escalas | `workflows/tokens.md` |
|
|
36
|
+
| `/components` | Prototipado interactivo de componentes UI | `workflows/components.md` |
|
|
37
|
+
| `/page` | Montaje de páginas completas interactivas | `workflows/page.md` |
|
|
38
|
+
| `/rtl` | Validación y soporte nativo RTL/Árabe | `workflows/rtl.md` |
|
|
39
|
+
|
|
40
|
+
---
|
|
41
|
+
|
|
42
|
+
## 📖 Especificação Técnica Canônica
|
|
43
|
+
|
|
44
|
+
Para a arquitetura detalhada, esquemas JSON completos e código fonte nativo, consulte a [Documentação Técnica Canônica em Inglês (README.md)](README.md).
|
package/README.zh.md
ADDED
|
@@ -0,0 +1,44 @@
|
|
|
1
|
+
<div align="center">
|
|
2
|
+
|
|
3
|
+
# tidyfactor-design `v1.5.0`
|
|
4
|
+
|
|
5
|
+
**面向 AI 智能体的代码原生 UI 设计生命周期与高保真交互原型引擎**
|
|
6
|
+
|
|
7
|
+
[](https://www.npmjs.com/package/@tidyfactor/design)
|
|
8
|
+
[](LICENSE)
|
|
9
|
+
|
|
10
|
+
[ English ](README.md) • [ العربية ](README.ar.md) • [ فارسی ](README.fa.md) • [ Español ](README.es.md) • [ Português ](README.pt.md) • [ 简体中文 ](README.zh.md) • [ Deutsch ](README.de.md) • [ Français ](README.fr.md)
|
|
11
|
+
|
|
12
|
+
</div>
|
|
13
|
+
|
|
14
|
+
---
|
|
15
|
+
|
|
16
|
+
## ⚡ 快速上手 (Quickstart)
|
|
17
|
+
|
|
18
|
+
```bash
|
|
19
|
+
# 通过 NPX 快速运行
|
|
20
|
+
npx @tidyfactor/cli-design
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
或在 AI 编码助手 (*Google Antigravity, Claude Code, Cursor, Codex*) 中调用:
|
|
24
|
+
```text
|
|
25
|
+
/tidyfactor-design
|
|
26
|
+
```
|
|
27
|
+
|
|
28
|
+
---
|
|
29
|
+
|
|
30
|
+
## 📋 核心命令矩阵
|
|
31
|
+
|
|
32
|
+
| 命令 | 目标与产出 | 执行工作流 |
|
|
33
|
+
|---|---|---|
|
|
34
|
+
| `/brief` | Briefing de diseño y descubrimiento de marca | `workflows/brief.md` |
|
|
35
|
+
| `/tokens` | Generación de design tokens y escalas | `workflows/tokens.md` |
|
|
36
|
+
| `/components` | Prototipado interactivo de componentes UI | `workflows/components.md` |
|
|
37
|
+
| `/page` | Montaje de páginas completas interactivas | `workflows/page.md` |
|
|
38
|
+
| `/rtl` | Validación y soporte nativo RTL/Árabe | `workflows/rtl.md` |
|
|
39
|
+
|
|
40
|
+
---
|
|
41
|
+
|
|
42
|
+
## 📖 完整技术规范与文档
|
|
43
|
+
|
|
44
|
+
如需查看深层架构设计、完整 JSON Schema 契约和原生代码,请参阅[英文权威技术文档 (README.md)](README.md)。
|
|
@@ -0,0 +1,69 @@
|
|
|
1
|
+
# Skill Registry — tidyfactor-design
|
|
2
|
+
|
|
3
|
+
> Part of the **[TidyFactor Skills-LAB](../)** ecosystem.
|
|
4
|
+
> Vision: **[TidyFactor-VISION.md](../TidyFactor-VISION.md)**
|
|
5
|
+
|
|
6
|
+
---
|
|
7
|
+
|
|
8
|
+
## Identity (100% Unified Naming)
|
|
9
|
+
|
|
10
|
+
| Field | Value |
|
|
11
|
+
|---|---|
|
|
12
|
+
| **Unified Tool Name** | `tidyfactor-design` |
|
|
13
|
+
| **NPM Package** | [`@tidyfactor/design`](https://www.npmjs.com/package/@tidyfactor/design) |
|
|
14
|
+
| **CLI Execution Command** | `npx @tidyfactor/cli-design` or `npx tidyfactor-design` |
|
|
15
|
+
| **Skill Injection Command** | `npx @tidyfactor/cli-design add-skill` or `npx tidyfactor-design add-skill` |
|
|
16
|
+
| **GitHub Repository** | [alwkala/tidyfactor-design](https://github.com/alwkala/tidyfactor-design) |
|
|
17
|
+
| **Version** | `1.3.8` |
|
|
18
|
+
| **Category** | Full UI Design Lifecycle & Prototyping Engine |
|
|
19
|
+
| **Output** | Code-native interactive HTML/CSS/JS prototype system |
|
|
20
|
+
| **Commercial Partner** | [Alwkala](https://alwkala.com) |
|
|
21
|
+
| **License** | [MIT License](LICENSE) |
|
|
22
|
+
|
|
23
|
+
---
|
|
24
|
+
|
|
25
|
+
## What This Skill Does
|
|
26
|
+
|
|
27
|
+
A **code-native, AI-era alternative to Figma and complete UI Design Lifecycle engine**. Supports all 7 stages of UI Design (Discovery, Foundation, Architecture, Components, Motion, Quality, Delivery) while structurally guaranteeing visual consistency across all screens — zero per-page CSS/JS, zero inline `<style>` or `<script>` tags, zero build step.
|
|
28
|
+
|
|
29
|
+
---
|
|
30
|
+
|
|
31
|
+
## 8 Pluggable CSS Foundations
|
|
32
|
+
|
|
33
|
+
| Foundation | Best For | Architecture |
|
|
34
|
+
|---|---|---|
|
|
35
|
+
| `native` | Zero dependencies, total brand control | Custom CSS variables + semantic component classes |
|
|
36
|
+
| `tailwind` | Utility-first workflows | Tailwind CDN + utility class mapping |
|
|
37
|
+
| `daisyui` | Rapid composite components | Tailwind CDN + daisyUI plugin + themed variables |
|
|
38
|
+
| `hybrid` | Signature brand + composite widgets | daisyUI composite widgets + Native brand classes |
|
|
39
|
+
| `shadcn` | High accessibility & Radix primitives | Tailwind v4 + Radix UI accessible token mappings |
|
|
40
|
+
| `pico` | Ultra-fast semantic minimalist sites | Semantic HTML5 tags styled without utility bloat |
|
|
41
|
+
| `bootstrap` | Enterprise apps & dark mode themes | Enterprise CSS variables & `data-bs-theme="dark"` |
|
|
42
|
+
| `alpine` | Client micro-interactions | Alpine.js reactive state (`x-data`) + Tailwind v4 |
|
|
43
|
+
|
|
44
|
+
---
|
|
45
|
+
|
|
46
|
+
## 24 Skill Commands (7 Lifecycle Stages)
|
|
47
|
+
|
|
48
|
+
```
|
|
49
|
+
1. Discovery: study · brief
|
|
50
|
+
2. Foundation: init · brand · typography · school · tokens · palette · assets
|
|
51
|
+
3. Architecture: layout · nav-footer · page · dashboard
|
|
52
|
+
4. Components: components · states
|
|
53
|
+
5. Motion: motion · flow · i18n
|
|
54
|
+
6. Quality: perf · audit · clone · retrofit
|
|
55
|
+
7. Delivery: handoff · deploy
|
|
56
|
+
```
|
|
57
|
+
|
|
58
|
+
Full specs: `references/commands/`
|
|
59
|
+
|
|
60
|
+
---
|
|
61
|
+
|
|
62
|
+
## Single Source of Truth & Build Workflow
|
|
63
|
+
|
|
64
|
+
This folder (`tidyfactor-design`) inside `Skills-LAB` is the **canonical Single Source of Truth** for the skill.
|
|
65
|
+
|
|
66
|
+
To validate and rebuild the packaged skill archive (`tidyfactor-design.skill`):
|
|
67
|
+
```bash
|
|
68
|
+
node tools/build-skill.js
|
|
69
|
+
```
|
package/SKILL.md
ADDED
|
@@ -0,0 +1,46 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: tidyfactor-design
|
|
3
|
+
description: "Code-native UI design lifecycle engine (Figma alternative) with Contextual Decision Layer (CDL). Supports all 7 design stages with zero per-page CSS/JS and pluggable CSS foundations (Native, Tailwind, daisyUI, Pico, Hybrid). Trigger on commands 'brief', 'study', 'init', 'brand', 'tokens', 'palette', 'layout', 'components', 'page', 'dashboard', 'motion', 'i18n', 'audit', 'deploy', or design system requests."
|
|
4
|
+
---
|
|
5
|
+
# TidyFactor Design (Code-Native UI Design Lifecycle Engine)
|
|
6
|
+
|
|
7
|
+
A command dispatcher supporting the full UI design lifecycle—from discovery through developer handoff—with zero build steps and complete design system consistency.
|
|
8
|
+
|
|
9
|
+
## Lifecycle Commands (7 Stages)
|
|
10
|
+
|
|
11
|
+
| Lifecycle Stage | User intent | Command | What it loads |
|
|
12
|
+
|---|---|---|---|
|
|
13
|
+
| **1. Discovery** | Strategic Design Discovery & Brief Resolution | `references/commands/brief.md` | `references/workflows/brief.md` + `references/memory/decision-points.md` + `references/memory/quality-bar.md` |
|
|
14
|
+
| **1. Discovery** | Extract design DNA from reference URL/image | `references/commands/study.md` | `references/commands/study.md` + `references/memory/01-design-schools.md` |
|
|
15
|
+
| **2. Foundation** | Start brand-new design system / prototype | `references/commands/init.md` | `references/workflows/init-prototype.md` + `references/memory/architecture.md` + `references/memory/foundations.md` |
|
|
16
|
+
| **2. Foundation** | Scaffold or manage brand.json v2 schema | `references/commands/brand.md` | `references/commands/brand.md` + `references/memory/11-brand-json-v2.md` |
|
|
17
|
+
| **2. Foundation** | Select mood-routed typography pairing | `references/commands/typography.md` | `references/commands/typography.md` + `references/memory/12-typography-matrix.md` |
|
|
18
|
+
| **2. Foundation** | Choose design movement / visual direction | `references/commands/school.md` | `references/commands/school.md` + `references/memory/01-design-schools.md` |
|
|
19
|
+
| **2. Foundation** | Manage design tokens and brand colors | `references/commands/tokens.md` | `references/commands/tokens.md` + `references/memory/02-design-tokens.md` |
|
|
20
|
+
| **2. Foundation** | Scaffold color palette from reference image | `references/commands/palette.md` | `references/commands/palette.md` + `references/memory/02-design-tokens.md` |
|
|
21
|
+
| **2. Foundation** | Asset hygiene and image optimization | `references/commands/assets.md` | `references/commands/assets.md` + `references/memory/10-python-tooling.md` |
|
|
22
|
+
| **3. Architecture** | Select macrostructure layout archetype | `references/commands/layout.md` | `references/commands/layout.md` + `references/memory/13-layout-archetypes.md` |
|
|
23
|
+
| **3. Architecture** | Choose navigation (N1-N9) and footer (Ft1-Ft8) | `references/commands/nav-footer.md` | `references/commands/nav-footer.md` + `references/memory/14-nav-footer-catalog.md` |
|
|
24
|
+
| **3. Architecture** | Add a new content or marketing page | `references/commands/page.md` | `references/workflows/init-prototype.md` + `references/memory/05-component-anatomy.md` |
|
|
25
|
+
| **3. Architecture** | Add a new dashboard or app screen | `references/commands/dashboard.md` | `references/workflows/init-prototype.md` + `references/memory/05-component-anatomy.md` |
|
|
26
|
+
| **4. Components** | Manage shared UI components (8-state wrappers) | `references/commands/components.md` | `references/commands/components.md` + `references/memory/05-component-anatomy.md` |
|
|
27
|
+
| **4. Components** | Define interactive component states | `references/commands/states.md` | `references/commands/states.md` + `references/memory/05-component-anatomy.md` |
|
|
28
|
+
| **5. Motion** | Add shared animations, recipes & ambient layers | `references/commands/motion.md` | `references/commands/motion.md` + `references/memory/04-motion-principles.md` |
|
|
29
|
+
| **5. Motion** | Wire interactive prototype navigation | `references/commands/flow.md` | `references/commands/flow.md` + `references/memory/09-prototype-flow.md` |
|
|
30
|
+
| **5. Motion** | Add Arabic/RTL or bilingual localization | `references/commands/i18n.md` | `references/commands/i18n.md` + `references/memory/08-arabic-bilingual.md` |
|
|
31
|
+
| **6. Quality** | Verify asset performance budgets & size limits | `references/commands/perf.md` | `references/commands/perf.md` + `references/memory/15-performance-budget.md` |
|
|
32
|
+
| **6. Quality** | Audit structural consistency & quality bar | `references/commands/audit.md` | `references/workflows/audit-prototype.md` + `references/memory/quality-bar.md` |
|
|
33
|
+
| **6. Quality** | Extract design system from external site | `references/commands/clone.md` | `references/workflows/clone-prototype.md` + `references/memory/03-narrative-conversion.md` |
|
|
34
|
+
| **6. Quality** | Unify drifted prototype under design system | `references/commands/retrofit.md` | `references/workflows/retrofit-prototype.md` + `references/memory/07-consistency-contract.md` |
|
|
35
|
+
| **7. Delivery** | Export developer handoff specs & token map | `references/commands/handoff.md` | `references/commands/handoff.md` + `references/memory/11-brand-json-v2.md` |
|
|
36
|
+
| **7. Delivery** | Local preview and deployment | `references/commands/deploy.md` | `references/commands/deploy.md` + `references/memory/06-quality-bar.md` |
|
|
37
|
+
|
|
38
|
+
Read only the command file that matches the request. Do not load all commands simultaneously.
|
|
39
|
+
|
|
40
|
+
## Non-Negotiable Invariants
|
|
41
|
+
|
|
42
|
+
1. **Contextual Decision Layer (CDL)**: Resolve design baselines via `/brief` or `.tidyfactor/design-brief.md` before emitting code.
|
|
43
|
+
2. **Zero per-page CSS/JS**: Every visual token and component style lives inside `design-system/`. Pages contain markup only.
|
|
44
|
+
3. **Single CSS Foundation**: Lock Native, Tailwind, daisyUI, Pico, or Hybrid once per project; never mix foundations.
|
|
45
|
+
4. **Typography Discipline**: Arabic display headings use El Messiri, body copy uses Tajawal. Never use Amiri for headings above 24px.
|
|
46
|
+
5. **7-Axis Pre-Emit Critique**: All components and layouts must be evaluated with `/* Pre-emit critique: P5 H5 E5 S5 R5 V5 D5 */`.
|