Skip to content

WP-Desk/phpstan-rules

Repository files navigation

Common PHPStan configuration for WP Desk

Shared PHPStan configuration for WordPress/WooCommerce projects.

Includes:

  • PHPStan WordPress extension
  • WooCommerce stubs
  • PHPStan deprecation rules
  • selected PHPStan strict rules
  • default analysis level 5
  • default path src

Installation

composer require --dev wpdesk/phpstan-rules

If Composer asks about phpstan/extension-installer, allow it.

Usage

Run PHPStan:

vendor/bin/phpstan analyse

To override defaults, add phpstan.neon in your project:

includes:
  - vendor/wpdesk/phpstan-rules/rules.neon

parameters:
  paths:
    - src
    - tests

Plugin dependency stubs

When analysing a plugin that depends on another plugin, generate stubs for the dependency:

composer global require php-stubs/generator
generate-stubs --out=.stubs/dependency.stub -- /path/to/dependency/src

Then include them:

parameters:
  scanFiles:
    - .stubs/dependency.stub

About

Shared PHPStan configuration package for WordPress and WooCommerce projects. Includes common extensions, stubs, and default rules used by WP Desk projects.

Resources

License

Contributing

Stars

Watchers

Forks

Packages

 
 
 

Contributors