mediawiki/mediawiki-codesniffer

MediaWiki CodeSniffer Standards

Maintainers

Details

github.com/wikimedia/mediawiki-tools-codesniffer

Installs: 542 468

Dependents: 164

v31.0.0 2020-05-26 19:06 UTC

Requires

Requires (Dev)

jakub-onderka/php-console-highlighter: 0.4.0
jakub-onderka/php-parallel-lint: 1.0.0
mediawiki/mediawiki-phan-config: 0.10.2
mediawiki/minus-x: 1.0.0
phpunit/phpunit: ^8.5

Suggests

None

Provides

None

Conflicts

None

Replaces

None

GPL-2.0-or-later 130de29d06bf012f9e0217c28e2afbfaf0a80a20

codesniffer mediawiki

This package is auto-updated.

Last update: 2020-08-11 07:43:11 UTC

README

Abstract

This project implements a set of rules for use with PHP CodeSniffer.

See MediaWiki conventions on our wiki for a detailed description of the coding conventions that are validated by these rules. :-)

How to install

Create a composer.json which adds this project as a dependency:

{
	"require-dev": {
		"mediawiki/mediawiki-codesniffer": "31.0.0"
	},
	"scripts": {
		"test": [
			"phpcs -p -s"
		],
		"fix": "phpcbf"
	}
}

Create a .phpcs.xml with our configuration:

<?xml version="1.0"?>
<ruleset>
	<rule ref="./vendor/mediawiki/mediawiki-codesniffer/MediaWiki"/>
	<file>.</file>
	<arg name="bootstrap" value="./vendor/mediawiki/mediawiki-codesniffer/utils/bootstrap-ci.php"/>
	<arg name="extensions" value="php,php5,inc"/>
	<arg name="encoding" value="UTF-8"/>
</ruleset>

Install: composer update
Run: composer test
Run: composer fix to auto-fix some of the errors, others might need manual intervention.
Commit!

Note that for most MediaWiki projects, we'd also recommend adding a PHP linter to your composer.json – see the full documentation for more details.

TODO

Migrate the old code-utils/check-vars.php