code-quality
Provides WordPress coding standards, PHP/CSS/JS style guide, code linting and static analysis (phpcs, phpstan, rector, phpcbf). Use before writing or editing PHP, CSS, or JavaScript code, when fixing lint errors, running code quality tools, or reviewing code style compliance.
When & Why to Use This Skill
This Claude skill serves as a comprehensive quality assurance assistant for WordPress development, specifically tailored for the Simple History plugin. It enforces strict coding standards across PHP, CSS, and JavaScript by integrating industry-standard tools like PHPCS, PHPStan, and Rector. By providing real-time guidance on style compliance, static analysis, and architectural principles like DRY and YAGNI, it ensures that every line of code is secure, maintainable, and aligned with the 'WordPress Way'.
Use Cases
- 1. Pre-Commit Code Auditing: Use the skill to run static analysis and linting checks before submitting code to ensure it meets WordPress coding standards and project-specific requirements.
- 2. Automated Style Correction: Quickly identify and fix formatting issues in CSS (SuitCSS) and JavaScript, ensuring consistent naming conventions and structural patterns across the codebase.
- 3. Technical Debt Reduction: Leverage Rector and PHPStan integration to modernize legacy PHP code, identify potential bugs through static analysis, and refactor logic for better performance.
- 4. Security Compliance: Ensure all output is correctly escaped and that WordPress-specific best practices are followed to prevent common vulnerabilities in plugin development.
- 5. Architectural Guidance: Consult the skill to apply DRY (Don't Repeat Yourself) and YAGNI (You Aren't Gonna Need It) principles effectively during the design and implementation phases.
| name | code-quality |
|---|---|
| description | Provides WordPress coding standards, PHP/CSS/JS style guide, code linting and static analysis (phpcs, phpstan, rector, phpcbf). Use before writing or editing PHP, CSS, or JavaScript code, when fixing lint errors, running code quality tools, or reviewing code style compliance. |
Code Quality Standards for Simple History
This skill provides code quality guidelines for the Simple History WordPress plugin, including PHP, CSS, and JavaScript standards, tooling commands, and best practices.
When to Use This Skill
Invoke this skill proactively before writing code to ensure compliance with project standards.
Trigger scenarios:
- Before writing or editing PHP code
- Before writing or editing CSS code
- Before writing or editing JavaScript code
- When running code quality tools (phpcs, phpstan, rector)
- When fixing lint errors or reviewing code style
Quick Reference
PHP Standards
- PHP Version: 7.4+ compatibility required
- WordPress Coding Standards: Official WordPress standards (see phpcs.xml.dist)
- No mb_ functions*: Use standard string functions
- Array syntax: Short syntax
[]notarray() - Control structures: Always use curly braces
{}, never colon syntax - Hook prefixes: Always use
sh,simplehistory, orsimple_history
CSS Standards
- Naming Convention: SuitCSS
- Prefix:
sh - Components:
sh-ComponentName(e.g.,sh-HelpSection,sh-LogEntry) - Subparts:
sh-ComponentName-subpart(e.g.,sh-LogEntry-author)
JavaScript
- Follow @wordpress/scripts conventions
- Text domain:
simple-history - Always use braces for if/else/for/while (no single-line statements)
Detailed Guidelines
PHP Code Style
See php-standards.md for detailed PHP style guide including:
- Happy path last pattern
- Early returns over else
- Ternary operator formatting
- Control structure syntax
Tooling Commands
See tooling.md for:
- phpcs (PHP_CodeSniffer) usage
- phpstan (static analysis) usage
- rector (code modernization) usage
- npm scripts for code quality
CSS Guidelines
See css-standards.md for SuitCSS naming conventions and examples.
JavaScript Guidelines
See js-standards.md for JavaScript code style.
Essential Principles
- Always escape output - Use WordPress escaping functions
- Prefix everything - Use
sh,simplehistory, orsimple_history - Follow WordPress conventions - The "WordPress Way"
- Run quality tools - Use phpcs, phpstan after significant changes
Design Principles
DRY - Don't Repeat Yourself
Extract shared logic when you have actual duplication (3+ occurrences). But don't preemptively create abstractions.
YAGNI - You Aren't Gonna Need It
Don't implement functionality until it's actually needed. Avoid:
- Creating abstractions for hypothetical future use cases
- Building helper functions for one-time operations
- Adding configurability "just in case"
- Designing for requirements that don't exist yet
Together: DRY says extract when you have real duplication. YAGNI says wait until you actually need it. Three similar lines of code is often better than a premature abstraction.
Related Files
phpcs.xml.dist- PHP_CodeSniffer configurationphpstan.neon- PHPStan configurationpackage.json- npm scripts for code quality