bernskioldmedia/bm-wp-devtools

Development tools that we use for our WordPress projects.

dev-main 2021-11-25 20:58 UTC

Requires

• php: ^7.4|^8.0

Requires (Dev)

• dealerdirect/phpcodesniffer-composer-installer: ^0.7.1
• friendsofphp/php-cs-fixer: ^3.0
• phpcompatibility/phpcompatibility-wp: ^2.1
• phpstan/phpstan: ^0.12.99
• squizlabs/php_codesniffer: ^3.6
• symfony/var-dumper: ^5.2.5
• szepeviktor/phpstan-wordpress: ^0.7.7
• thecodingmachine/phpstan-strict-rules: ^0.12.1
• wp-coding-standards/wpcs: ^2.3

MIT

• Erik Bernskiold

• framework
• php
• testing
• test
• wordpress

README

These are a set of development tools that we use for WordPress development in our plugins and themes.

The tools consists of:

• PHPStan and WordPress rules
• PHPCS ruleset
• PHPCS Fixer

Installation

To use this in your project, require this package as a composer dev-dependency:

composer require bernskioldmedia/bm-wp-devtools --dev

Add the following scripts to your composer.json:

{
  "scripts": {
	"lint": "php-cs-fixer fix -v",
	"test:cs": "phpcs-wp",
	"test:types": "phpstan analyse --ansi --memory-limit=-1",
	"test:lint": "php-cs-fixer fix -v --dry-run",
	"test": [
	  "@test:lint",
	  "@test:types"
	]
  }
}

Configure PHP Storm

PHPCS Inspections

1. go to Project Settings > PHP > Code Sniffer and set your phpcs executable. You should use installed in bin-dir.
2. go to Project Settings > Inspections > PHP > PHP Code Sniffer validation and set Custom coding standard.
3. use path selection ("...") to find the ruleset at vendor/bernskioldmedia/bm-wp-devtools/phpcs/ruleset.xml