mediawiki/mediawiki-codesniffer

MediaWiki CodeSniffer Standards

Maintainers

Details

github.com/wikimedia/mediawiki-tools-codesniffer

Homepage

Source

Installs: 711 486

Dependents: 200

Suggesters: 0

Security: 0

Stars: 29

Watchers: 12

Forks: 10

Type:phpcodesniffer-standard

v35.0.0 2021-01-28 20:56 UTC

Requires

Requires (Dev)

GPL-2.0-or-later c305fa16998d742705f9b59358fbb816f524cf9f

codesniffermediawiki

This package is auto-updated.

Last update: 2021-04-11 20:35: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

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

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

  2. 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"/>
	<arg name="encoding" value="UTF-8"/>
</ruleset>

  3. Install: composer update

  4. Run: composer test

  5. Run: composer fix to auto-fix some of the errors, others might need manual intervention.

  6. 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