README

This library contains PHPStan configuration for WordPress plugins and themes.

Minimal requirements

• PHP 8.2

Development setup

To build the package

PHP setup

• composer install

Installation

Composer install:

composer require --dev m0hanraj/phpstan-config

Usage

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/

Usage with Composer

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"

Tagging and releasing

The content schema uses Semantic Versioning semver for versioning. The package is released using GitHub Releases. To create a new release, follow these steps:

• Update the relevant files with the new version. Commit the updated files.
• Push the changes to the main branch, by merging the associated pull request
• Create a release targeting the main branch within GitHub.