spip/coding-standards

SPIP Coding Standards

1.3.4 2024-09-29 16:45 UTC

Requires

• php: >=7.0
• ext-mbstring: *
• phpcompatibility/php-compatibility: dev-develop
• squizlabs/php_codesniffer: ^3.8

Requires (Dev)

• phpunit/phpunit: ^9.6

Suggests

• dealerdirect/phpcodesniffer-composer-installer: ^1.0 || This Composer plugin will sort out the PHPCS 'installed_paths' automatically.

MIT

• JamesRezo

• phpcs
• dev
• spip

README

This is a set of rules for PHP CodeSniffer that checks for SPIP Coding Standard and PHP Compatibility for SPIP v4.0+.

Installation

composer require --dev dealerdirect/phpcodesniffer-composer-installer spip/coding-standards

Usage

vendor/bin/phpcs --standard=SCS1 /path/to/file

or create a phpcs.xml file containing this:

<?xml version="1.0"?>
<ruleset>
    <file>/path/to/file</file>
    <rule ref="SCS1" />
</ruleset>

and run :

vendor/bin/phpcs