newsuk/nuk-wp-phpstan-config

PHPStan configuration for WordPress VIP plugins and themes

v0.1.0 2024-01-15 13:30 UTC

Requires

• php: >=7.4
• phpstan/extension-installer: ^1.3
• phpstan/phpstan-deprecation-rules: ^1.1
• phpstan/phpstan-strict-rules: ^1.5
• swissspidy/phpstan-no-private: ^0.2.0
• szepeviktor/phpstan-wordpress: ^1.3

MIT

• Content Platforms

README

NUK WP PHPStan config

This library contains PHPStan configuration for NewsUK plugins and themes.

Installation

Composer install:

composer require --dev newsuk/nuk-wp-phpstan-config

Using the ruleset

Create a phpstan.neon.dist file in the root of your project and add the below config. Feel free to alter the paths based on your project requirements

parameters:
    level: max
    paths:
        # adjust the filename / directory name according to project needs.
        - plugin.php
        - includes/

Composer scripts

Add the following to scripts section in composer.json file and run composer phpstan

"phpstan": "phpstan analyse --memory-limit=2048M"

Add the following to generate baseline file for existing plugins and run composer phpstan-baseline

"phpstan-baseline": "phpstan analyse -b --allow-empty-baseline"