wp-jazz/coding-standards

The WordPress coding standards applied to all WP Jazz projects.

dev-main / 1.x-dev 2023-03-15 23:09 UTC

Requires

• humanmade/coding-standards: ^1.1
• humanmade/psalm-plugin-wordpress: dev-master
• phpstan/phpstan: ^1.10
• szepeviktor/phpstan-wordpress: ^1.1
• vimeo/psalm: ^4.30

MIT

• wordpress
• wp
• jazz

README

The WordPress coding standards applied to all WP Jazz projects.

Provides a set of rulesets and extensions for:

• EditorConfig — Maintain consistent coding styles between different editors.
• PHP_CodeSniffer — PHP coding linter.
• PHPStan — PHP static analysis tool.
• Psalm — PHP static analysis tool.

These coding standards are heavily based on, and extend, Human Made Coding Standards.

Installation

composer require --dev wp-jazz/coding-standards

This package will install supported versions of PHPCS, PHPStan, and Psalm.

See the examples directory for boilerplate configuration files.

Using PHPCS

Our PHPCS ruleset extends the Human Made coding standards for PHP and WordPress.

Run the following command to run the standards checks:

./vendor/bin/phpcs --standard=vendor/wp-jazz/coding-standards .

Or include the following in your phpcs.xml:

<!-- Use WP Jazz Coding Standards -->
<rule ref="Jazz" />

The PHPCS ruleset is based upon:

• Human Made Coding Standards
  • PHPCompatibilityWP
  • PSR-2-R
    • Spryker Code Sniffer
    • Slevomat Coding Standard
  • WordPress Coding Standards
  • WordPress VIP Coding Standards

With customisations, exclusions, and additions to match our style.

Using PHPStan

Run the following command to run the static analysis:

./vendor/bin/phpstan analyze -c vendor/szepeviktor/phpstan-wordpress/extension.neon .

Make PHPStan find it automatically using phpstan/extension-installer:

composer require --dev phpstan/extension-installer

Or manually include it in your phpstan.neon:

includes:
  - vendor/szepeviktor/phpstan-wordpress/extension.neon

See the szepeviktor/phpstan-wordpress package, by Viktor Szépe, for more information on configuring PHPStan.

Using Psalm

./vendor/bin/psalm -c vendor/wp-jazz/coding-standards/psalm.xml.dist .

Use Psalm to enable the plugin:

./vendor/bin/psalm-plugin enable humanmade/psalm-plugin-wordpress

Or manually include it in your psalm.xml:

<plugins>
  <pluginClass class="PsalmWordPress\Plugin" />
</plugins>

See the humanmade/psalm-plugin-wordpress package, by Human Made, for more information on configuring Psalm.

Using ESLint

We recommend using the Human Made coding standards for JavaScript which uses ESLint.

npx install-peerdeps --dev @humanmade/eslint-config@latest

See the @humanmade/eslint-config package README for more information on configuring ESLint.

Using Stylelint

We recommend using the Human Made coding standards for CSS and SCSS which uses Stylelint.

npm install --save-dev stylelint @humanmade/stylelint-config

See the @humanmade/stylelint package README for more information on configuring Stylelint.