wordpress-qc-skill
v0.1.0
Published
Holistic WordPress brief and staging-site QC with simple-English Google Docs reports.
Maintainers
Readme
wordpress-qc-skill
A public, installable WordPress QC skill for checking a staging site against an English client brief and producing a simple-English report.
Install as an agent skill
This package includes the standard SKILL.md entrypoint used by agent skill loaders. Install it with npm, then point Claude, Codex, or another compatible agent at the installed package directory:
npm install wordpress-qc-skillThe package directory contains SKILL.md, README.md, and the runnable QC command. For a global CLI install, use:
npm install --global wordpress-qc-skillRun it
npx wordpress-qc-skillThe interactive runner asks for:
- Public staging URL
- Brief Google Docs URL, pasted brief, or local brief file
- Optional previous QC report
- Optional Google report recipients
For automation:
npx wordpress-qc-skill \
--staging-url https://staging.example.com \
--brief-file ./brief.txt \
--previous-report ./previous-qc.md \
--browser-adapter ./browser-adapter.mjs \
--non-interactive --yesBrowser adapter
The package deliberately does not bundle a browser or silently download Chromium. The inbuilt browser or an external browser MCP is supplied by the host through a small adapter module:
export async function inspect({ stagingUrl, criteria, viewports, runId, approvals }) {
// Use the host's inbuilt browser or external browser MCP here.
// Return one result for each criterion.
return {
criteria: criteria.map((criterion) => ({
id: criterion.id,
status: "Pass", // Pass | Fail | Blocked | Not applicable
expected: criterion.text,
found: "...",
fix: "...",
howToVerify: "...",
evidence: [{ label: "Mobile screenshot", path: "..." }],
})),
};
}Point the runner at the adapter with either:
npx wordpress-qc-skill --browser-adapter ./browser-adapter.mjsor:
export WORDPRESS_QC_BROWSER_ADAPTER=./browser-adapter.mjsThe adapter receives these standard viewports:
- Desktop: 1440 × 900
- Tablet: 768 × 1024
- Mobile: 390 × 844
Form submissions and external-link testing are only approved when the corresponding flags are present:
--approve-form-tests --approve-external-linksGoogle Docs
Set GOOGLE_ACCESS_TOKEN for Google Docs input and report publishing. The token must have suitable Docs and Drive scopes. Reports are private by default; recipients are shared only when explicitly supplied with --report-recipient.
If Google Docs publishing fails, the runner keeps a local Markdown fallback under .scratch/wordpress-qc-skill/runs/.
Safety
The runner is read-only by default. It never edits WordPress, uses admin credentials, submits forms, sends messages, places orders, uploads files, or enters real personal/payment data. Public npm distribution does not publish client briefs, staging screenshots, OAuth tokens, or reports.
Development
npm test
node --test