moderntribe/static-analysis

Modern Tribe static analysis using PHPStan

dev-main 2022-04-06 23:45 UTC

Requires

• cweagans/composer-patches: ^1.7
• php-stubs/acf-pro-stubs: ^5.12
• php-stubs/wordpress-tests-stubs: ^5.8
• phpstan/extension-installer: ^1.1
• phpstan/phpstan: ^1.5
• szepeviktor/phpstan-wordpress: ^1.0

GPL-3.0-or-later

README

Install

Composer v2:

composer require --dev moderntribe/static-analysis

Composer v1:

Add to the repositories object:

    {
      "type": "vcs",
      "url": "[e-mail]:moderntribe/static-analysis.git"
    }

And require-dev:

  "moderntribe/static-analysis": "^0.0"

Usage

To run static analysis on your project, create phpstan.neon.dist file in your project root with the following content:

parameters:
	level: 2
	paths:
		- wp-content/themes/core/
		- wp-content/plugins/core/
		- wp-content/mu-plugins/
	excludePaths:
		- vendor
	bootstrapFiles:
		- vendor/php-stubs/wordpress-stubs/wordpress-stubs.php
		- vendor/php-stubs/acf-pro-stubs/acf-pro-stubs.php
	tmpDir: .phpstan-cache/
	ignoreErrors:
		- '#^Function yoast_get_primary_term_id not found.$#'

	checkAlwaysTrueStrictComparison: true

	# Unfortunately, DocBlocks can't be relied upon in WordPress.
	treatPhpDocTypesAsCertain: false

To run phpstan on your project, run phpstan analyse --configuration=phpstan.neon.dist from your project root.

Update your project's .gitignore

/.phpstan-cache
/phpstan.neon