 |
VOOZH | about |
|
VOOZH | about |
This document details the code quality standards, linting tools, and enforcement mechanisms used in the BuddyPress VIP Go plugin. It covers the coding standards rulesets, configuration files, editor settings, and Composer scripts for running quality checks locally. For information about setting up the local development environment, see Local Development Setup. For details about the automated CI/CD pipeline that enforces these standards, see CI/CD Pipeline.
The plugin enforces multiple coding standards rulesets through PHP_CodeSniffer (PHPCS). These standards ensure code quality, security, and compatibility with WordPress VIP hosting infrastructure.
Sources: .phpcs.xml.dist1-39
The plugin's PHPCS configuration is defined in .phpcs.xml.dist at the repository root. This file configures all code style checks, exclusions, and scanning parameters.
| Standard | Purpose | Configuration Line |
|---|---|---|
WordPress-VIP-Go | VIP-specific security and performance rules | .phpcs.xml.dist5 |
WordPress-Extra | WordPress coding standards including WordPress-Core | .phpcs.xml.dist9 |
WordPress-Docs | Inline documentation requirements (PHPDoc blocks) | .phpcs.xml.dist10 |
PHPCompatibilityWP | PHP version compatibility validation | .phpcs.xml.dist23 |
Sources: .phpcs.xml.dist5-24
This setting configures PHPCS sniffs to ensure code is compatible with WordPress 6.6+. Sniffs will flag deprecated WordPress functions or APIs not available in this version.
Sources: .phpcs.xml.dist13
The PHPCompatibilityWP standard checks that code is compatible with PHP 8.1 and above. The trailing dash means "8.1 and all later versions."
Sources: .phpcs.xml.dist24
All translatable strings must use the buddypress-vip-go text domain. PHPCS validates that __(), _e(), _n(), and other i18n functions use this domain.
Sources: .phpcs.xml.dist15-21
| Parameter | Value | Purpose |
|---|---|---|
arg value="sp" | Show sniff codes and progress | Displays which sniff triggered each violation |
arg name="colors" | Enabled | Color-coded output for terminal |
arg name="basepath" | . | Strip file paths to relative paths |
arg name="parallel" | 8 | Use 8 parallel processes for faster scanning |
arg name="extensions" | php | Only scan PHP files |
Sources: .phpcs.xml.dist27-31
The following directories are excluded from code style checks:
node_modules/ - Third-party JavaScript dependenciesvendor/ - Third-party PHP dependencies installed via Composertests/ - Test files (may have intentional violations for testing purposes)Sources: .phpcs.xml.dist36-38
The .editorconfig file enforces consistent formatting across different editors and IDEs. This configuration is based on WordPress Core's EditorConfig.
Sources: .editorconfig1-26 composer.json47-48 .github/workflows/cs-lint.yml79-97
All files receive these settings:
| Setting | Value | Purpose |
|---|---|---|
charset | utf-8 | Consistent character encoding |
end_of_line | lf | Unix-style line endings (except .txt files) |
insert_final_newline | true | Ensures file ends with newline |
trim_trailing_whitespace | true | Removes trailing spaces (except .md files) |
indent_style | tab | Use tabs for indentation (WordPress standard) |
Sources: .editorconfig10-15
.yml)indent_style = space
indent_size = 2
YAML files use 2-space indentation instead of tabs to avoid parsing issues.
Sources: .editorconfig17-19
.md)trim_trailing_whitespace = false
Trailing whitespace is preserved in Markdown files as two trailing spaces create line breaks.
Sources: .editorconfig21-22
.txt)end_of_line = crlf
Text files use Windows-style line endings (CRLF) for maximum compatibility.
Sources: .editorconfig24-25
The plugin provides Composer scripts for running code quality checks during development. These scripts should be run before committing changes.
Sources: composer.json44-51
Runs parallel-lint to check all PHP files for syntax errors. This is faster than PHPCS and catches basic parse errors.
Command: @php ./vendor/php-parallel-lint/php-parallel-lint/parallel-lint . -e php --exclude vendor --exclude .git
Sources: composer.json50
Same as composer lint but outputs results in checkstyle format for CI/CD integration.
Command: @php ./vendor/php-parallel-lint/php-parallel-lint/parallel-lint . -e php --exclude vendor --exclude .git --checkstyle
Sources: composer.json51
Runs PHP_CodeSniffer against all PHP files using the standards defined in .phpcs.xml.dist. The -q flag suppresses progress output, showing only violations.
Command: @php ./vendor/bin/phpcs -q
Sources: composer.json47
Runs PHP Code Beautifier and Fixer (PHPCBF) to automatically fix code style violations where possible. Not all violations can be auto-fixed; some require manual intervention.
Command: @php ./vendor/bin/phpcbf -q
Sources: composer.json48
Sources: composer.json44-67 .github/workflows/cs-lint.yml1-98
The cs-lint.yml workflow runs automatically on pull requests and pushes to develop and trunk branches. It enforces code quality across multiple PHP versions.
The workflow tests against three PHP versions:
| PHP Version | Purpose | Failure Behavior |
|---|---|---|
8.2 | Current minimum supported version | Blocking (must pass) |
latest | Current stable PHP release | Blocking (must pass) |
8.5 | Upcoming PHP version (pre-release) | Non-blocking (continue-on-error: true) |
Sources: .github/workflows/cs-lint.yml39-44
Sources: .github/workflows/cs-lint.yml46-97
Installs the specified PHP version and the cs2pr tool (converts checkstyle XML to GitHub PR comments).
Sources: .github/workflows/cs-lint.yml47-52
Two problem matchers are registered to display violations inline in GitHub's file diff view:
These convert output from linting tools into GitHub annotations.
Ensures composer.json and composer.lock (if present) are valid and properly formatted.
Sources: .github/workflows/cs-lint.yml71-72
Runs parallel-lint to check for PHP syntax errors. Output is piped through cs2pr to display errors as PR annotations.
Sources: .github/workflows/cs-lint.yml80-81
Validates phpunit.xml.dist against PHPUnit's XML schema to catch configuration errors.
Sources: .github/workflows/cs-lint.yml85-89
Runs PHPCS and generates both a full report and a checkstyle XML report. The continue-on-error: true ensures the workflow continues even if violations are found, allowing the next step to display them as PR comments via cs2pr.
Sources: .github/workflows/cs-lint.yml92-97
Violation:
Fix:
All output must be escaped using appropriate WordPress functions (esc_html(), esc_attr(), esc_url(), etc.).
Violation:
Fix:
All translatable strings must use the buddypress-vip-go text domain.
Violation:
Fix:
Variable names must use snake_case, not camelCase.
Violation:
Fix:
File names should use lowercase with hyphens, not camelCase.
| Check | Tool | Trigger | Blocking |
|---|---|---|---|
| PHP Syntax | parallel-lint | CI on PR/push | Yes |
| Code Style | phpcs | CI on PR/push | Yes (PHP 8.2, latest) No (PHP 8.5) |
| XML Validation | xmllint | CI on PR/push | Yes |
| Composer Schema | composer validate | CI on PR/push | Yes |
| PHP Compatibility | PHPCompatibilityWP (via PHPCS) | CI on PR/push | Yes |
| WordPress Compatibility | WordPress-VIP-Go, WordPress-Extra | CI on PR/push | Yes |
| Documentation | WordPress-Docs | CI on PR/push | Yes |
| Text Domain | WordPress.WP.I18n | CI on PR/push | Yes |
Sources: .phpcs.xml.dist1-39 .github/workflows/cs-lint.yml31-97 composer.json44-67
Refresh this wiki