Skip to content

Aboudjem/ui-ux-suite

UI/UX Suite

npm License Node Stars

Your project's design quality — measured, not guessed.

Install · What it scores · Commands · Demo videos

UI/UX Suite scorecard

The 30-second pitch

Design reviews are vibes. This turns them into data.

ui-ux-suite scans your CSS, JSX, and Tailwind config and scores 12 design dimensions — color system, typography, layout, components, accessibility, hierarchy, interactions, responsiveness, and more. Every finding cites an authority (WCAG, APCA, Hick's Law, Miller's Law, Fitts's Law). Every fix comes with code.

npx ui-ux-suite

No dependencies. No config. No API keys. 100% local.

Why developers love it

  • ESLint for design. One command produces a quantified 1–10 score per dimension and a weighted overall grade you can track over time.
  • Cites real UX laws, not opinions. WCAG 2.2, APCA contrast, OKLCH color science, deltaE near-duplicate detection — not "this feels off."
  • Runs anywhere. Works with React, Vue, Svelte, Angular, vanilla. Detects Tailwind, shadcn, Radix, Framer Motion automatically.
  • Talks to your AI editor. Ships as an MCP server. Just ask "audit my design" in Claude / Cursor / Copilot.
  • Gives you the code. /uiux-fix generates the before/after patch for the top finding. uiux_generate_palette does an OKLCH-based recolor of your tokens.
  • Zero dependencies. The project is vanilla JS, by design. Ships under 200KB.

Install

From your AI editor (MCP)
# Claude Code
claude mcp add ui-ux-suite npx ui-ux-suite --mcp

# Codex CLI
codex mcp add ui-ux-suite -- npx -y ui-ux-suite --mcp

Cursor - ~/.cursor/mcp.json:

{ "mcpServers": { "ui-ux-suite": { "command": "npx", "args": ["ui-ux-suite", "--mcp"] } } }

VS Code + Copilot - .vscode/mcp.json:

{ "servers": { "ui-ux-suite": { "command": "npx", "args": ["-y", "ui-ux-suite", "--mcp"] } } }

Windsurf - ~/.codeium/windsurf/mcp_config.json:

{ "mcpServers": { "ui-ux-suite": { "command": "npx", "args": ["ui-ux-suite", "--mcp"] } } }

Gemini CLI - ~/.gemini/mcp_config.json:

{ "mcpServers": { "ui-ux-suite": { "command": "npx", "args": ["ui-ux-suite", "--mcp"] } } }

Continue.dev - .continue/mcpServers/ui-ux-suite.yaml:

mcpServers:
  ui-ux-suite: { command: npx, args: [ui-ux-suite, --mcp], type: stdio }

Then ask your AI: "Audit this project's design."

Claude Code plugin marketplace (recommended)
# In Claude Code
/plugin marketplace add Aboudjem/10x
/plugin install ui-ux-suite@10x

# Or from the terminal
claude plugin install ui-ux-suite@10x

Installs from the 10x marketplace. Adds 19 slash commands (5 top-level /ui-ux-suite:* + 14 specialist skills), 12 specialist agents, 19 knowledge docs, and the MCP server in one command.

Claude Code plugin (direct)
# In Claude Code
/plugin marketplace add Aboudjem/ui-ux-suite
/plugin install ui-ux-suite@ui-ux-suite

# Or from the terminal
claude plugin install ui-ux-suite@ui-ux-suite

This repo ships its own .claude-plugin/marketplace.json, so it registers as a single-plugin marketplace. Installs directly without the 10x indirection.

As a dev dependency
npm install -D ui-ux-suite

Add to package.json:

{ "scripts": { "design-audit": "ui-ux-suite" } }

Requires Node 18+.


What it scores

UI/UX Suite scorecard

12 weighted dimensions. Accessibility gets the highest weight because it affects the most users.

Dimension Weight Checks
Accessibility 12% Focus, skip links, alt text, reduced motion, ARIA
Color System 10% WCAG + APCA contrast, duplicates, semantic roles, dark mode
Typography 10% Scale consistency, font count, body size, line height
Layout & Spacing 10% Grid, breakpoints, container widths
Component Quality 10% States: hover, focus, disabled, loading, error
Visual Hierarchy 10% Type scale, information priority, scannability
Interaction 8% Animation timing, easing, feedback
Responsiveness 8% Breakpoints, container queries
Visual Polish 7% Shadow quality, gradient animation, radius tokens
Performance UX 5% Loading states, perceived speed
Info Architecture 5% Command palette, validation, navigation
Platform Fit 5% Dark mode, component lib, a11y primitives

Findings are concrete, not vague:

"Button text contrast is 2.8:1, needs 4.5:1 for WCAG AA. Change #94a3b8 to #64748b on your white background."


Grounded in 24 UX laws

Every finding cites the law it violates. Reports end with a Laws of UX coverage table counting violations per law.

Examples: Hick's Law (choice cost), Fitts's Law (target size), Miller's Law (7±2), Jakob's Law (conventions), Doherty Threshold (400ms), Peak-End Rule, Gestalt (Proximity, Similarity, Common Region, Prägnanz, Uniform Connectedness), Aesthetic-Usability Effect, Choice Overload, Cognitive Load, Tesler's Law, Postel's Law, Occam's Razor, Pareto, Parkinson, Serial Position, Von Restorff, Zeigarnik, Goal-Gradient.

Full 24-law coverage table
Law Definition Cited by Dimensions
Hick's Law Decision time grows logarithmically with choices. psychology, ux-flow, design flows, hierarchy
Fitts's Law Time to target depends on distance and size. interaction, a11y, design a11y, interaction
Miller's Law Working memory holds 7 ± 2 items. psychology, ux-flow, design flows, hierarchy, typography
Jakob's Law Users expect your site to work like others. ux-flow, a11y, design flows, platform, responsive
Doherty Threshold Productivity surges below 400ms response. interaction, design interaction, performance
Peak-End Rule Experience judged by peak + end moments. psychology, interaction, ux-flow, design interaction, performance, polish
Goal-Gradient Effect Motivation rises near the finish line. psychology, interaction, design interaction
Aesthetic-Usability Effect Pretty feels more usable. psychology, design color, polish, typography
Serial Position Effect First and last items remembered best. psychology, ux-flow, design flows, hierarchy
Von Restorff Effect Standouts get remembered. psychology, design hierarchy, color
Zeigarnik Effect Incomplete tasks hold memory. psychology, interaction, design interaction, flows
Pareto Principle 80% of outcomes from 20% of causes. ux-flow, design flows
Parkinson's Law Work expands to fill the time given. ux-flow, design flows
Postel's Law Conservative output, liberal input. a11y, design a11y, components
Tesler's Law Complexity is conserved, not removed. ux-flow, design components, flows
Occam's Razor Prefer the simpler solution. ux-flow, design flows, platform
Law of Proximity Close elements feel grouped. layout, design layout
Law of Common Region Shared region implies grouping. layout, design layout
Law of Prägnanz Eye prefers simplicity. layout, design layout, typography
Law of Similarity Similar looks mean related. layout, design layout, color
Law of Uniform Connectedness Visual connection implies group. layout, design layout
Chunking Group items to expand recall. psychology, ux-flow, design flows, typography
Choice Overload Too many options paralyzes. psychology, ux-flow, design flows
Cognitive Load Working memory is a finite budget. psychology, design flows, hierarchy

Sources in References at the end.


Works with any stack

React Next.js Vue Svelte Angular Vanilla

Styling: Tailwind · CSS Modules · SCSS · styled-components · Emotion · vanilla-extract · plain CSS. Libraries: shadcn/ui · MUI · Chakra · Radix · Mantine · Headless UI · Ark UI.

Auto-detects your framework. No config.


Commands

ui-ux-suite              Audit current directory
ui-ux-suite <path>       Audit a specific project
ui-ux-suite --json       JSON output for scripts
ui-ux-suite --mcp        Start as MCP server

One-command audit via slash command (v0.3, recommended):

/ui-ux-suite:audit                 Full 12-dimension audit, one report
/ui-ux-suite:colors                Color-only audit
/ui-ux-suite:a11y [--deep]         Accessibility-only audit (Playwright + axe-core in deep mode)
/ui-ux-suite:typography            Typography and hierarchy audit
/ui-ux-suite:components            Component-quality audit

These dispatch to the single uiux_audit_run MCP tool, which chains scan -> extract -> score -> report in one call. No manual tool chaining.

14 detailed slash commands (Claude Code plugin)
Command What it does
/design-audit Full 12-dimension audit with score card
/color-audit Color system deep dive
/type-audit Typography analysis
/layout-audit Spacing and grid check
/a11y-audit Accessibility review
/component-audit State coverage check
/flow-audit Navigation and IA review
/design-score Quick overall score
/design-tokens Generate token set from brand color
/theme-builder Theme from brand color
/style-direction Style recommendation
/refactor-plan Prioritized action plan
/design-compare Before/after comparison
/design-checklist Pre-launch checklist
15 MCP tools
Tool What it does
uiux_audit_run One-call full audit. v0.3. Scan + extract + score all 12 dimensions + format report. Supports depth: "quick"|"deep" and dimensions scoping.
uiux_scan_project Detect framework, styling (Tailwind v3 vs v4), component lib, animation lib, icon lib, theme system. Returns structured diagnostics, no silent nulls.
uiux_extract_colors Pull all colors from CSS, Tailwind, tokens
uiux_extract_typography Extract fonts, sizes, weights, line heights
uiux_extract_spacing Extract padding, margin, gap values
uiux_check_contrast WCAG 2.1 + APCA contrast
uiux_score_dimension Score any of 12 dimensions (v0.3: was 4)
uiux_score_overall Weighted overall score
uiux_generate_palette Generate palette from brand color
uiux_generate_type_scale Generate type scale
uiux_generate_spacing_scale Generate spacing scale
uiux_generate_tokens Generate complete token set
uiux_knowledge_query Query 19 knowledge documents
uiux_laws_query Query 24 Laws of UX
uiux_audit_log Append finding to audit log
uiux_audit_report Generate formatted audit report
Deep mode (optional Playwright + axe-core)

Quick mode is static analysis only (zero dependencies). For live accessibility and touch-target scanning, install the optional peer dependencies:

npm i -D playwright-core @axe-core/playwright
npx playwright install chromium

Then:

/ui-ux-suite:a11y --deep

Deep mode injects axe-core into the running app at baseUrl, measures live contrast on rendered elements, flags touch targets smaller than 44x44px, and screenshots routes. Runs only when you ask for it — the default install stays zero-dep.


How it works

graph LR
    A["Your Project<br/><sub>CSS, JSX, Tailwind</sub>"] --> B["Extractors"]
    B --> C["Engines<br/><sub>Color · Type · Spacing · OKLCH</sub>"]
    C --> D["Scoring<br/><sub>12 weighted dimensions</sub>"]
    D --> E["Report<br/><sub>Score + fixes + citations</sub>"]

    style A fill:#f8fafc,stroke:#0ea5e9,color:#0c4a6e
    style B fill:#f0f9ff,stroke:#0ea5e9,color:#0c4a6e
    style C fill:#e0f2fe,stroke:#0ea5e9,color:#0c4a6e
    style D fill:#bae6fd,stroke:#0ea5e9,color:#0c4a6e
    style E fill:#0ea5e9,stroke:#0284c7,color:#ffffff
Loading
Architecture
lib/
  mcp-server.js       MCP JSON-RPC server (15 tools)
  runner.js           Full 12-dimension audit orchestrator
  browser.js          Optional Playwright + axe-core deep mode
  color-engine.js     WCAG, APCA, deltaE, palette
  type-engine.js      Scale math, readability
  spacing-engine.js   Grid detection, consistency
  oklch-parser.js     OKLCH color space
  theme-parser.js     Tailwind v4 @theme / @theme inline parser
  tailwind-parser.js  Class extraction + breakpoint bucketing
  extractors.js       CSS, Tailwind, SCSS, stack detection
  scoring.js          12 weighted dimension scorers
  schema.js           Data structures
  knowledge.js        Built-in knowledge base

commands/    5 top-level slash commands (/ui-ux-suite:audit, ...)
knowledge/   19 markdown docs (3,081 lines)
agents/      12 specialist agents
skills/      14 specialist slash commands
templates/   5 report templates
Knowledge base (19 docs, 3,081 lines)
Document Lines Covers
accessibility-guide.md 213 WCAG, ARIA, focus management
color-theory.md 142 Harmony, semantics, dark mode
typography-theory.md 131 Scale ratios, 2026 font picks
component-patterns.md 139 State checklist, button hierarchy
ux-flows.md 155 Navigation, onboarding, IA
design-engineer-craft-2026.md 355 Tips from Vercel, Linear, shadcn
insider-secrets-2026.md 233 35 tips from veterans
wow-animations-2026.md 214 Scroll driven, view transitions
wow-libraries-2026.md 178 15 component libraries
design-tools-2026.md 253 Design tooling landscape
evidence-base.md 78 30+ quantified findings
dark-patterns.md 154 Deceptive design detection
advanced-polish.md 164 Shadow techniques, micro-interactions
platform-conventions.md 129 iOS, Android, web patterns
anti-patterns.md 90 Common mistakes
libraries-tools.md 133 Component library comparison
principles.md 90 Core design principles
psychology.md 119 Cognitive load, Gestalt
trends-2026.md 111 CSS features, AI patterns
laws-of-ux.md 320 24 named UX laws

Evidence

Every recommendation traces to research.

Finding Number Source
Time users take to judge your design 50ms Academic research
Users who leave after a bad impression 88% UX survey
ADA lawsuits filed in H1 2025 5,114 WebAIM, UsableNet
A11y issues automated tools catch 30-40% Deque, W3C
Smartphone users with dark mode on 81.9% Mobile analytics

Full evidence base with HIGH/MEDIUM/LOW confidence ratings lives in knowledge/evidence-base.md.

2026 CSS features detected
Feature Detection
View Transitions API @view-transition, ::view-transition
Scroll-driven animations animation-timeline: view|scroll
Container queries @container
@property animations @property --*
@starting-style @starting-style { }
OKLCH colors oklch() notation

Privacy

All analysis runs locally. Your code never leaves your machine. No telemetry. No API calls. No network.


Contributing

Contributions are welcome. This project is maintained in public and every PR is reviewed.

Setup

git clone https://github.com/Aboudjem/ui-ux-suite
cd ui-ux-suite
npm test   # 234 tests, zero dependencies

What makes a good PR

  • Bug fixes always welcome. Include a test that would have caught the bug.
  • New scoring rules should cite a named UX law or a primary-source study in the finding. See knowledge/laws-of-ux.md for the 24-law vocabulary.
  • New MCP tools must follow the registration pattern in lib/mcp-server.js. Add a test in test/ that exercises the handler without starting the server.
  • Knowledge docs should be evidence-backed. Add new citations to knowledge/evidence-base.md with HIGH/MEDIUM/LOW confidence ratings.
  • No new runtime dependencies. The suite is zero-dep by design; dev dependencies are fine.
  • No em-dashes in user-facing copy (reports, README, knowledge files).

Good first issues

Look for the good first issue label. Typical starting points: add a new knowledge doc, extend a scorer with a new finding, add a new generator preset.

Process

  1. Fork and branch from main.
  2. Add or update tests under test/.
  3. Run npm test locally (CI also runs on Node 18 + 22).
  4. Open a PR describing the problem, the approach, and any trade-offs.
  5. Reviewer feedback usually within 48 hours.

See CONTRIBUTING.md, CODE_OF_CONDUCT.md, and SECURITY.md for the full policies.


LinkedIn X Website

MIT · Built by Adam Boudjemaa · Star ⭐ to help others find it


References

Academic and canonical sources for the 24 Laws of UX. Each finding in the audit report cites one or more of these primary sources. No content is copied from external UX reference sites; prose in knowledge/laws-of-ux.md is authored fresh from these papers.

Decision-making and choice

  1. Hick, W. E. (1952). On the rate of gain of information. Quarterly Journal of Experimental Psychology, 4(1), 11-26.
  2. Iyengar, S. S., & Lepper, M. R. (2000). When choice is demotivating: Can one desire too much of a good thing? Journal of Personality and Social Psychology, 79(6), 995-1006.
  3. Hull, C. L. (1932). The goal-gradient hypothesis and maze learning. Psychological Review, 39(1), 25-43.
  4. Pareto, V. (1896). Cours d'economie politique. Lausanne.
  5. Parkinson, C. N. (1955). Parkinson's Law. The Economist, November 19.
  6. William of Ockham, c. 1323. Summa Logicae.

Memory and attention

  1. Miller, G. A. (1956). The magical number seven, plus or minus two: Some limits on our capacity for processing information. Psychological Review, 63(2), 81-97.
  2. Sweller, J. (1988). Cognitive load during problem solving: Effects on learning. Cognitive Science, 12(2), 257-285.
  3. Ebbinghaus, H. (1913). Memory: A Contribution to Experimental Psychology.
  4. von Restorff, H. (1933). Uber die Wirkung von Bereichsbildungen im Spurenfeld. Psychologische Forschung, 18, 299-342.
  5. Zeigarnik, B. (1927). Uber das Behalten von erledigten und unerledigten Handlungen. Psychologische Forschung, 9, 1-85.
  6. Kahneman, D., Fredrickson, B. L., Schreiber, C. A., & Redelmeier, D. A. (1993). When more pain is preferred to less: Adding a better end. Psychological Science, 4(6), 401-405.

Motor and interaction

  1. Fitts, P. M. (1954). The information capacity of the human motor system in controlling the amplitude of movement. Journal of Experimental Psychology, 47(6), 381-391.
  2. Doherty, W. J., & Thadhani, A. J. (1982). The Economic Value of Rapid Response Time. IBM Report GE20-0752-0.

Perception (Gestalt)

  1. Wertheimer, M. (1923). Untersuchungen zur Lehre von der Gestalt II. Psychologische Forschung, 4, 301-350.
  2. Koffka, K. (1935). Principles of Gestalt Psychology. Harcourt, Brace and World.
  3. Palmer, S. E. (1992). Common region: A new principle of perceptual grouping. Cognitive Psychology, 24(3), 436-447.
  4. Palmer, S. E., & Rock, I. (1994). Rethinking perceptual organization: The role of uniform connectedness. Psychonomic Bulletin & Review, 1(1), 29-55.
  5. Kurosu, M., & Kashimura, K. (1995). Apparent usability vs. inherent usability: Experimental analysis on the determinants of the apparent usability. CHI '95 Conference Companion, 292-293.

Convention and complexity

  1. Nielsen, J. (2000). End of Web Design. Nielsen Norman Group Alertbox.
  2. Postel, J. (1980). RFC 761: Transmission Control Protocol. IETF.
  3. Saffer, D. (2010). Designing for Interaction (2nd ed.). New Riders.

About

Design audit for Claude Code. Scores UI/UX across 12 dimensions grounded in 24 named UX laws with primary-source citations. WCAG + APCA + OKLCH. Zero dependencies.

Topics

Resources

License

Code of conduct

Contributing

Security policy

Stars

Watchers

Forks

Packages

 
 
 

Contributors