Current File : /www/varak.net/wiki.varak.net/vendor/mediawiki/mediawiki-codesniffer/README.md
MediaWiki coding conventions
============================
Abstract
--------
This project implements a set of rules for use with [PHP CodeSniffer][0].
See [MediaWiki conventions][1] 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": "0.7.2"
},
"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="extensions" value="php,php5,inc"/>
<arg name="encoding" value="utf8"/>
<exclude-pattern>vendor</exclude-pattern>
</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][2] for more details.
TODO
----
* Migrate the old code-utils/check-vars.php
---
[0]: https://pear.php.net/package/PHP_CodeSniffer
[1]: https://www.mediawiki.org/wiki/Manual:Coding_conventions/PHP
[2]: https://www.mediawiki.org/wiki/Continuous_integration/Entry_points#PHP
Mini Shell