auditing-project
Audits the project for consistency issues that may arise from manual editing. Checks package scripts, tsconfig paths, README tables, and other conventions.
When & Why to Use This Skill
The Auditing Project skill is a specialized developer utility designed to maintain codebase integrity by identifying inconsistencies in project configuration and documentation. It automatically validates package scripts, TypeScript configuration paths, and README tables against established project conventions, ensuring that manual edits do not introduce configuration drift or synchronization errors.
Use Cases
- Post-Manual Configuration Updates: Automatically detect naming mismatches or path errors after manually editing package.json or tsconfig.json files.
- Pre-Commit Integrity Checks: Use as a local quality gate to ensure all project metadata and scripts are synchronized before pushing changes to a shared repository.
- CI/CD Pipeline Integration: Incorporate the audit scripts into automated workflows to enforce project consistency standards and fail builds if conventions are violated.
- Documentation Alignment: Verify that README tables and other manual documentation stay in sync with the actual project scripts and structure, preventing outdated information.
| name | auditing-project |
|---|---|
| description | Audits the project for consistency issues that may arise from manual editing. Checks package scripts, tsconfig paths, README tables, and other conventions. |
Auditing Project
Check for inconsistencies that may have been introduced by manual editing.
Steps
Run each audit script with --check flag:
- Package scripts:
.claude/skills/authoring-global-scripts/scripts/sync-package-scripts.ts --check - TSConfig paths:
.claude/skills/syncing-tsconfig-paths/scripts/sync-tsconfig-paths.ts --check
If issues are found, run the corresponding skill to fix them.
Reference
What Gets Checked
| Check | Detects |
|---|---|
| Package scripts | Scripts out of sync with _:* template, extra scripts |
| TSConfig paths | Paths not matching package.json imports |
When to Use
- After manual editing of package.json, tsconfig.json
- Before committing changes
- When something "feels wrong" after out-of-band edits
- CI verification (all checks should pass)
Notes
- Each audit exits non-zero if issues found
- Prefer running audits over blindly syncing - understand what changed
- If audit finds issues, the corresponding sync skill will fix them