nextpress/nextpresscs

NextPress Coding Standards

dev-master 2022-01-13 19:28 UTC

Requires

• php: >=5.6
• dealerdirect/phpcodesniffer-composer-installer: ^0.5.0|^0.7.1
• squizlabs/php_codesniffer: ^3.3.1
• wp-coding-standards/wpcs: ^2.0.0

MIT

• Arindo Duque

README

The goal of this repo is to provide the necessary sniffs for our custom coding standards, making sure that all NextPress products maintain a consistent codebase.

Installation

Our coding standards rely on PHPCS and WordPress Coding Standards. The easiest way to get everything up and running is installing this package globally via Composer:

composer global require "nextpress/nextpresscs:dev-master"

This command will install PHP_CodeSniffer, WPCS, our coding standard, and PHP_CodeSniffer Standards Composer Installer, a composer package that automatically sets the PHPCS installed_paths config.

Making phpcs available

By default, phpcs binary will be available at ~/.config/composer/vendor/bin (on Linux machines). To make it available anywhere in the command line, it is necessary to add that folder to the env $PATH variable.

On linux machines it is possible adding this line in the end of the ~/.bashrc file:

export PATH="$HOME/.config/composer/vendor/bin/:$PATH"

Changelog

Version 0.0.3 - 27/08/2020

Version 0.0.2

• Changed: Global install via composer with PHP_CodeSniffer Standards Composer Installer;

Version 0.0.1

• Added: Initial version of the Coding Standards;