@appfire-ux/audit-agent 0.20260702.0 → 0.20260702.1

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
@@ -16,8 +16,9 @@ npm install -D @appfire-ux/audit-agent
16
16
  The postinstall script copies the agent and command into `<repo>/.claude/`. Done — open Claude Code and run:
17
17
 
18
18
  ```
19
- /ux-audit # or
20
- /ui-audit
19
+ /full-audit # both audits in parallel (recommended)
20
+ /ux-audit # compliance only
21
+ /ui-audit # UI & usability only
21
22
  ```
22
23
 
23
24
  Once, for all repos on your machine:
@@ -41,12 +42,13 @@ npx @appfire-ux/audit-agent
41
42
  | `.claude/commands/ux-audit.md` | `/ux-audit [scope] [--static-only] [--lang pl] [--out <path>]` |
42
43
  | `.claude/agents/ui-auditor.md` | 8-phase UI & usability audit: guidelines bootstrap → screen/pattern inventory → screenshot capture → consistency/IA/interaction passes → report → self-verification |
43
44
  | `.claude/commands/ui-audit.md` | `/ui-audit [scope] [--static-only] [--lang pl] [--out <path>]` |
45
+ | `.claude/commands/full-audit.md` | `/full-audit [scope] [--static-only] [--lang pl] [--out-dir <path>]` — runs **ux-auditor** and **ui-auditor** in parallel with shared guidelines bootstrap and one dev server |
44
46
 
45
- The audits complement each other: `ux-audit` checks *compliance with the guidelines*, `ui-audit` checks *the interface as designed*. Findings each agent notices outside its lane are handed off to the other's report section.
47
+ The audits complement each other: `ux-audit` checks *compliance with the guidelines*, `ui-audit` checks *the interface as designed*. Use `/full-audit` when you want both at once; findings each agent notices outside its lane are handed off to the other's report section, and the combined summary deduplicates cross-cutting issues.
46
48
 
47
49
  ## Publishing (maintainers)
48
50
 
49
- **CI (preferred):** pushes to `main` that touch `appfire-ux-audit-agent/**` or the canonical agent/command files in `.claude/` (`ux-auditor.md`, `ux-audit.md`, `ui-auditor.md`, `ui-audit.md`) run [`.github/workflows/publish-audit-agent.yml`](../.github/workflows/publish-audit-agent.yml). The workflow assembles the package (syncing templates from `.claude/`), bumps a date-based version (`0.YYYYMMDD.PATCH`), and publishes `@appfire-ux/audit-agent` using the `NPM_TOKEN` secret — same pattern as `@appfire-ux/guidelines` and `@appfire-ux/fonts`.
51
+ **CI (preferred):** pushes to `main` that touch `appfire-ux-audit-agent/**` or the canonical agent/command files in `.claude/` (`ux-auditor.md`, `ux-audit.md`, `ui-auditor.md`, `ui-audit.md`, `full-audit.md`) run [`.github/workflows/publish-audit-agent.yml`](../.github/workflows/publish-audit-agent.yml). The workflow assembles the package (syncing templates from `.claude/`), bumps a date-based version (`0.YYYYMMDD.PATCH`), and publishes `@appfire-ux/audit-agent` using the `NPM_TOKEN` secret — same pattern as `@appfire-ux/guidelines` and `@appfire-ux/fonts`.
50
52
 
51
53
  **Manual:**
52
54
 
package/bin/install.js CHANGED
@@ -69,8 +69,10 @@ console.log('[appfire-ux-audit-agent] Installed ' + copied.length + ' file(s) in
69
69
  for (const f of copied) console.log(' - ' + f);
70
70
  console.log('');
71
71
  console.log('Usage (in Claude Code, inside your repo):');
72
+ console.log(' /full-audit both audits in parallel (recommended for full coverage)');
72
73
  console.log(' /ux-audit guideline-compliance UX audit (tokens, a11y, content, messaging)');
73
74
  console.log(' /ui-audit UI & usability audit (consistency, IA, interaction design)');
74
- console.log(' Both accept: [scope-path] [--static-only] [--lang pl] [--out <path>]');
75
+ console.log(' All accept: [scope-path] [--static-only] [--lang pl]');
76
+ console.log(' /full-audit also: [--out-dir <path>] /ux-audit|/ui-audit: [--out <path>]');
75
77
  console.log('');
76
78
  console.log('Tip: run "npx appfire-ux-audit-agent --global" to install into ~/.claude for all repos.');
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@appfire-ux/audit-agent",
3
- "version": "0.20260702.0",
3
+ "version": "0.20260702.1",
4
4
  "description": "Claude Code audit agents for Appfire apps — installs ux-auditor (/ux-audit: guideline compliance) and ui-auditor (/ui-audit: UI consistency, IA, interaction design), auditing against @appfire-ux/guidelines",
5
5
  "license": "MIT",
6
6
  "publishConfig": {
@@ -0,0 +1,70 @@
1
+ ---
2
+ description: Run ux-auditor and ui-auditor in parallel — full guideline compliance + UI/usability audit
3
+ argument-hint: [scope-path] [--static-only] [--lang pl|en] [--out-dir <path>]
4
+ ---
5
+
6
+ Run **both** audit agents on this repository **in parallel**: **ux-auditor** (guideline compliance) and **ui-auditor** (UI & usability).
7
+
8
+ Arguments passed by the user: `$ARGUMENTS`
9
+
10
+ ## Parse arguments
11
+
12
+ - **Scope path** — optional directory (default: whole repo).
13
+ - `--static-only` — skip runtime/screenshots for both agents; warn the user that the UI audit will be much weaker.
14
+ - `--lang pl|en` — report language for both agents (default: English).
15
+ - `--out-dir <path>` — parent folder for outputs (default: `docs/audits`). Individual reports go in subfolders; do not use `--out` here.
16
+
17
+ Derive report paths (use today's date `YYYY-MM-DD`):
18
+
19
+ | Agent | Report |
20
+ |-------|--------|
21
+ | ux-auditor | `<out-dir>/ux-audit/UX-AUDIT-<date>.md` |
22
+ | ui-auditor | `<out-dir>/ui-audit/UI-AUDIT-<date>.md` |
23
+ | summary | `<out-dir>/AUDIT-SUMMARY-<date>.md` |
24
+
25
+ Screenshot assets: `docs/ui-audit/assets/` and `docs/ux-audit/assets/` (per each agent's defaults) unless you consolidate under `<out-dir>/` — if so, tell both agents the same asset dir to avoid duplicate captures.
26
+
27
+ ## Step 1 — Shared setup (once, before agents)
28
+
29
+ Do this yourself in the main session — **do not** delegate to either agent yet:
30
+
31
+ 1. Bootstrap `@appfire-ux/guidelines` (Phase 0 from ux-auditor): install/update, run `npx @appfire-ux/guidelines`, verify `.cursor/rules/ux-*.mdc` and `guidelines/` exist. Record bootstrap notes for the summary appendix.
32
+ 2. Unless `--static-only`: detect dev command (`npm run dev`, etc.), start **one** dev server, note the base URL. Both agents will reuse it — do not start a second server.
33
+
34
+ ## Step 2 — Launch agents in parallel
35
+
36
+ Spawn **ux-auditor** and **ui-auditor** **concurrently** (two parallel agent tasks — not sequential).
37
+
38
+ Pass each agent this context:
39
+
40
+ ```
41
+ Phase 0 (guidelines bootstrap) is ALREADY COMPLETE in the main session.
42
+ - Kit verified at: [list key paths]
43
+ - Dev server: [running at URL | not started — static-only]
44
+ - Scope: [path or whole repo]
45
+ - Language: [en|pl]
46
+ - Report path: [agent-specific path above]
47
+ - Asset dir: [shared or per-agent path]
48
+
49
+ Skip Phase 0 npm install. Begin at your Phase 1.
50
+ For runtime/screenshot phases: reuse the dev server URL above; do not start another server.
51
+ When done: complete through Phase 7 and return report path, severity counts, top 3 issues, limitations.
52
+ ```
53
+
54
+ Let each agent follow its full methodology from Phase 1 onward.
55
+
56
+ ## Step 3 — Combined summary (after both finish)
57
+
58
+ Write `<out-dir>/AUDIT-SUMMARY-<date>.md`:
59
+
60
+ 1. **Executive overview** — 5–8 sentences, both lenses combined.
61
+ 2. **Reports** — links to both markdown files.
62
+ 3. **Combined scorecard** — ux-auditor categories + ui-auditor categories, total findings by severity.
63
+ 4. **Top 5 cross-cutting issues** — deduplicated; note if ux and ui flagged the same surface differently.
64
+ 5. **Handoffs merged** — items each agent deferred to the other.
65
+ 6. **Shared limitations** — static-only, capture gaps, bootstrap notes.
66
+ 7. **Suggested order of work** — quick wins that satisfy both audits first.
67
+
68
+ ## Relay to the user
69
+
70
+ Report paths, combined severity counts, top 3 issues across both audits, whether parallel run succeeded, and any limitations.