m0hanraj/phpcs-config

PHPCS configuration for WordPress VIP plugins and themes

v0.2.1 2025-09-04 09:22 UTC

Requires

• automattic/vipwpcs: ^3.0
• dealerdirect/phpcodesniffer-composer-installer: ^1.0
• ergebnis/composer-normalize: ^2.42
• fig-r/psr2r-sniffer: ^2.1.2
• phpcompatibility/phpcompatibility-wp: ^2.1
• slevomat/coding-standard: ^8.14
• wp-coding-standards/wpcs: ^3.1

MIT

• Mohanraj

README

This library contains WordPress VIP PHPCS configuration.

Architecture

Project Structure

- .circleci          # CircleCI pipeline configuration files
- .github            # GitHub configuration files
- WPDev             # WPDev phpcs rulesets

Technical Documentation

• Package Extensibility

Contribution

More details on how to contribute to this package can be found in the CONTRIBUTING.md file.

Minimal requirements

• PHP 8.2
• WordPress 6.2

Development setup

To build the package

PHP setup

• composer install

Installation

Composer install:

composer require --dev m0hanraj/phpcs-config

Usage

Using the ruleset

Create a phpcs.xml.dist file in your project and add the following to use WPDev ruleset:

<?xml version="1.0"?>
<ruleset name="WPDev WP PHPCS Rules">
	<rule ref="WPDev"/>
</ruleset>

Usage with Composer

Add the following to scripts section in composer.json file to run linting.

"lint": "phpcs .",
"lint:fix": "phpcbf .",

Tagging and releasing

The content schema uses Semantic Versioning semver for versioning. The package is released using GitHub Releases. The release process is automated in Circle CI build step. 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.