shipit-frontend-audit
v1.0.0
Published
Release-readiness checks for frontend projects before they go live
Maintainers
Readme
ShipIt Frontend Audit
Release-readiness checks for frontend projects before they go live.
ShipIt reviews the project, runs its production build, and reports the work that still needs attention. Each finding explains what was detected, where to look, and how to fix it.
Install
Run it without installing:
npx shipit-frontend-audit audit .Or install it globally:
npm install --global shipit-frontend-audit
shipit-frontend-audit audit .Usage
Audit the current directory:
shipit-frontend-audit audit .Audit another project:
shipit-frontend-audit audit ../my-websiteShow the installed version:
shipit-frontend-audit --versionWhat It Checks
- Build: package metadata, build scripts, dependency installation, TypeScript, build success, output files, and framework detection
- Environment: environment files, ignored secrets, localhost URLs, and documented environment variables
- SEO: titles, descriptions, viewport, canonical URLs, Open Graph, Twitter cards, language, favicon, robots, and sitemap files
- Accessibility: image alternatives, button names, form labels, interactive elements, and duplicate IDs
- Performance: large images, JavaScript bundles, CSS files, fonts, and production source maps
- Security: likely secrets, unsafe HTML injection, insecure URLs, and npm dependency vulnerabilities
- Production hygiene: console logs, debugger statements, placeholders, TODO markers, documentation, licensing, and unused dependencies
Understanding The Report
The report starts with an overall status, then groups findings by category.
- READY: no errors or warnings were found
- READY WITH WARNINGS: no blocking errors were found, but review is recommended
- NOT READY: at least one blocking error needs to be fixed
Every finding includes:
- What: the issue ShipIt detected
- Where: the file, directory, or configuration area to inspect
- Fix: the recommended next action
ShipIt exits with status 1 when errors are found, making it suitable for CI and deployment checks.
Development
npm install
npm run dev -- audit .
npm run build
npm start -- audit .Static checks are intentionally conservative. Use browser testing, Lighthouse, axe, and your deployment platform's security tools for deeper validation.
License
ISC
