impeccable 2.1.7 → 2.1.9

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/README.md CHANGED
@@ -1,6 +1,6 @@
1
1
  # Impeccable CLI
2
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.
3
+ Detect UI anti-patterns and design quality issues from the command line. Scans HTML, CSS, JSX, TSX, Vue, and Svelte files for 27 specific patterns including AI-generated UI tells, accessibility violations, and general design quality problems.
4
4
 
5
5
  ## Quick Start
6
6
 
package/README.npm.md CHANGED
@@ -1,6 +1,6 @@
1
1
  # Impeccable CLI
2
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.
3
+ Detect UI anti-patterns and design quality issues from the command line. Scans HTML, CSS, JSX, TSX, Vue, and Svelte files for 27 specific patterns including AI-generated UI tells, accessibility violations, and general design quality problems.
4
4
 
5
5
  ## Quick Start
6
6
 
package/README.repo.md CHANGED
@@ -1,95 +1,80 @@
1
1
  # Impeccable
2
2
 
3
- The vocabulary you didn't know you needed. 1 skill, 18 commands, and curated anti-patterns for impeccable frontend design.
3
+ The vocabulary you didn't know you needed. 1 skill, 23 commands, and curated anti-patterns for impeccable frontend design.
4
4
 
5
5
  > **Quick start:** Visit [impeccable.style](https://impeccable.style) to download ready-to-use bundles.
6
6
 
7
7
  ## Why Impeccable?
8
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.
9
+ Anthropic's [frontend-design](https://github.com/anthropics/skills/tree/main/skills/frontend-design) was the first widely-used design skill for Claude. Impeccable started from there.
10
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.
11
+ Every model trained on the same SaaS templates. Skip the guidance and you get the same handful of tells on every project: Inter for everything, purple-to-blue gradients, cards nested in cards, gray text on colored backgrounds, the rounded-square icon tile above every heading.
12
12
 
13
- Impeccable fights that bias with:
14
- - **An expanded skill** with 7 domain-specific reference files ([view source](source/skills/impeccable/))
15
- - **18 steering commands** to audit, review, polish, distill, animate, and more
16
- - **Curated anti-patterns** that explicitly tell the AI what NOT to do
13
+ Impeccable adds:
14
+ - **7 domain reference files** ([view source](skill/)). Typography, color, motion, spatial, interaction, responsive, UX writing. Load on every command, alongside a brand-vs-product register that adjusts the defaults.
15
+ - **23 commands.** A shared design vocabulary with your AI: `polish`, `audit`, `critique`, `distill`, `animate`, `bolder`, `quieter`, and more.
16
+ - **27 deterministic anti-pattern rules** plus a 12-rule LLM critique pass. CLI and browser extension run the deterministic ones with no LLM and no API key. Each is tied to specific design guidance the skill teaches against.
17
17
 
18
18
  ## What's Included
19
19
 
20
20
  ### The Skill: impeccable
21
21
 
22
- A comprehensive design skill with 7 domain-specific references ([view skill](source/skills/impeccable/SKILL.md)):
22
+ A comprehensive design skill with 7 domain-specific references ([view skill](skill/SKILL.md)):
23
23
 
24
24
  | Reference | Covers |
25
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 |
26
+ | [typography](skill/reference/typography.md) | Type systems, font pairing, modular scales, OpenType |
27
+ | [color-and-contrast](skill/reference/color-and-contrast.md) | OKLCH, tinted neutrals, dark mode, accessibility |
28
+ | [spatial-design](skill/reference/spatial-design.md) | Spacing systems, grids, visual hierarchy |
29
+ | [motion-design](skill/reference/motion-design.md) | Easing curves, staggering, reduced motion |
30
+ | [interaction-design](skill/reference/interaction-design.md) | Forms, focus states, loading patterns |
31
+ | [responsive-design](skill/reference/responsive-design.md) | Mobile-first, fluid design, container queries |
32
+ | [ux-writing](skill/reference/ux-writing.md) | Button labels, error messages, empty states |
33
33
 
34
- ### 18 Commands
34
+ ### 23 Commands
35
+
36
+ All commands are accessed through `/impeccable`:
35
37
 
36
38
  | Command | What it does |
37
39
  |---------|--------------|
38
- | `/impeccable teach` | One-time setup: gather design context, save to config |
39
40
  | `/impeccable craft` | Full shape-then-build flow with visual iteration |
41
+ | `/impeccable teach` | One-time setup: gather design context, write root PRODUCT.md and DESIGN.md |
42
+ | `/impeccable document` | Generate root DESIGN.md from existing project code |
40
43
  | `/impeccable extract` | Pull reusable components and tokens into the design system |
41
- | `/audit` | Run technical quality checks (a11y, performance, responsive) |
42
- | `/critique` | UX design review: hierarchy, clarity, emotional resonance |
43
- | `/polish` | Final pass, design system alignment, and shipping readiness |
44
- | `/distill` | Strip to essence |
45
- | `/clarify` | Improve unclear UX copy |
46
- | `/optimize` | Performance improvements |
47
- | `/harden` | Error handling, onboarding, i18n, edge cases |
48
- | `/animate` | Add purposeful motion |
49
- | `/colorize` | Introduce strategic color |
50
- | `/bolder` | Amplify boring designs |
51
- | `/quieter` | Tone down overly bold designs |
52
- | `/delight` | Add moments of joy |
53
- | `/adapt` | Adapt for different devices |
54
- | `/typeset` | Fix font choices, hierarchy, sizing |
55
- | `/layout` | Fix layout, spacing, visual rhythm |
56
- | `/overdrive` | Add technically extraordinary effects |
44
+ | `/impeccable shape` | Plan UX/UI before writing code |
45
+ | `/impeccable critique` | UX design review: hierarchy, clarity, emotional resonance |
46
+ | `/impeccable audit` | Run technical quality checks (a11y, performance, responsive) |
47
+ | `/impeccable polish` | Final pass, design system alignment, and shipping readiness |
48
+ | `/impeccable bolder` | Amplify boring designs |
49
+ | `/impeccable quieter` | Tone down overly bold designs |
50
+ | `/impeccable distill` | Strip to essence |
51
+ | `/impeccable harden` | Error handling, i18n, text overflow, edge cases |
52
+ | `/impeccable onboard` | First-run flows, empty states, activation paths |
53
+ | `/impeccable animate` | Add purposeful motion |
54
+ | `/impeccable colorize` | Introduce strategic color |
55
+ | `/impeccable typeset` | Fix font choices, hierarchy, sizing |
56
+ | `/impeccable layout` | Fix layout, spacing, visual rhythm |
57
+ | `/impeccable delight` | Add moments of joy |
58
+ | `/impeccable overdrive` | Add technically extraordinary effects |
59
+ | `/impeccable clarify` | Improve unclear UX copy |
60
+ | `/impeccable adapt` | Adapt for different devices |
61
+ | `/impeccable optimize` | Performance improvements |
62
+ | `/impeccable live` | Visual variant mode: iterate on elements in the browser |
63
+
64
+ Use `/impeccable pin <command>` to create standalone shortcuts (e.g., `pin audit` creates `/audit`).
57
65
 
58
66
  #### Usage Examples
59
67
 
60
- **`/audit`** - Run quality checks, get a report (no edits)
61
- ```
62
- /audit blog # Audit blog hub + post pages
63
- /audit dashboard # Check dashboard components
64
- /audit checkout flow # Focus on checkout UX
65
- ```
66
- *When to use:* Before making changes, to understand what needs fixing.
67
-
68
- **`/normalize`** - Align with design system
69
68
  ```
70
- /normalize blog # Apply design tokens, fix spacing
71
- /normalize buttons # Standardize button styles
69
+ /impeccable audit blog # Audit blog hub + post pages
70
+ /impeccable critique landing # UX design review
71
+ /impeccable polish settings # Final pass before shipping
72
+ /impeccable harden checkout # Add error handling + edge cases
72
73
  ```
73
- *When to use:* After audit, to fix inconsistencies.
74
74
 
75
- **`/critique`** - UX design review
75
+ Or use `/impeccable` directly with a description:
76
76
  ```
77
- /critique landing page # Review landing page UX
78
- /critique onboarding # Check onboarding flow
79
- ```
80
- *When to use:* When you want design feedback, not technical fixes.
81
-
82
- **`/polish`** - Final pass before shipping
83
- ```
84
- /polish feature modal # Clean up modal before release
85
- /polish settings page # Final review of settings UI
86
- ```
87
- *When to use:* Last step before deploying to production.
88
-
89
- **Combining commands:**
90
- ```
91
- /audit /normalize /polish blog # Full workflow: audit → fix → polish
92
- /critique /harden checkout # UX review + add error handling
77
+ /impeccable redo this hero section
93
78
  ```
94
79
 
95
80
  ### Anti-Patterns
@@ -158,7 +143,21 @@ cp -r dist/gemini/.gemini your-project/
158
143
 
159
144
  **Codex CLI:**
160
145
  ```bash
161
- cp -r dist/codex/.codex/* ~/.codex/
146
+ # Project-local
147
+ cp -r dist/agents/.agents your-project/
148
+ mkdir -p your-project/.codex
149
+ cp -r dist/codex/.codex/agents your-project/.codex/
150
+
151
+ # Or user-wide
152
+ mkdir -p ~/.agents/skills
153
+ cp -r dist/agents/.agents/skills/* ~/.agents/skills/
154
+ mkdir -p ~/.codex
155
+ cp -r dist/codex/.codex/agents ~/.codex/
156
+ ```
157
+
158
+ **GitHub Copilot:**
159
+ ```bash
160
+ cp -r dist/github/.github your-project/
162
161
  ```
163
162
 
164
163
  **Trae:**
@@ -185,6 +184,15 @@ cp -r dist/rovo-dev/.rovodev your-project/
185
184
  cp -r dist/rovo-dev/.rovodev/skills/* ~/.rovodev/skills/
186
185
  ```
187
186
 
187
+ **Qoder:**
188
+ ```bash
189
+ # Project-specific
190
+ cp -r dist/qoder/.qoder your-project/
191
+
192
+ # Or global (applies to all projects)
193
+ cp -r dist/qoder/.qoder/skills/* ~/.qoder/skills/
194
+ ```
195
+
188
196
  ## Usage
189
197
 
190
198
  Once installed, use commands in your AI harness:
@@ -203,7 +211,7 @@ Most commands accept an optional argument to focus on a specific area:
203
211
  /polish checkout-form
204
212
  ```
205
213
 
206
- **Note:** Codex CLI uses a different syntax: `/prompts:audit`, `/prompts:polish`, etc.
214
+ **Note:** Codex uses skills here, not `/prompts:` commands. Open `/skills` or type `$impeccable`. Repo-local installs live in `.agents/skills/`; user-wide installs live in `~/.agents/skills/`. GitHub Copilot uses `.github/skills/`. Restart the tool if a newly installed skill does not appear.
207
215
 
208
216
  ## CLI
209
217
 
@@ -230,6 +238,15 @@ The detector catches 24 issues across AI slop (side-tab borders, purple gradient
230
238
  - [Kiro](https://kiro.dev)
231
239
  - [Trae](https://trae.ai)
232
240
  - [Rovo Dev](https://www.atlassian.com/software/rovo)
241
+ - [Qoder](https://qoder.com)
242
+
243
+ ## Community & Ecosystem
244
+
245
+ Join the community and ecosystem conversations:
246
+
247
+ - GitHub Discussions: file bugs, request features, and help newcomers.
248
+ - [Impeccable on npm](https://www.npmjs.com/package/impeccable): grab the CLI, follow releases, and star the package.
249
+ - Follow @pbakaus on Twitter for release notes, sample lint reports, and video highlights of new rules.
233
250
 
234
251
  ## Contributing
235
252
 
@@ -5,8 +5,6 @@
5
5
  *
6
6
  * Usage:
7
7
  * npx impeccable detect [file-or-dir-or-url...]
8
- * npx impeccable live [--port=PORT]
9
- * npx impeccable live stop
10
8
  * npx impeccable skills help|install|update
11
9
  * npx impeccable --help
12
10
  */
@@ -24,8 +22,6 @@ if (!command || command === '--help' || command === '-h') {
24
22
 
25
23
  Commands:
26
24
  detect [file-or-dir-or-url...] Scan for UI anti-patterns and design quality issues
27
- live [--port=PORT] Start browser detection overlay server
28
- live stop Stop a running live server
29
25
  skills help List all available skills and commands
30
26
  skills install Install impeccable skills into your project
31
27
  skills update Update skills to the latest version
@@ -40,25 +36,21 @@ Run 'impeccable <command> --help' for command-specific options.`);
40
36
  }
41
37
 
42
38
  if (command === '--version' || command === '-v') {
43
- const pkg = JSON.parse(readFileSync(join(__dirname, '..', 'package.json'), 'utf8'));
39
+ const pkg = JSON.parse(readFileSync(join(__dirname, '..', '..', 'package.json'), 'utf8'));
44
40
  console.log(pkg.version);
45
41
  process.exit(0);
46
42
  }
47
43
 
48
44
  if (command === 'detect') {
49
45
  process.argv = [process.argv[0], process.argv[1], ...args.slice(1)];
50
- const { detectCli } = await import('../src/detect-antipatterns.mjs');
46
+ const { detectCli } = await import('../engine/detect-antipatterns.mjs');
51
47
  await detectCli();
52
- } else if (command === 'live') {
53
- process.argv = [process.argv[0], process.argv[1], ...args.slice(1)];
54
- const { liveCli } = await import('../src/detect-antipatterns.mjs');
55
- await liveCli();
56
48
  } else if (command === 'skills') {
57
49
  const { run } = await import('./commands/skills.mjs');
58
50
  await run(args.slice(1));
59
51
  } else {
60
52
  // Default: treat as detect arguments (allow `npx impeccable src/` shorthand)
61
53
  process.argv = [process.argv[0], process.argv[1], ...args];
62
- const { detectCli } = await import('../src/detect-antipatterns.mjs');
54
+ const { detectCli } = await import('../engine/detect-antipatterns.mjs');
63
55
  await detectCli();
64
56
  }
@@ -20,7 +20,7 @@ const __dirname = dirname(fileURLToPath(import.meta.url));
20
20
  const API_BASE = 'https://impeccable.style';
21
21
 
22
22
  // Provider folder names in project roots
23
- const PROVIDER_DIRS = ['.claude', '.cursor', '.gemini', '.codex', '.agents', '.kiro', '.opencode', '.pi', '.trae', '.trae-cn'];
23
+ const PROVIDER_DIRS = ['.claude', '.cursor', '.gemini', '.agents', '.github', '.kiro', '.opencode', '.pi', '.qoder', '.trae', '.trae-cn'];
24
24
 
25
25
  function ask(question) {
26
26
  const rl = createInterface({ input: process.stdin, output: process.stdout });
@@ -112,7 +112,7 @@ async function downloadAndExtractBundle() {
112
112
  */
113
113
  function normalizeForHash(content) {
114
114
  return content
115
- .replace(/\.(claude|cursor|agents|gemini|codex|kiro|opencode|pi|trae|trae-cn|rovodev)\/skills\//g, '.PROVIDER/skills/')
115
+ .replace(/\.(claude|cursor|agents|github|gemini|codex|kiro|opencode|pi|qoder|trae|trae-cn|rovodev)\/skills\//g, '.PROVIDER/skills/')
116
116
  .replace(/^version:\s*.+$/m, 'version: NORMALIZED');
117
117
  }
118
118
 
@@ -364,7 +364,7 @@ async function install(flags) {
364
364
 
365
365
  // Clean up deprecated skills from previous versions
366
366
  try {
367
- const { cleanup } = await import('../../source/skills/impeccable/scripts/cleanup-deprecated.mjs');
367
+ const { cleanup } = await import('../../../skill/scripts/cleanup-deprecated.mjs');
368
368
  const result = cleanup(root);
369
369
  const total = result.deletedPaths.length + result.removedLockEntries.length;
370
370
  if (total > 0) {
@@ -513,7 +513,7 @@ async function update(flags = []) {
513
513
 
514
514
  // Clean up deprecated skills from previous versions.
515
515
  try {
516
- const { cleanup } = await import('../../source/skills/impeccable/scripts/cleanup-deprecated.mjs');
516
+ const { cleanup } = await import('../../../skill/scripts/cleanup-deprecated.mjs');
517
517
  const root = findProjectRoot();
518
518
  const result = cleanup(root);
519
519
  const total = result.deletedPaths.length + result.removedLockEntries.length;
@@ -598,7 +598,7 @@ async function update(flags = []) {
598
598
 
599
599
  // Run cleanup to remove deprecated stubs from the fresh download
600
600
  try {
601
- const { cleanup: postCleanup } = await import('../../source/skills/impeccable/scripts/cleanup-deprecated.mjs');
601
+ const { cleanup: postCleanup } = await import('../../../skill/scripts/cleanup-deprecated.mjs');
602
602
  postCleanup(root);
603
603
  } catch {
604
604
  // Not available -- skip