Files
tsl-devkit/skills/thirdparty/ui-ux-pro-max/scripts/design_system.py
T
csh 3d83740f88 Squashed 'docs/standards/playbook/' changes from c3f8137..25d895d
25d895d 🐛 fix(gitea_workflow): clean up temp repos after job steps
2bc3b11 🐛 fix(gitea_workflow): clean up temporary repo dirs in workflows
98c3f30 📝 docs(agent_rules): allow plan execution on current branch
16c7230 📝 docs(prompts): define custom verify layering
8efc4dd 🐛 fix(skills): quote commit-message description
bc8498f 🐛 fix(ci): install tomli for gitea tests
55cda3b 🐛 fix(tests): report missing toml parser clearly
c0729c7 🐛 fix(playbook): import Optional for cli compatibility
63e24bf 📦 deps(skills): sync thirdparty skills
d2f9356 🐛 fix(ci): isolate gitea workflow repos
588b81d 🐛 fix(ci): inline gitea workflow bootstrap
e0b1c3a ♻️ refactor(skills): standardize first-party skill contracts
2c5050d ♻️ refactor(skills): rename repo skills source dir
f049dfb 📦 deps(skills): drop duplicate first-party superpowers skills
234b335  feat(workflow): add superpowers planning and execution state tracking
c1702a6 📝 docs(markdown): format tracked markdown and drop stale templates
2325409 📝 docs(markdown): clarify optional markdownlint usage
214c44e 🔧 chore(markdown): add markdownlint baseline and lint fixes
a22b324 📝 docs(templates): add execution and memory-bank prompt templates
223a797 📝 docs(templates): update README for Claude Code and current features
4ac8672 📝 docs: simplify README + platform-agnostic tools + auto-create local rules
2431c9d 📝 docs: add claude_md config and use cross-platform paths
d64b248 📝 docs: fix README.md inaccuracies and add Claude Code info
c8d6bf2 🐛 fix(playbook): use relative paths in CLAUDE.md when not at project root
6518f0f  feat(playbook): auto-create CLAUDE.md with path discovery
6ec9a45  feat(skills): add skill_link symlink support + platform-agnostic prompt
9f8b6b5 📝 docs: update README and config example for Claude Code support
79cff6c 📝 docs(skills): add Claude Code platform support
452c6f5  feat(playbook): auto-inject AGENTS.md into CLAUDE.md
e1dbf3c 🐛 fix(skills): remove dual-path from commit-message skill
f3a7259 🔧 chore(ci): use prepare_repo.sh in both workflows
da08212 🔧 chore(ci): extract prepare_repo.sh and clean up workflows
7ade85e 🗑️ remove(tsl): drop syntax_book/, data/ source and build script
f94dba0 ♻️ refactor(skills): update playbook.py and tests for thirdparty/ layout
b3df412 ♻️ refactor(skills): separate thirdparty skills into thirdparty/ subdirectory
64950e7 📦 deps(skills): sync thirdparty skills
a2e3cb0  feat(playbook): add no_backup deploy controls
8609d59 🐛 fix(docs): repair reference catalog source links
956da11 🐛 fix(playbook): publish hidden ci test fixes
3f67754 📦 deps(skills): sync thirdparty skills
08ca87b 📦 deps(skills): add karpathy thirdparty sync
96b705b 📝 docs(tsl): rebuild canonical syntax and routing manual
3ed5052 📦 deps(skills): sync thirdparty skills
60108dd 📦 deps(skills): sync thirdparty skills
da85d4e 🐛 fix(thirdparty): prune nested project snapshots
a2a697e 📦 deps(skills): sync thirdparty skills
9df610a 🐛 fix(thirdparty): exclude duplicated superpowers skills
33dd5bb 🐛 fix(thirdparty): preserve optional manifest fields
91b0ea7 🐛 fix(thirdparty): preserve manifest during snapshot update
2e26f98 🔧 chore(thirdparty): generalize skills sync pipeline
5b9c1e3 📦 deps(skills): sync superpowers
2f2d34a 📝 docs(readme): normalize subtree command spacing
62db7db 🐛 fix(ci): serialize superpowers update and sync
3463223 🐛 fix(ci): use literal superpowers sync paths
48f6de8 📦 deps(skills): sync superpowers
4b23529 🔧 chore(ci): merge superpowers update and sync workflow
a56d75b 📦 deps(skills): sync superpowers
84bcefa 🔧 chore(ci): use ci[bot] commit author name
00a07e5 📦 deps(skills): sync superpowers
7b84daf 🐛 fix(templates): enforce main loop progress tracking
51373d7 🔧 chore(ci): automate superpowers sync workflow
eaaa39c 🐛 fix(ci): prevent stale superpowers sync from restoring skills block
79755c6 📦 deps(skills): sync superpowers
836d878 📦 deps(skills): sync superpowers
8216c9f 📦 deps(skills): sync superpowers
9439505 🐛 fix(playbook): address reported repo issues

git-subtree-dir: docs/standards/playbook
git-subtree-split: 25d895d8b3f56624ccfe99ad7289e9eb49e0f316
2026-05-24 13:04:14 +08:00

1149 lines
46 KiB
Python

#!/usr/bin/env python3
# -*- coding: utf-8 -*-
"""
Design System Generator - Aggregates search results and applies reasoning
to generate comprehensive design system recommendations.
Usage:
from design_system import generate_design_system
result = generate_design_system("SaaS dashboard", "My Project")
# With persistence (Master + Overrides pattern)
result = generate_design_system("SaaS dashboard", "My Project", persist=True)
result = generate_design_system("SaaS dashboard", "My Project", persist=True, page="dashboard")
"""
import csv
import json
import os
from datetime import datetime
from pathlib import Path
from core import search, DATA_DIR
# ============ CONFIGURATION ============
REASONING_FILE = "ui-reasoning.csv"
SEARCH_CONFIG = {
"product": {"max_results": 1},
"style": {"max_results": 3},
"color": {"max_results": 2},
"landing": {"max_results": 2},
"typography": {"max_results": 2}
}
# ============ DESIGN SYSTEM GENERATOR ============
class DesignSystemGenerator:
"""Generates design system recommendations from aggregated searches."""
def __init__(self):
self.reasoning_data = self._load_reasoning()
def _load_reasoning(self) -> list:
"""Load reasoning rules from CSV."""
filepath = DATA_DIR / REASONING_FILE
if not filepath.exists():
return []
with open(filepath, 'r', encoding='utf-8') as f:
return list(csv.DictReader(f))
def _multi_domain_search(self, query: str, style_priority: list = None) -> dict:
"""Execute searches across multiple domains."""
results = {}
for domain, config in SEARCH_CONFIG.items():
if domain == "style" and style_priority:
# For style, also search with priority keywords
priority_query = " ".join(style_priority[:2]) if style_priority else query
combined_query = f"{query} {priority_query}"
results[domain] = search(combined_query, domain, config["max_results"])
else:
results[domain] = search(query, domain, config["max_results"])
return results
def _find_reasoning_rule(self, category: str) -> dict:
"""Find matching reasoning rule for a category."""
category_lower = category.lower()
# Try exact match first
for rule in self.reasoning_data:
if rule.get("UI_Category", "").lower() == category_lower:
return rule
# Try partial match
for rule in self.reasoning_data:
ui_cat = rule.get("UI_Category", "").lower()
if ui_cat in category_lower or category_lower in ui_cat:
return rule
# Try keyword match
for rule in self.reasoning_data:
ui_cat = rule.get("UI_Category", "").lower()
keywords = ui_cat.replace("/", " ").replace("-", " ").split()
if any(kw in category_lower for kw in keywords):
return rule
return {}
def _apply_reasoning(self, category: str, search_results: dict) -> dict:
"""Apply reasoning rules to search results."""
rule = self._find_reasoning_rule(category)
if not rule:
return {
"pattern": "Hero + Features + CTA",
"style_priority": ["Minimalism", "Flat Design"],
"color_mood": "Professional",
"typography_mood": "Clean",
"key_effects": "Subtle hover transitions",
"anti_patterns": "",
"decision_rules": {},
"severity": "MEDIUM"
}
# Parse decision rules JSON
decision_rules = {}
try:
decision_rules = json.loads(rule.get("Decision_Rules", "{}"))
except json.JSONDecodeError:
pass
return {
"pattern": rule.get("Recommended_Pattern", ""),
"style_priority": [s.strip() for s in rule.get("Style_Priority", "").split("+")],
"color_mood": rule.get("Color_Mood", ""),
"typography_mood": rule.get("Typography_Mood", ""),
"key_effects": rule.get("Key_Effects", ""),
"anti_patterns": rule.get("Anti_Patterns", ""),
"decision_rules": decision_rules,
"severity": rule.get("Severity", "MEDIUM")
}
def _select_best_match(self, results: list, priority_keywords: list) -> dict:
"""Select best matching result based on priority keywords."""
if not results:
return {}
if not priority_keywords:
return results[0]
# First: try exact style name match
for priority in priority_keywords:
priority_lower = priority.lower().strip()
for result in results:
style_name = result.get("Style Category", "").lower()
if priority_lower in style_name or style_name in priority_lower:
return result
# Second: score by keyword match in all fields
scored = []
for result in results:
result_str = str(result).lower()
score = 0
for kw in priority_keywords:
kw_lower = kw.lower().strip()
# Higher score for style name match
if kw_lower in result.get("Style Category", "").lower():
score += 10
# Lower score for keyword field match
elif kw_lower in result.get("Keywords", "").lower():
score += 3
# Even lower for other field matches
elif kw_lower in result_str:
score += 1
scored.append((score, result))
scored.sort(key=lambda x: x[0], reverse=True)
return scored[0][1] if scored and scored[0][0] > 0 else results[0]
def _extract_results(self, search_result: dict) -> list:
"""Extract results list from search result dict."""
return search_result.get("results", [])
def generate(self, query: str, project_name: str = None) -> dict:
"""Generate complete design system recommendation."""
# Step 1: First search product to get category
product_result = search(query, "product", 1)
product_results = product_result.get("results", [])
category = "General"
if product_results:
category = product_results[0].get("Product Type", "General")
# Step 2: Get reasoning rules for this category
reasoning = self._apply_reasoning(category, {})
style_priority = reasoning.get("style_priority", [])
# Step 3: Multi-domain search with style priority hints
search_results = self._multi_domain_search(query, style_priority)
search_results["product"] = product_result # Reuse product search
# Step 4: Select best matches from each domain using priority
style_results = self._extract_results(search_results.get("style", {}))
color_results = self._extract_results(search_results.get("color", {}))
typography_results = self._extract_results(search_results.get("typography", {}))
landing_results = self._extract_results(search_results.get("landing", {}))
best_style = self._select_best_match(style_results, reasoning.get("style_priority", []))
best_color = color_results[0] if color_results else {}
best_typography = typography_results[0] if typography_results else {}
best_landing = landing_results[0] if landing_results else {}
# Step 5: Build final recommendation
# Combine effects from both reasoning and style search
style_effects = best_style.get("Effects & Animation", "")
reasoning_effects = reasoning.get("key_effects", "")
combined_effects = style_effects if style_effects else reasoning_effects
return {
"project_name": project_name or query.upper(),
"category": category,
"pattern": {
"name": best_landing.get("Pattern Name", reasoning.get("pattern", "Hero + Features + CTA")),
"sections": best_landing.get("Section Order", "Hero > Features > CTA"),
"cta_placement": best_landing.get("Primary CTA Placement", "Above fold"),
"color_strategy": best_landing.get("Color Strategy", ""),
"conversion": best_landing.get("Conversion Optimization", "")
},
"style": {
"name": best_style.get("Style Category", "Minimalism"),
"type": best_style.get("Type", "General"),
"effects": style_effects,
"keywords": best_style.get("Keywords", ""),
"best_for": best_style.get("Best For", ""),
"performance": best_style.get("Performance", ""),
"accessibility": best_style.get("Accessibility", ""),
"light_mode": best_style.get("Light Mode ✓", ""),
"dark_mode": best_style.get("Dark Mode ✓", ""),
},
"colors": {
"primary": best_color.get("Primary", "#2563EB"),
"on_primary": best_color.get("On Primary", ""),
"secondary": best_color.get("Secondary", "#3B82F6"),
"accent": best_color.get("Accent", "#F97316"),
"background": best_color.get("Background", "#F8FAFC"),
"foreground": best_color.get("Foreground", "#1E293B"),
"muted": best_color.get("Muted", ""),
"border": best_color.get("Border", ""),
"destructive": best_color.get("Destructive", ""),
"ring": best_color.get("Ring", ""),
"notes": best_color.get("Notes", ""),
# Keep legacy keys for backward compat in MASTER.md
"cta": best_color.get("Accent", "#F97316"),
"text": best_color.get("Foreground", "#1E293B"),
},
"typography": {
"heading": best_typography.get("Heading Font", "Inter"),
"body": best_typography.get("Body Font", "Inter"),
"mood": best_typography.get("Mood/Style Keywords", reasoning.get("typography_mood", "")),
"best_for": best_typography.get("Best For", ""),
"google_fonts_url": best_typography.get("Google Fonts URL", ""),
"css_import": best_typography.get("CSS Import", "")
},
"key_effects": combined_effects,
"anti_patterns": reasoning.get("anti_patterns", ""),
"decision_rules": reasoning.get("decision_rules", {}),
"severity": reasoning.get("severity", "MEDIUM")
}
# ============ OUTPUT FORMATTERS ============
BOX_WIDTH = 90 # Wider box for more content
def hex_to_ansi(hex_color: str) -> str:
"""Convert hex color to ANSI True Color swatch (██) with fallback."""
if not hex_color or not hex_color.startswith('#'):
return ""
colorterm = os.environ.get('COLORTERM', '')
if colorterm not in ('truecolor', '24bit'):
return ""
hex_color = hex_color.lstrip('#')
if len(hex_color) != 6:
return ""
r, g, b = int(hex_color[0:2], 16), int(hex_color[2:4], 16), int(hex_color[4:6], 16)
return f"\033[38;2;{r};{g};{b}m██\033[0m "
def ansi_ljust(s: str, width: int) -> str:
"""Like str.ljust but accounts for zero-width ANSI escape sequences."""
import re
visible_len = len(re.sub(r'\033\[[0-9;]*m', '', s))
pad = width - visible_len
return s + (" " * max(0, pad))
def section_header(name: str, width: int) -> str:
"""Create a Unicode section separator: ├─── NAME ───...┤"""
label = f"─── {name} "
fill = "─" * (width - len(label) - 1)
return f"├{label}{fill}┤"
def format_ascii_box(design_system: dict) -> str:
"""Format design system as Unicode box with ANSI color swatches."""
project = design_system.get("project_name", "PROJECT")
pattern = design_system.get("pattern", {})
style = design_system.get("style", {})
colors = design_system.get("colors", {})
typography = design_system.get("typography", {})
effects = design_system.get("key_effects", "")
anti_patterns = design_system.get("anti_patterns", "")
def wrap_text(text: str, prefix: str, width: int) -> list:
"""Wrap long text into multiple lines."""
if not text:
return []
words = text.split()
lines = []
current_line = prefix
for word in words:
if len(current_line) + len(word) + 1 <= width - 2:
current_line += (" " if current_line != prefix else "") + word
else:
if current_line != prefix:
lines.append(current_line)
current_line = prefix + word
if current_line != prefix:
lines.append(current_line)
return lines
# Build sections from pattern
sections = pattern.get("sections", "").split(">")
sections = [s.strip() for s in sections if s.strip()]
# Build output lines
lines = []
w = BOX_WIDTH - 1
# Header with double-line box
lines.append("╔" + "═" * w + "╗")
lines.append(ansi_ljust(f"║ TARGET: {project} - RECOMMENDED DESIGN SYSTEM", BOX_WIDTH) + "║")
lines.append("╚" + "═" * w + "╝")
lines.append("┌" + "─" * w + "┐")
# Pattern section
lines.append(section_header("PATTERN", BOX_WIDTH + 1))
lines.append(f"│ Name: {pattern.get('name', '')}".ljust(BOX_WIDTH) + "│")
if pattern.get('conversion'):
lines.append(f"│ Conversion: {pattern.get('conversion', '')}".ljust(BOX_WIDTH) + "│")
if pattern.get('cta_placement'):
lines.append(f"│ CTA: {pattern.get('cta_placement', '')}".ljust(BOX_WIDTH) + "│")
lines.append("│ Sections:".ljust(BOX_WIDTH) + "│")
for i, section in enumerate(sections, 1):
lines.append(f"│ {i}. {section}".ljust(BOX_WIDTH) + "│")
# Style section
lines.append(section_header("STYLE", BOX_WIDTH + 1))
lines.append(f"│ Name: {style.get('name', '')}".ljust(BOX_WIDTH) + "│")
light = style.get("light_mode", "")
dark = style.get("dark_mode", "")
if light or dark:
lines.append(f"│ Mode Support: Light {light} Dark {dark}".ljust(BOX_WIDTH) + "│")
if style.get("keywords"):
for line in wrap_text(f"Keywords: {style.get('keywords', '')}", "│ ", BOX_WIDTH):
lines.append(line.ljust(BOX_WIDTH) + "│")
if style.get("best_for"):
for line in wrap_text(f"Best For: {style.get('best_for', '')}", "│ ", BOX_WIDTH):
lines.append(line.ljust(BOX_WIDTH) + "│")
if style.get("performance") or style.get("accessibility"):
perf_a11y = f"Performance: {style.get('performance', '')} | Accessibility: {style.get('accessibility', '')}"
lines.append(f"│ {perf_a11y}".ljust(BOX_WIDTH) + "│")
# Colors section (extended palette with ANSI swatches)
lines.append(section_header("COLORS", BOX_WIDTH + 1))
color_entries = [
("Primary", "primary", "--color-primary"),
("On Primary", "on_primary", "--color-on-primary"),
("Secondary", "secondary", "--color-secondary"),
("Accent/CTA", "accent", "--color-accent"),
("Background", "background", "--color-background"),
("Foreground", "foreground", "--color-foreground"),
("Muted", "muted", "--color-muted"),
("Border", "border", "--color-border"),
("Destructive", "destructive", "--color-destructive"),
("Ring", "ring", "--color-ring"),
]
for label, key, css_var in color_entries:
hex_val = colors.get(key, "")
if not hex_val:
continue
swatch = hex_to_ansi(hex_val)
content = f"│ {swatch}{label + ':':14s} {hex_val:10s} ({css_var})"
lines.append(ansi_ljust(content, BOX_WIDTH) + "│")
if colors.get("notes"):
for line in wrap_text(f"Notes: {colors.get('notes', '')}", "│ ", BOX_WIDTH):
lines.append(line.ljust(BOX_WIDTH) + "│")
# Typography section
lines.append(section_header("TYPOGRAPHY", BOX_WIDTH + 1))
lines.append(f"│ {typography.get('heading', '')} / {typography.get('body', '')}".ljust(BOX_WIDTH) + "│")
if typography.get("mood"):
for line in wrap_text(f"Mood: {typography.get('mood', '')}", "│ ", BOX_WIDTH):
lines.append(line.ljust(BOX_WIDTH) + "│")
if typography.get("best_for"):
for line in wrap_text(f"Best For: {typography.get('best_for', '')}", "│ ", BOX_WIDTH):
lines.append(line.ljust(BOX_WIDTH) + "│")
if typography.get("google_fonts_url"):
lines.append(f"│ Google Fonts: {typography.get('google_fonts_url', '')}".ljust(BOX_WIDTH) + "│")
if typography.get("css_import"):
lines.append(f"│ CSS Import: {typography.get('css_import', '')[:70]}...".ljust(BOX_WIDTH) + "│")
# Key Effects section
if effects:
lines.append(section_header("KEY EFFECTS", BOX_WIDTH + 1))
for line in wrap_text(effects, "│ ", BOX_WIDTH):
lines.append(line.ljust(BOX_WIDTH) + "│")
# Anti-patterns section
if anti_patterns:
lines.append(section_header("AVOID", BOX_WIDTH + 1))
for line in wrap_text(anti_patterns, "│ ", BOX_WIDTH):
lines.append(line.ljust(BOX_WIDTH) + "│")
# Pre-Delivery Checklist section
lines.append(section_header("PRE-DELIVERY CHECKLIST", BOX_WIDTH + 1))
checklist_items = [
"[ ] No emojis as icons (use SVG: Heroicons/Lucide)",
"[ ] cursor-pointer on all clickable elements",
"[ ] Hover states with smooth transitions (150-300ms)",
"[ ] Light mode: text contrast 4.5:1 minimum",
"[ ] Focus states visible for keyboard nav",
"[ ] prefers-reduced-motion respected",
"[ ] Responsive: 375px, 768px, 1024px, 1440px"
]
for item in checklist_items:
lines.append(f"│ {item}".ljust(BOX_WIDTH) + "│")
lines.append("└" + "─" * w + "┘")
return "\n".join(lines)
def format_markdown(design_system: dict) -> str:
"""Format design system as markdown."""
project = design_system.get("project_name", "PROJECT")
pattern = design_system.get("pattern", {})
style = design_system.get("style", {})
colors = design_system.get("colors", {})
typography = design_system.get("typography", {})
effects = design_system.get("key_effects", "")
anti_patterns = design_system.get("anti_patterns", "")
lines = []
lines.append(f"## Design System: {project}")
lines.append("")
# Pattern section
lines.append("### Pattern")
lines.append(f"- **Name:** {pattern.get('name', '')}")
if pattern.get('conversion'):
lines.append(f"- **Conversion Focus:** {pattern.get('conversion', '')}")
if pattern.get('cta_placement'):
lines.append(f"- **CTA Placement:** {pattern.get('cta_placement', '')}")
if pattern.get('color_strategy'):
lines.append(f"- **Color Strategy:** {pattern.get('color_strategy', '')}")
lines.append(f"- **Sections:** {pattern.get('sections', '')}")
lines.append("")
# Style section
lines.append("### Style")
lines.append(f"- **Name:** {style.get('name', '')}")
light = style.get("light_mode", "")
dark = style.get("dark_mode", "")
if light or dark:
lines.append(f"- **Mode Support:** Light {light} | Dark {dark}")
if style.get('keywords'):
lines.append(f"- **Keywords:** {style.get('keywords', '')}")
if style.get('best_for'):
lines.append(f"- **Best For:** {style.get('best_for', '')}")
if style.get('performance') or style.get('accessibility'):
lines.append(f"- **Performance:** {style.get('performance', '')} | **Accessibility:** {style.get('accessibility', '')}")
lines.append("")
# Colors section (extended palette)
lines.append("### Colors")
lines.append("| Role | Hex | CSS Variable |")
lines.append("|------|-----|--------------|")
md_color_entries = [
("Primary", "primary", "--color-primary"),
("On Primary", "on_primary", "--color-on-primary"),
("Secondary", "secondary", "--color-secondary"),
("Accent/CTA", "accent", "--color-accent"),
("Background", "background", "--color-background"),
("Foreground", "foreground", "--color-foreground"),
("Muted", "muted", "--color-muted"),
("Border", "border", "--color-border"),
("Destructive", "destructive", "--color-destructive"),
("Ring", "ring", "--color-ring"),
]
for label, key, css_var in md_color_entries:
hex_val = colors.get(key, "")
if hex_val:
lines.append(f"| {label} | `{hex_val}` | `{css_var}` |")
if colors.get("notes"):
lines.append(f"\n*Notes: {colors.get('notes', '')}*")
lines.append("")
# Typography section
lines.append("### Typography")
lines.append(f"- **Heading:** {typography.get('heading', '')}")
lines.append(f"- **Body:** {typography.get('body', '')}")
if typography.get("mood"):
lines.append(f"- **Mood:** {typography.get('mood', '')}")
if typography.get("best_for"):
lines.append(f"- **Best For:** {typography.get('best_for', '')}")
if typography.get("google_fonts_url"):
lines.append(f"- **Google Fonts:** {typography.get('google_fonts_url', '')}")
if typography.get("css_import"):
lines.append(f"- **CSS Import:**")
lines.append(f"```css")
lines.append(f"{typography.get('css_import', '')}")
lines.append(f"```")
lines.append("")
# Key Effects section
if effects:
lines.append("### Key Effects")
lines.append(f"{effects}")
lines.append("")
# Anti-patterns section
if anti_patterns:
lines.append("### Avoid (Anti-patterns)")
newline_bullet = '\n- '
lines.append(f"- {anti_patterns.replace(' + ', newline_bullet)}")
lines.append("")
# Pre-Delivery Checklist section
lines.append("### Pre-Delivery Checklist")
lines.append("- [ ] No emojis as icons (use SVG: Heroicons/Lucide)")
lines.append("- [ ] cursor-pointer on all clickable elements")
lines.append("- [ ] Hover states with smooth transitions (150-300ms)")
lines.append("- [ ] Light mode: text contrast 4.5:1 minimum")
lines.append("- [ ] Focus states visible for keyboard nav")
lines.append("- [ ] prefers-reduced-motion respected")
lines.append("- [ ] Responsive: 375px, 768px, 1024px, 1440px")
lines.append("")
return "\n".join(lines)
# ============ MAIN ENTRY POINT ============
def generate_design_system(query: str, project_name: str = None, output_format: str = "ascii",
persist: bool = False, page: str = None, output_dir: str = None) -> str:
"""
Main entry point for design system generation.
Args:
query: Search query (e.g., "SaaS dashboard", "e-commerce luxury")
project_name: Optional project name for output header
output_format: "ascii" (default) or "markdown"
persist: If True, save design system to design-system/ folder
page: Optional page name for page-specific override file
output_dir: Optional output directory (defaults to current working directory)
Returns:
Formatted design system string
"""
generator = DesignSystemGenerator()
design_system = generator.generate(query, project_name)
# Persist to files if requested
if persist:
persist_design_system(design_system, page, output_dir, query)
if output_format == "markdown":
return format_markdown(design_system)
return format_ascii_box(design_system)
# ============ PERSISTENCE FUNCTIONS ============
def persist_design_system(design_system: dict, page: str = None, output_dir: str = None, page_query: str = None) -> dict:
"""
Persist design system to design-system/<project>/ folder using Master + Overrides pattern.
Args:
design_system: The generated design system dictionary
page: Optional page name for page-specific override file
output_dir: Optional output directory (defaults to current working directory)
page_query: Optional query string for intelligent page override generation
Returns:
dict with created file paths and status
"""
base_dir = Path(output_dir) if output_dir else Path.cwd()
# Use project name for project-specific folder
project_name = design_system.get("project_name", "default")
project_slug = project_name.lower().replace(' ', '-')
design_system_dir = base_dir / "design-system" / project_slug
pages_dir = design_system_dir / "pages"
created_files = []
# Create directories
design_system_dir.mkdir(parents=True, exist_ok=True)
pages_dir.mkdir(parents=True, exist_ok=True)
master_file = design_system_dir / "MASTER.md"
# Generate and write MASTER.md
master_content = format_master_md(design_system)
with open(master_file, 'w', encoding='utf-8') as f:
f.write(master_content)
created_files.append(str(master_file))
# If page is specified, create page override file with intelligent content
if page:
page_file = pages_dir / f"{page.lower().replace(' ', '-')}.md"
page_content = format_page_override_md(design_system, page, page_query)
with open(page_file, 'w', encoding='utf-8') as f:
f.write(page_content)
created_files.append(str(page_file))
return {
"status": "success",
"design_system_dir": str(design_system_dir),
"created_files": created_files
}
def format_master_md(design_system: dict) -> str:
"""Format design system as MASTER.md with hierarchical override logic."""
project = design_system.get("project_name", "PROJECT")
pattern = design_system.get("pattern", {})
style = design_system.get("style", {})
colors = design_system.get("colors", {})
typography = design_system.get("typography", {})
effects = design_system.get("key_effects", "")
anti_patterns = design_system.get("anti_patterns", "")
timestamp = datetime.now().strftime("%Y-%m-%d %H:%M:%S")
lines = []
# Logic header
lines.append("# Design System Master File")
lines.append("")
lines.append("> **LOGIC:** When building a specific page, first check `design-system/pages/[page-name].md`.")
lines.append("> If that file exists, its rules **override** this Master file.")
lines.append("> If not, strictly follow the rules below.")
lines.append("")
lines.append("---")
lines.append("")
lines.append(f"**Project:** {project}")
lines.append(f"**Generated:** {timestamp}")
lines.append(f"**Category:** {design_system.get('category', 'General')}")
lines.append("")
lines.append("---")
lines.append("")
# Global Rules section
lines.append("## Global Rules")
lines.append("")
# Color Palette
lines.append("### Color Palette")
lines.append("")
lines.append("| Role | Hex | CSS Variable |")
lines.append("|------|-----|--------------|")
master_color_entries = [
("Primary", "primary", "--color-primary"),
("On Primary", "on_primary", "--color-on-primary"),
("Secondary", "secondary", "--color-secondary"),
("Accent/CTA", "accent", "--color-accent"),
("Background", "background", "--color-background"),
("Foreground", "foreground", "--color-foreground"),
("Muted", "muted", "--color-muted"),
("Border", "border", "--color-border"),
("Destructive", "destructive", "--color-destructive"),
("Ring", "ring", "--color-ring"),
]
for label, key, css_var in master_color_entries:
hex_val = colors.get(key, "")
if hex_val:
lines.append(f"| {label} | `{hex_val}` | `{css_var}` |")
lines.append("")
if colors.get("notes"):
lines.append(f"**Color Notes:** {colors.get('notes', '')}")
lines.append("")
# Typography
lines.append("### Typography")
lines.append("")
lines.append(f"- **Heading Font:** {typography.get('heading', 'Inter')}")
lines.append(f"- **Body Font:** {typography.get('body', 'Inter')}")
if typography.get("mood"):
lines.append(f"- **Mood:** {typography.get('mood', '')}")
if typography.get("google_fonts_url"):
lines.append(f"- **Google Fonts:** [{typography.get('heading', '')} + {typography.get('body', '')}]({typography.get('google_fonts_url', '')})")
lines.append("")
if typography.get("css_import"):
lines.append("**CSS Import:**")
lines.append("```css")
lines.append(typography.get("css_import", ""))
lines.append("```")
lines.append("")
# Spacing Variables
lines.append("### Spacing Variables")
lines.append("")
lines.append("| Token | Value | Usage |")
lines.append("|-------|-------|-------|")
lines.append("| `--space-xs` | `4px` / `0.25rem` | Tight gaps |")
lines.append("| `--space-sm` | `8px` / `0.5rem` | Icon gaps, inline spacing |")
lines.append("| `--space-md` | `16px` / `1rem` | Standard padding |")
lines.append("| `--space-lg` | `24px` / `1.5rem` | Section padding |")
lines.append("| `--space-xl` | `32px` / `2rem` | Large gaps |")
lines.append("| `--space-2xl` | `48px` / `3rem` | Section margins |")
lines.append("| `--space-3xl` | `64px` / `4rem` | Hero padding |")
lines.append("")
# Shadow Depths
lines.append("### Shadow Depths")
lines.append("")
lines.append("| Level | Value | Usage |")
lines.append("|-------|-------|-------|")
lines.append("| `--shadow-sm` | `0 1px 2px rgba(0,0,0,0.05)` | Subtle lift |")
lines.append("| `--shadow-md` | `0 4px 6px rgba(0,0,0,0.1)` | Cards, buttons |")
lines.append("| `--shadow-lg` | `0 10px 15px rgba(0,0,0,0.1)` | Modals, dropdowns |")
lines.append("| `--shadow-xl` | `0 20px 25px rgba(0,0,0,0.15)` | Hero images, featured cards |")
lines.append("")
# Component Specs section
lines.append("---")
lines.append("")
lines.append("## Component Specs")
lines.append("")
# Buttons
lines.append("### Buttons")
lines.append("")
lines.append("```css")
lines.append("/* Primary Button */")
lines.append(".btn-primary {")
lines.append(f" background: {colors.get('cta', '#F97316')};")
lines.append(" color: white;")
lines.append(" padding: 12px 24px;")
lines.append(" border-radius: 8px;")
lines.append(" font-weight: 600;")
lines.append(" transition: all 200ms ease;")
lines.append(" cursor: pointer;")
lines.append("}")
lines.append("")
lines.append(".btn-primary:hover {")
lines.append(" opacity: 0.9;")
lines.append(" transform: translateY(-1px);")
lines.append("}")
lines.append("")
lines.append("/* Secondary Button */")
lines.append(".btn-secondary {")
lines.append(f" background: transparent;")
lines.append(f" color: {colors.get('primary', '#2563EB')};")
lines.append(f" border: 2px solid {colors.get('primary', '#2563EB')};")
lines.append(" padding: 12px 24px;")
lines.append(" border-radius: 8px;")
lines.append(" font-weight: 600;")
lines.append(" transition: all 200ms ease;")
lines.append(" cursor: pointer;")
lines.append("}")
lines.append("```")
lines.append("")
# Cards
lines.append("### Cards")
lines.append("")
lines.append("```css")
lines.append(".card {")
lines.append(f" background: {colors.get('background', '#FFFFFF')};")
lines.append(" border-radius: 12px;")
lines.append(" padding: 24px;")
lines.append(" box-shadow: var(--shadow-md);")
lines.append(" transition: all 200ms ease;")
lines.append(" cursor: pointer;")
lines.append("}")
lines.append("")
lines.append(".card:hover {")
lines.append(" box-shadow: var(--shadow-lg);")
lines.append(" transform: translateY(-2px);")
lines.append("}")
lines.append("```")
lines.append("")
# Inputs
lines.append("### Inputs")
lines.append("")
lines.append("```css")
lines.append(".input {")
lines.append(" padding: 12px 16px;")
lines.append(" border: 1px solid #E2E8F0;")
lines.append(" border-radius: 8px;")
lines.append(" font-size: 16px;")
lines.append(" transition: border-color 200ms ease;")
lines.append("}")
lines.append("")
lines.append(".input:focus {")
lines.append(f" border-color: {colors.get('primary', '#2563EB')};")
lines.append(" outline: none;")
lines.append(f" box-shadow: 0 0 0 3px {colors.get('primary', '#2563EB')}20;")
lines.append("}")
lines.append("```")
lines.append("")
# Modals
lines.append("### Modals")
lines.append("")
lines.append("```css")
lines.append(".modal-overlay {")
lines.append(" background: rgba(0, 0, 0, 0.5);")
lines.append(" backdrop-filter: blur(4px);")
lines.append("}")
lines.append("")
lines.append(".modal {")
lines.append(" background: white;")
lines.append(" border-radius: 16px;")
lines.append(" padding: 32px;")
lines.append(" box-shadow: var(--shadow-xl);")
lines.append(" max-width: 500px;")
lines.append(" width: 90%;")
lines.append("}")
lines.append("```")
lines.append("")
# Style section
lines.append("---")
lines.append("")
lines.append("## Style Guidelines")
lines.append("")
lines.append(f"**Style:** {style.get('name', 'Minimalism')}")
lines.append("")
if style.get("keywords"):
lines.append(f"**Keywords:** {style.get('keywords', '')}")
lines.append("")
if style.get("best_for"):
lines.append(f"**Best For:** {style.get('best_for', '')}")
lines.append("")
if effects:
lines.append(f"**Key Effects:** {effects}")
lines.append("")
# Layout Pattern
lines.append("### Page Pattern")
lines.append("")
lines.append(f"**Pattern Name:** {pattern.get('name', '')}")
lines.append("")
if pattern.get('conversion'):
lines.append(f"- **Conversion Strategy:** {pattern.get('conversion', '')}")
if pattern.get('cta_placement'):
lines.append(f"- **CTA Placement:** {pattern.get('cta_placement', '')}")
lines.append(f"- **Section Order:** {pattern.get('sections', '')}")
lines.append("")
# Anti-Patterns section
lines.append("---")
lines.append("")
lines.append("## Anti-Patterns (Do NOT Use)")
lines.append("")
if anti_patterns:
anti_list = [a.strip() for a in anti_patterns.split("+")]
for anti in anti_list:
if anti:
lines.append(f"- ❌ {anti}")
lines.append("")
lines.append("### Additional Forbidden Patterns")
lines.append("")
lines.append("- ❌ **Emojis as icons** — Use SVG icons (Heroicons, Lucide, Simple Icons)")
lines.append("- ❌ **Missing cursor:pointer** — All clickable elements must have cursor:pointer")
lines.append("- ❌ **Layout-shifting hovers** — Avoid scale transforms that shift layout")
lines.append("- ❌ **Low contrast text** — Maintain 4.5:1 minimum contrast ratio")
lines.append("- ❌ **Instant state changes** — Always use transitions (150-300ms)")
lines.append("- ❌ **Invisible focus states** — Focus states must be visible for a11y")
lines.append("")
# Pre-Delivery Checklist
lines.append("---")
lines.append("")
lines.append("## Pre-Delivery Checklist")
lines.append("")
lines.append("Before delivering any UI code, verify:")
lines.append("")
lines.append("- [ ] No emojis used as icons (use SVG instead)")
lines.append("- [ ] All icons from consistent icon set (Heroicons/Lucide)")
lines.append("- [ ] `cursor-pointer` on all clickable elements")
lines.append("- [ ] Hover states with smooth transitions (150-300ms)")
lines.append("- [ ] Light mode: text contrast 4.5:1 minimum")
lines.append("- [ ] Focus states visible for keyboard navigation")
lines.append("- [ ] `prefers-reduced-motion` respected")
lines.append("- [ ] Responsive: 375px, 768px, 1024px, 1440px")
lines.append("- [ ] No content hidden behind fixed navbars")
lines.append("- [ ] No horizontal scroll on mobile")
lines.append("")
return "\n".join(lines)
def format_page_override_md(design_system: dict, page_name: str, page_query: str = None) -> str:
"""Format a page-specific override file with intelligent AI-generated content."""
project = design_system.get("project_name", "PROJECT")
timestamp = datetime.now().strftime("%Y-%m-%d %H:%M:%S")
page_title = page_name.replace("-", " ").replace("_", " ").title()
# Detect page type and generate intelligent overrides
page_overrides = _generate_intelligent_overrides(page_name, page_query, design_system)
lines = []
lines.append(f"# {page_title} Page Overrides")
lines.append("")
lines.append(f"> **PROJECT:** {project}")
lines.append(f"> **Generated:** {timestamp}")
lines.append(f"> **Page Type:** {page_overrides.get('page_type', 'General')}")
lines.append("")
lines.append("> ⚠️ **IMPORTANT:** Rules in this file **override** the Master file (`design-system/MASTER.md`).")
lines.append("> Only deviations from the Master are documented here. For all other rules, refer to the Master.")
lines.append("")
lines.append("---")
lines.append("")
# Page-specific rules with actual content
lines.append("## Page-Specific Rules")
lines.append("")
# Layout Overrides
lines.append("### Layout Overrides")
lines.append("")
layout = page_overrides.get("layout", {})
if layout:
for key, value in layout.items():
lines.append(f"- **{key}:** {value}")
else:
lines.append("- No overrides — use Master layout")
lines.append("")
# Spacing Overrides
lines.append("### Spacing Overrides")
lines.append("")
spacing = page_overrides.get("spacing", {})
if spacing:
for key, value in spacing.items():
lines.append(f"- **{key}:** {value}")
else:
lines.append("- No overrides — use Master spacing")
lines.append("")
# Typography Overrides
lines.append("### Typography Overrides")
lines.append("")
typography = page_overrides.get("typography", {})
if typography:
for key, value in typography.items():
lines.append(f"- **{key}:** {value}")
else:
lines.append("- No overrides — use Master typography")
lines.append("")
# Color Overrides
lines.append("### Color Overrides")
lines.append("")
colors = page_overrides.get("colors", {})
if colors:
for key, value in colors.items():
lines.append(f"- **{key}:** {value}")
else:
lines.append("- No overrides — use Master colors")
lines.append("")
# Component Overrides
lines.append("### Component Overrides")
lines.append("")
components = page_overrides.get("components", [])
if components:
for comp in components:
lines.append(f"- {comp}")
else:
lines.append("- No overrides — use Master component specs")
lines.append("")
# Page-Specific Components
lines.append("---")
lines.append("")
lines.append("## Page-Specific Components")
lines.append("")
unique_components = page_overrides.get("unique_components", [])
if unique_components:
for comp in unique_components:
lines.append(f"- {comp}")
else:
lines.append("- No unique components for this page")
lines.append("")
# Recommendations
lines.append("---")
lines.append("")
lines.append("## Recommendations")
lines.append("")
recommendations = page_overrides.get("recommendations", [])
if recommendations:
for rec in recommendations:
lines.append(f"- {rec}")
lines.append("")
return "\n".join(lines)
def _generate_intelligent_overrides(page_name: str, page_query: str, design_system: dict) -> dict:
"""
Generate intelligent overrides based on page type using layered search.
Uses the existing search infrastructure to find relevant style, UX, and layout
data instead of hardcoded page types.
"""
from core import search
page_lower = page_name.lower()
query_lower = (page_query or "").lower()
combined_context = f"{page_lower} {query_lower}"
# Search across multiple domains for page-specific guidance
style_search = search(combined_context, "style", max_results=1)
ux_search = search(combined_context, "ux", max_results=3)
landing_search = search(combined_context, "landing", max_results=1)
# Extract results from search response
style_results = style_search.get("results", [])
ux_results = ux_search.get("results", [])
landing_results = landing_search.get("results", [])
# Detect page type from search results or context
page_type = _detect_page_type(combined_context, style_results)
# Build overrides from search results
layout = {}
spacing = {}
typography = {}
colors = {}
components = []
unique_components = []
recommendations = []
# Extract style-based overrides
if style_results:
style = style_results[0]
style_name = style.get("Style Category", "")
keywords = style.get("Keywords", "")
best_for = style.get("Best For", "")
effects = style.get("Effects & Animation", "")
# Infer layout from style keywords
if any(kw in keywords.lower() for kw in ["data", "dense", "dashboard", "grid"]):
layout["Max Width"] = "1400px or full-width"
layout["Grid"] = "12-column grid for data flexibility"
spacing["Content Density"] = "High — optimize for information display"
elif any(kw in keywords.lower() for kw in ["minimal", "simple", "clean", "single"]):
layout["Max Width"] = "800px (narrow, focused)"
layout["Layout"] = "Single column, centered"
spacing["Content Density"] = "Low — focus on clarity"
else:
layout["Max Width"] = "1200px (standard)"
layout["Layout"] = "Full-width sections, centered content"
if effects:
recommendations.append(f"Effects: {effects}")
# Extract UX guidelines as recommendations
for ux in ux_results:
category = ux.get("Category", "")
do_text = ux.get("Do", "")
dont_text = ux.get("Don't", "")
if do_text:
recommendations.append(f"{category}: {do_text}")
if dont_text:
components.append(f"Avoid: {dont_text}")
# Extract landing pattern info for section structure
if landing_results:
landing = landing_results[0]
sections = landing.get("Section Order", "")
cta_placement = landing.get("Primary CTA Placement", "")
color_strategy = landing.get("Color Strategy", "")
if sections:
layout["Sections"] = sections
if cta_placement:
recommendations.append(f"CTA Placement: {cta_placement}")
if color_strategy:
colors["Strategy"] = color_strategy
# Add page-type specific defaults if no search results
if not layout:
layout["Max Width"] = "1200px"
layout["Layout"] = "Responsive grid"
if not recommendations:
recommendations = [
"Refer to MASTER.md for all design rules",
"Add specific overrides as needed for this page"
]
return {
"page_type": page_type,
"layout": layout,
"spacing": spacing,
"typography": typography,
"colors": colors,
"components": components,
"unique_components": unique_components,
"recommendations": recommendations
}
def _detect_page_type(context: str, style_results: list) -> str:
"""Detect page type from context and search results."""
context_lower = context.lower()
# Check for common page type patterns
page_patterns = [
(["dashboard", "admin", "analytics", "data", "metrics", "stats", "monitor", "overview"], "Dashboard / Data View"),
(["checkout", "payment", "cart", "purchase", "order", "billing"], "Checkout / Payment"),
(["settings", "profile", "account", "preferences", "config"], "Settings / Profile"),
(["landing", "marketing", "homepage", "hero", "home", "promo"], "Landing / Marketing"),
(["login", "signin", "signup", "register", "auth", "password"], "Authentication"),
(["pricing", "plans", "subscription", "tiers", "packages"], "Pricing / Plans"),
(["blog", "article", "post", "news", "content", "story"], "Blog / Article"),
(["product", "item", "detail", "pdp", "shop", "store"], "Product Detail"),
(["search", "results", "browse", "filter", "catalog", "list"], "Search Results"),
(["empty", "404", "error", "not found", "zero"], "Empty State"),
]
for keywords, page_type in page_patterns:
if any(kw in context_lower for kw in keywords):
return page_type
# Fallback: try to infer from style results
if style_results:
style_name = style_results[0].get("Style Category", "").lower()
best_for = style_results[0].get("Best For", "").lower()
if "dashboard" in best_for or "data" in best_for:
return "Dashboard / Data View"
elif "landing" in best_for or "marketing" in best_for:
return "Landing / Marketing"
return "General"
# ============ CLI SUPPORT ============
if __name__ == "__main__":
import argparse
parser = argparse.ArgumentParser(description="Generate Design System")
parser.add_argument("query", help="Search query (e.g., 'SaaS dashboard')")
parser.add_argument("--project-name", "-p", type=str, default=None, help="Project name")
parser.add_argument("--format", "-f", choices=["ascii", "markdown"], default="ascii", help="Output format")
args = parser.parse_args()
result = generate_design_system(args.query, args.project_name, args.format)
print(result)