Skip to content

README.md

Latest commit

 

History

History
29 lines (18 loc) · 1.55 KB

README.md

File metadata and controls

29 lines (18 loc) · 1.55 KB
Raw

audit

Deterministic tooling for the shadcn-fidelity audit skill. Each subcommand prints one JSON object.

cd audit
mise exec -- bundle exec rake                       # tests + standardrb
mise exec -- bundle exec exe/shadcn-audit workspace [--sha SHA]

workspace keeps a sparse clone of shadcn-ui/ui in .shadcn-audit/ui (git-ignored) and checks out main, or the given SHA.

Tests use ShadcnAudit::FakeShell (test/test_helper.rb): stub canned stdout by argv or matcher, then assert on recorded calls.

Prerequisites

Ruby 3.4 (via mise, as below, or an equivalent version manager; without mise, drop mise exec --), gh authenticated (gh auth status), Node and pnpm, and, for the browser steps, the chrome-devtools MCP. The audit runs its two dev servers in Herdr panes when HERDR_ENV=1, otherwise as background shell processes; either way it stops them at the end. preview boot commands use mise exec -- only when mise is on PATH.

A component added to component_map.yml also needs fixtures in fixtures/<folder>/ (content.yml, shadcn.tsx, rubyui.rb).

Without Claude

Any agent or person can run the tooling directly:

cd audit && mise exec -- bundle install && mise exec -- bundle exec exe/shadcn-audit workspace

The full audit procedure is .claude/skills/shadcn-audit/SKILL.md and its references/; any agent can read it and follow it with this CLI. Reference rules are in gem/AGENTS.md. In Claude Code, run /shadcn-audit instead.