自述文件

摘要

此项目实现一组用于的规则PHP代码嗅探器.

请参见MediaWiki约定在我们的wiki上获取有关通过这些规则验证的编码约定。：-）

如何安装

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

   {“require-dev”：{“mediawiki/mediawiki-codesniffer”：“40.0.1”},“脚本”：{“测试”：[“phpcs-p-s”],“修复”：“phpcbf”}}

2. 使用我们的配置创建.phpcs.xml：

   <？xml版本=“1.0”？><规则集><rule ref=“./vendor/mediawiki/mediaawiki-codesniffer/mediawiki”/><文件></文件><arg name=“bootstrap”value=“./vendor/mediawiki/mediawiki-codesiffer/utils/bootstrap-ci.php”/><arg name=“extensions”value=“php”/><arg name=“encoding”value=“UTF-8”/></ruleset>

3. 安装：作曲家更新

4. 运行：作曲家测试

5. 运行：作曲家修复要自动修复某些错误，其他错误可能需要手动干预。

6. 提交！

注意，对于大多数MediaWiki项目，我们还建议添加PHP linter到您的作曲家.json–请参阅完整文档了解更多详细信息。

配置

此代码嗅探器标准提供的一些嗅探允许您配置其工作方式的详细信息。

• MediaWiki。课程。完全限定类名：此嗅探在默认情况下被禁用。

  <rule ref=“MediaWiki.Classes.FullQualifiedClassName”><严重程度>5<属性><property name=“allowMainNamespace”value=“false”/><property name=“allowInheritance”value=“false”/><property name=“allowFunctions”value=“false”/></属性></rule（规则）>

• MediaWiki。用法。扩展类使用：此嗅探允许您排除嗅探报告的全局消息，以防它们不能用Config:：getConfig（）调用替换。列表中已有的示例包括$wg标题和$wg用户.

  <rule ref=“MediaWiki.Usage.ExtendClassUsage”><属性><property name=“nonConfigGlobals[]”type=“array”value=“$wg…，$wg..”/></属性></rule（规则）>

• MediaWiki。评论。ClassLevel许可证：默认情况下，此嗅探不执行任何操作。

  <rule ref=“MediaWiki.Commenting.ClassLevelLicense”><属性><property name=“license”value=“GPL-2.0-or-later”/></属性></rule（规则）>

• MediaWiki。命名约定。前缀GlobalFunctions：此嗅探允许您定义被忽略全局变量的列表函数和允许的前缀列表。默认情况下，唯一允许的前缀是“wf”，对应到全局函数wf…（）.

  <rule ref=“MediaWiki.NamingConventions.PrefixedGlobalFunctions”><属性><property name=“allowedPrefixes[]”value=“wf，…”/><property name=“ignoreList[]”value=“…，…”/></属性></rule（规则）>

• MediaWiki。命名约定。有效全局名称：此嗅探允许您定义忽略全局变量的列表和允许的列表前缀。默认情况下，对于全局变量，唯一允许的前缀是“wg”$wg。。。.

  <rule ref=“MediaWiki.NamingConventions.ValidGlobalName”><属性><property name=“allowedPrefixes[]”value=“wg，…”/><property name=“ignoreList[]”value=“…，…”/></属性></rule（规则）>

• 媒体维基。阵列。尾随逗号：此嗅探允许您强制多行数组具有尾随逗号，这使得Git-diff更好。它还可以强制单行数组没有尾随逗号。默认情况下，它什么也不做。

  <rule ref=“MediaWiki.Arrays.TrailingComma”><属性><property name=“singleLine”value=“false”/><property name=“multiLine”value=“true”/></属性></rule（规则）>