impeccable 2.0.4 → 2.0.6
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/LICENSE +77 -191
- package/README.md +1 -1
- package/bin/{impeccable → cli.js} +9 -5
- package/package.json +24 -30
- package/src/detect-antipatterns-browser.js +1584 -0
- package/src/detect-antipatterns.mjs +2582 -0
- package/README.bak.md +0 -247
- package/README.npm.md +0 -76
- package/lib/download-providers.js +0 -24
package/README.bak.md
DELETED
|
@@ -1,247 +0,0 @@
|
|
|
1
|
-
# Impeccable
|
|
2
|
-
|
|
3
|
-
The vocabulary you didn't know you needed. 1 skill, 22 commands, and curated anti-patterns for impeccable frontend design.
|
|
4
|
-
|
|
5
|
-
> **Quick start:** Visit [impeccable.style](https://impeccable.style) to download ready-to-use bundles.
|
|
6
|
-
|
|
7
|
-
## Why Impeccable?
|
|
8
|
-
|
|
9
|
-
Anthropic created [frontend-design](https://github.com/anthropics/skills/tree/main/skills/frontend-design), a skill that guides Claude toward better UI design. Impeccable builds on that foundation with deeper expertise and more control.
|
|
10
|
-
|
|
11
|
-
Every LLM learned from the same generic templates. Without guidance, you get the same predictable mistakes: Inter font, purple gradients, cards nested in cards, gray text on colored backgrounds.
|
|
12
|
-
|
|
13
|
-
Impeccable fights that bias with:
|
|
14
|
-
- **An expanded skill** with 7 domain-specific reference files ([view source](source/skills/impeccable/))
|
|
15
|
-
- **22 steering commands** to audit, review, polish, distill, animate, and more
|
|
16
|
-
- **Curated anti-patterns** that explicitly tell the AI what NOT to do
|
|
17
|
-
|
|
18
|
-
## What's Included
|
|
19
|
-
|
|
20
|
-
### The Skill: impeccable
|
|
21
|
-
|
|
22
|
-
A comprehensive design skill with 7 domain-specific references ([view skill](source/skills/impeccable/SKILL.md)):
|
|
23
|
-
|
|
24
|
-
| Reference | Covers |
|
|
25
|
-
|-----------|--------|
|
|
26
|
-
| [typography](source/skills/impeccable/reference/typography.md) | Type systems, font pairing, modular scales, OpenType |
|
|
27
|
-
| [color-and-contrast](source/skills/impeccable/reference/color-and-contrast.md) | OKLCH, tinted neutrals, dark mode, accessibility |
|
|
28
|
-
| [spatial-design](source/skills/impeccable/reference/spatial-design.md) | Spacing systems, grids, visual hierarchy |
|
|
29
|
-
| [motion-design](source/skills/impeccable/reference/motion-design.md) | Easing curves, staggering, reduced motion |
|
|
30
|
-
| [interaction-design](source/skills/impeccable/reference/interaction-design.md) | Forms, focus states, loading patterns |
|
|
31
|
-
| [responsive-design](source/skills/impeccable/reference/responsive-design.md) | Mobile-first, fluid design, container queries |
|
|
32
|
-
| [ux-writing](source/skills/impeccable/reference/ux-writing.md) | Button labels, error messages, empty states |
|
|
33
|
-
|
|
34
|
-
### 22 Commands
|
|
35
|
-
|
|
36
|
-
| Command | What it does |
|
|
37
|
-
|---------|--------------|
|
|
38
|
-
| `/impeccable teach` | One-time setup: gather design context, save to config |
|
|
39
|
-
| `/audit` | Run technical quality checks (a11y, performance, responsive) |
|
|
40
|
-
| `/critique` | UX design review: hierarchy, clarity, emotional resonance |
|
|
41
|
-
| `/normalize` | Align with design system standards |
|
|
42
|
-
| `/polish` | Final pass before shipping |
|
|
43
|
-
| `/distill` | Strip to essence |
|
|
44
|
-
| `/clarify` | Improve unclear UX copy |
|
|
45
|
-
| `/optimize` | Performance improvements |
|
|
46
|
-
| `/harden` | Error handling, i18n, edge cases |
|
|
47
|
-
| `/animate` | Add purposeful motion |
|
|
48
|
-
| `/colorize` | Introduce strategic color |
|
|
49
|
-
| `/bolder` | Amplify boring designs |
|
|
50
|
-
| `/quieter` | Tone down overly bold designs |
|
|
51
|
-
| `/delight` | Add moments of joy |
|
|
52
|
-
| `/extract` | Pull into reusable components |
|
|
53
|
-
| `/adapt` | Adapt for different devices |
|
|
54
|
-
| `/onboard` | Design onboarding flows |
|
|
55
|
-
| `/typeset` | Fix font choices, hierarchy, sizing |
|
|
56
|
-
| `/arrange` | Fix layout, spacing, visual rhythm |
|
|
57
|
-
| `/overdrive` | Add technically extraordinary effects |
|
|
58
|
-
|
|
59
|
-
#### Usage Examples
|
|
60
|
-
|
|
61
|
-
**`/audit`** - Run quality checks, get a report (no edits)
|
|
62
|
-
```
|
|
63
|
-
/audit blog # Audit blog hub + post pages
|
|
64
|
-
/audit dashboard # Check dashboard components
|
|
65
|
-
/audit checkout flow # Focus on checkout UX
|
|
66
|
-
```
|
|
67
|
-
*When to use:* Before making changes, to understand what needs fixing.
|
|
68
|
-
|
|
69
|
-
**`/normalize`** - Align with design system
|
|
70
|
-
```
|
|
71
|
-
/normalize blog # Apply design tokens, fix spacing
|
|
72
|
-
/normalize buttons # Standardize button styles
|
|
73
|
-
```
|
|
74
|
-
*When to use:* After audit, to fix inconsistencies.
|
|
75
|
-
|
|
76
|
-
**`/critique`** - UX design review
|
|
77
|
-
```
|
|
78
|
-
/critique landing page # Review landing page UX
|
|
79
|
-
/critique onboarding # Check onboarding flow
|
|
80
|
-
```
|
|
81
|
-
*When to use:* When you want design feedback, not technical fixes.
|
|
82
|
-
|
|
83
|
-
**`/polish`** - Final pass before shipping
|
|
84
|
-
```
|
|
85
|
-
/polish feature modal # Clean up modal before release
|
|
86
|
-
/polish settings page # Final review of settings UI
|
|
87
|
-
```
|
|
88
|
-
*When to use:* Last step before deploying to production.
|
|
89
|
-
|
|
90
|
-
**Combining commands:**
|
|
91
|
-
```
|
|
92
|
-
/audit /normalize /polish blog # Full workflow: audit → fix → polish
|
|
93
|
-
/critique /harden checkout # UX review + add error handling
|
|
94
|
-
```
|
|
95
|
-
|
|
96
|
-
### Anti-Patterns
|
|
97
|
-
|
|
98
|
-
The skill includes explicit guidance on what to avoid:
|
|
99
|
-
|
|
100
|
-
- Don't use overused fonts (Arial, Inter, system defaults)
|
|
101
|
-
- Don't use gray text on colored backgrounds
|
|
102
|
-
- Don't use pure black/gray (always tint)
|
|
103
|
-
- Don't wrap everything in cards or nest cards inside cards
|
|
104
|
-
- Don't use bounce/elastic easing (feels dated)
|
|
105
|
-
|
|
106
|
-
## See It In Action
|
|
107
|
-
|
|
108
|
-
Visit [impeccable.style](https://impeccable.style#casestudies) to see before/after case studies of real projects transformed with Impeccable commands.
|
|
109
|
-
|
|
110
|
-
## Installation
|
|
111
|
-
|
|
112
|
-
### Option 1: Download from Website (Recommended)
|
|
113
|
-
|
|
114
|
-
Visit [impeccable.style](https://impeccable.style), download the ZIP for your tool, and extract to your project.
|
|
115
|
-
|
|
116
|
-
### Option 2: Copy from Repository
|
|
117
|
-
|
|
118
|
-
**Cursor:**
|
|
119
|
-
```bash
|
|
120
|
-
cp -r dist/cursor/.cursor your-project/
|
|
121
|
-
```
|
|
122
|
-
|
|
123
|
-
> **Note:** Cursor skills require setup:
|
|
124
|
-
> 1. Switch to Nightly channel in Cursor Settings → Beta
|
|
125
|
-
> 2. Enable Agent Skills in Cursor Settings → Rules
|
|
126
|
-
>
|
|
127
|
-
> [Learn more about Cursor skills](https://cursor.com/docs/context/skills)
|
|
128
|
-
|
|
129
|
-
**Claude Code:**
|
|
130
|
-
```bash
|
|
131
|
-
# Project-specific
|
|
132
|
-
cp -r dist/claude-code/.claude your-project/
|
|
133
|
-
|
|
134
|
-
# Or global (applies to all projects)
|
|
135
|
-
cp -r dist/claude-code/.claude/* ~/.claude/
|
|
136
|
-
```
|
|
137
|
-
|
|
138
|
-
**OpenCode:**
|
|
139
|
-
```bash
|
|
140
|
-
cp -r dist/opencode/.opencode your-project/
|
|
141
|
-
```
|
|
142
|
-
|
|
143
|
-
**Pi:**
|
|
144
|
-
```bash
|
|
145
|
-
cp -r dist/pi/.pi your-project/
|
|
146
|
-
```
|
|
147
|
-
|
|
148
|
-
**Gemini CLI:**
|
|
149
|
-
```bash
|
|
150
|
-
cp -r dist/gemini/.gemini your-project/
|
|
151
|
-
```
|
|
152
|
-
|
|
153
|
-
> **Note:** Gemini CLI skills require setup:
|
|
154
|
-
> 1. Install preview version: `npm i -g @google/gemini-cli@preview`
|
|
155
|
-
> 2. Run `/settings` and enable "Skills"
|
|
156
|
-
> 3. Run `/skills list` to verify installation
|
|
157
|
-
>
|
|
158
|
-
> [Learn more about Gemini CLI skills](https://geminicli.com/docs/cli/skills/)
|
|
159
|
-
|
|
160
|
-
**Codex CLI:**
|
|
161
|
-
```bash
|
|
162
|
-
cp -r dist/codex/.codex/* ~/.codex/
|
|
163
|
-
```
|
|
164
|
-
|
|
165
|
-
**Trae:**
|
|
166
|
-
```bash
|
|
167
|
-
# Trae China (domestic version)
|
|
168
|
-
cp -r dist/trae/.trae-cn/skills/* ~/.trae-cn/skills/
|
|
169
|
-
|
|
170
|
-
# Trae International
|
|
171
|
-
cp -r dist/trae/.trae/skills/* ~/.trae/skills/
|
|
172
|
-
```
|
|
173
|
-
|
|
174
|
-
> **Note:** Trae has two versions with different config directories:
|
|
175
|
-
> - **Trae China**: `~/.trae-cn/skills/`
|
|
176
|
-
> - **Trae International**: `~/.trae/skills/`
|
|
177
|
-
>
|
|
178
|
-
> After copying, restart Trae IDE to activate the skills.
|
|
179
|
-
|
|
180
|
-
**Rovo Dev:**
|
|
181
|
-
```bash
|
|
182
|
-
# Project-specific
|
|
183
|
-
cp -r dist/rovo-dev/.rovodev your-project/
|
|
184
|
-
|
|
185
|
-
# Or global (applies to all projects)
|
|
186
|
-
cp -r dist/rovo-dev/.rovodev/skills/* ~/.rovodev/skills/
|
|
187
|
-
```
|
|
188
|
-
|
|
189
|
-
## Usage
|
|
190
|
-
|
|
191
|
-
Once installed, use commands in your AI harness:
|
|
192
|
-
|
|
193
|
-
```
|
|
194
|
-
/audit # Find issues
|
|
195
|
-
/normalize # Fix inconsistencies
|
|
196
|
-
/polish # Final cleanup
|
|
197
|
-
/distill # Remove complexity
|
|
198
|
-
```
|
|
199
|
-
|
|
200
|
-
Most commands accept an optional argument to focus on a specific area:
|
|
201
|
-
|
|
202
|
-
```
|
|
203
|
-
/audit header
|
|
204
|
-
/polish checkout-form
|
|
205
|
-
```
|
|
206
|
-
|
|
207
|
-
**Note:** Codex CLI uses a different syntax: `/prompts:audit`, `/prompts:polish`, etc.
|
|
208
|
-
|
|
209
|
-
## CLI
|
|
210
|
-
|
|
211
|
-
Impeccable includes a standalone CLI for detecting anti-patterns without an AI harness:
|
|
212
|
-
|
|
213
|
-
```bash
|
|
214
|
-
npx impeccable detect src/ # scan a directory
|
|
215
|
-
npx impeccable detect index.html # scan an HTML file
|
|
216
|
-
npx impeccable detect https://example.com # scan a URL (Puppeteer)
|
|
217
|
-
npx impeccable detect --fast --json . # regex-only, JSON output
|
|
218
|
-
```
|
|
219
|
-
|
|
220
|
-
The detector catches 24 issues across AI slop (side-tab borders, purple gradients, bounce easing, dark glows) and general design quality (line length, cramped padding, small touch targets, skipped headings, and more).
|
|
221
|
-
|
|
222
|
-
## Supported Tools
|
|
223
|
-
|
|
224
|
-
- [Cursor](https://cursor.com)
|
|
225
|
-
- [Claude Code](https://claude.ai/code)
|
|
226
|
-
- [OpenCode](https://opencode.ai)
|
|
227
|
-
- [Pi](https://pi.dev)
|
|
228
|
-
- [Gemini CLI](https://github.com/google-gemini/gemini-cli)
|
|
229
|
-
- [Codex CLI](https://github.com/openai/codex)
|
|
230
|
-
- [VS Code Copilot](https://code.visualstudio.com)
|
|
231
|
-
- [Kiro](https://kiro.dev)
|
|
232
|
-
- [Trae](https://trae.ai)
|
|
233
|
-
- [Rovo Dev](https://www.atlassian.com/software/rovo)
|
|
234
|
-
|
|
235
|
-
## Contributing
|
|
236
|
-
|
|
237
|
-
See [DEVELOP.md](DEVELOP.md) for contributor guidelines and build instructions.
|
|
238
|
-
|
|
239
|
-
## License
|
|
240
|
-
|
|
241
|
-
Apache 2.0. See [LICENSE](LICENSE).
|
|
242
|
-
|
|
243
|
-
The impeccable skill builds on [Anthropic's original frontend-design skill](https://github.com/anthropics/skills/tree/main/skills/frontend-design). See [NOTICE.md](NOTICE.md) for attribution.
|
|
244
|
-
|
|
245
|
-
---
|
|
246
|
-
|
|
247
|
-
Created by [Paul Bakaus](https://www.paulbakaus.com)
|
package/README.npm.md
DELETED
|
@@ -1,76 +0,0 @@
|
|
|
1
|
-
# Impeccable CLI
|
|
2
|
-
|
|
3
|
-
Detect UI anti-patterns and design quality issues from the command line. Scans HTML, CSS, JSX, TSX, Vue, and Svelte files for 25 specific patterns including AI-generated UI tells, accessibility violations, and general design quality problems.
|
|
4
|
-
|
|
5
|
-
## Quick Start
|
|
6
|
-
|
|
7
|
-
```bash
|
|
8
|
-
# Install skills into your AI harness (Claude, Cursor, Gemini, etc.)
|
|
9
|
-
npx impeccable skills install
|
|
10
|
-
|
|
11
|
-
# Update skills to the latest version
|
|
12
|
-
npx impeccable skills update
|
|
13
|
-
|
|
14
|
-
# List all available commands
|
|
15
|
-
npx impeccable skills help
|
|
16
|
-
|
|
17
|
-
# Scan files or directories for anti-patterns
|
|
18
|
-
npx impeccable detect src/
|
|
19
|
-
|
|
20
|
-
# Scan a live URL (requires Puppeteer)
|
|
21
|
-
npx impeccable detect https://example.com
|
|
22
|
-
|
|
23
|
-
# JSON output for CI/tooling
|
|
24
|
-
npx impeccable detect --json src/
|
|
25
|
-
|
|
26
|
-
# Regex-only mode (faster, no jsdom)
|
|
27
|
-
npx impeccable detect --fast src/
|
|
28
|
-
```
|
|
29
|
-
|
|
30
|
-
## What It Detects
|
|
31
|
-
|
|
32
|
-
**AI Slop Tells** -- patterns that scream "AI generated this":
|
|
33
|
-
- Side-tab accent borders, gradient text on headings
|
|
34
|
-
- Purple/violet gradients and cyan-on-dark palettes
|
|
35
|
-
- Dark mode with glowing accents, border + border-radius clashes
|
|
36
|
-
|
|
37
|
-
**Typography Issues** -- overused fonts (Inter, Roboto), flat type hierarchy, single font families
|
|
38
|
-
|
|
39
|
-
**Color & Contrast** -- WCAG AA violations, gray text on colored backgrounds, pure black/white
|
|
40
|
-
|
|
41
|
-
**Layout & Composition** -- nested cards, monotonous spacing, everything-centered layouts
|
|
42
|
-
|
|
43
|
-
**Motion** -- bounce/elastic easing, layout property transitions
|
|
44
|
-
|
|
45
|
-
**Quality** -- tiny body text, cramped padding, long line lengths, small touch targets
|
|
46
|
-
|
|
47
|
-
25 detections in total. See the full list at [impeccable.style](https://impeccable.style).
|
|
48
|
-
|
|
49
|
-
## Exit Codes
|
|
50
|
-
|
|
51
|
-
- `0` -- no issues found
|
|
52
|
-
- `2` -- anti-patterns detected
|
|
53
|
-
|
|
54
|
-
## Options
|
|
55
|
-
|
|
56
|
-
```
|
|
57
|
-
impeccable detect [options] [file-or-dir-or-url...]
|
|
58
|
-
|
|
59
|
-
--fast Regex-only mode (skip jsdom, faster but less accurate)
|
|
60
|
-
--json Output findings as JSON
|
|
61
|
-
--help Show help
|
|
62
|
-
```
|
|
63
|
-
|
|
64
|
-
## Requirements
|
|
65
|
-
|
|
66
|
-
- Node.js 18+
|
|
67
|
-
- `jsdom` (included as dependency, used for HTML scanning)
|
|
68
|
-
- `puppeteer` (optional, only needed for URL scanning)
|
|
69
|
-
|
|
70
|
-
## Part of Impeccable
|
|
71
|
-
|
|
72
|
-
This CLI is part of [Impeccable](https://impeccable.style), a cross-provider design skill pack for AI-powered development tools. The full suite includes 20 steering commands for Claude, Cursor, Gemini, Codex, and more.
|
|
73
|
-
|
|
74
|
-
## License
|
|
75
|
-
|
|
76
|
-
See [LICENSE](https://github.com/pbakaus/impeccable/blob/main/LICENSE) file.
|
|
@@ -1,24 +0,0 @@
|
|
|
1
|
-
export const FILE_DOWNLOAD_PROVIDER_CONFIG_DIRS = Object.freeze({
|
|
2
|
-
cursor: '.cursor',
|
|
3
|
-
'claude-code': '.claude',
|
|
4
|
-
gemini: '.gemini',
|
|
5
|
-
codex: '.codex',
|
|
6
|
-
agents: '.agents',
|
|
7
|
-
kiro: '.kiro',
|
|
8
|
-
opencode: '.opencode',
|
|
9
|
-
pi: '.pi',
|
|
10
|
-
});
|
|
11
|
-
|
|
12
|
-
export const FILE_DOWNLOAD_PROVIDERS = Object.freeze(
|
|
13
|
-
Object.keys(FILE_DOWNLOAD_PROVIDER_CONFIG_DIRS)
|
|
14
|
-
);
|
|
15
|
-
|
|
16
|
-
export const BUNDLE_DOWNLOAD_PROVIDERS = Object.freeze([
|
|
17
|
-
'universal',
|
|
18
|
-
'universal-prefixed',
|
|
19
|
-
]);
|
|
20
|
-
|
|
21
|
-
export const DOWNLOAD_PROVIDERS = Object.freeze([
|
|
22
|
-
...FILE_DOWNLOAD_PROVIDERS,
|
|
23
|
-
...BUNDLE_DOWNLOAD_PROVIDERS,
|
|
24
|
-
]);
|