samikeijonen/phpcs-composer

Custom PHPCS ruleset.

dev-main 2021-09-14 06:39 UTC

Requires

• php: >=5.6
• dealerdirect/phpcodesniffer-composer-installer: *
• phpcompatibility/phpcompatibility-wp: ^2
• wp-coding-standards/wpcs: *

GPL-2.0-or-later

• Sami Keijonen

• wordpress
• standards
• phpcs

README

This is a standalone composer package for Custom WPCS ruleset.

Requirements

• PHP 5.6+ (preferably 7+).
• Composer for managing PHP dependencies.

Installation

Open your command line tool and change directories to your WordPress theme folder.

cd path/to/wp-content/themes/<your-theme-name>

Then, use Composer to install the package.

composer require --dev samikeijonen/phpcs-composer:dev-master

Usage

Lint your PHP files with the following command:

./vendor/bin/phpcs . --standard=Foxland-Default

Or you can set default (Foxland-Default) coding standard in composer.json file:

"scripts": {
	"install-codestandards": "\"vendor/bin/phpcs\" --config-set default_standard Foxland-Default",
	"post-install-cmd": "@install-codestandards",
	"post-update-cmd" : "@install-codestandards"
}

Then you can lint with the following command:

./vendor/bin/phpcs .