README

摘要

本项目实现了一套与 [PHP CodeSniffer](https://packagist.org.cn/packages/squizlabs/php_codesniffer) 一起使用的规则。

HydraWiki 基于 MediaWiki 的编码规范，在其基础上增加了额外的编码规范。

有关这些规则验证的编码规范的详细描述，请参阅 MediaWiki 的 编码规范。

如何安装

1. 创建一个 composer.json 文件，将此项目作为依赖项添加

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

2. 创建一个 .phpcs.xml 文件，使用我们的配置

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

3. 安装: composer update
4. 运行: composer test
5. 运行: composer fix 以自动修复一些错误，其他错误可能需要手动干预。
6. 提交！

注意，对于大多数 MediaWiki 项目，MediaWiki 还建议在 composer.json 中添加 PHP 代码检查器 – 更多详细信息请参阅 完整文档。

鸣谢

此扩展基于 MediaWiki 创建的 mediawiki-codesniffer 扩展和一些 [PHP CodeSniffer](https://packagist.org.cn/packages/squizlabs/php_codesniffer) 的部分。

贡献和许可

此编码规范在 HydraWiki 项目内部使用，以支持 Gamepedia 平台。为了方便我们团队使用，该项目被公开，我们无意将其作为替代 原始项目 的公共用途进行维护。然而，如果您发现它很有用并希望对其做出改进，任何合并请求都将根据我们对该项目的内部需求进行考虑，然后再进行公开考虑。

该项目在 MIT 许可证 下可用，除非文件中另有说明。这些文件保留其创建时的原始许可证。