README

信息

此存储库包含 Moodle 编码风格配置，以 PHP CodeSniffer 规则集的形式编写。

包含两种编码风格

目前这仅包括 PHP 编码风格的配置，但可能扩展到包括 JavaScript 和其他受支持的语言或语法规则的定制规则。

您可以使用 Composer 安装这些编码风格规则，使它们在整个系统中可用。

这将安装带有 Moodle 规则及其依赖项的正确版本的 phpcs。

composer global config minimum-stability dev
composer global require moodlehq/moodle-cs

通常不需要配置。Moodle 的最新版本（3.11 及以上）包括 PHP CodeSniffer 的配置文件，当在 Moodle 目录中运行时将设置标准。

可以自动生成额外的配置，以使 PHP CodeSniffer 忽略任何第三方库代码。可以通过运行以下命令生成：

npx grunt ignorefiles

配置 PHP CodeSniffer 以使用 moodle-extra 编码风格的方法是提供一个额外的配置文件。

对于 Moodle 3.11 及以上版本，您可以创建一个名为 .phpcs.xml 的文件，内容如下

<?xml version="1.0" encoding="UTF-8"?>
<ruleset name="MoodleCore">
  <rule ref="./phpcs.xml"/>
  <rule ref="moodle-extra"/>
</ruleset>

这将在 phpcs.xml 文件（由 npx grunt ignorefiles 生成）中加载，并应用 moodle-extra 配置。

要使 PHP CodeSniffer 采用您首选的风格，您可以创建一个包含以下内容的 phpcs.xml 文件

<?xml version="1.0" encoding="UTF-8"?>
<ruleset name="MoodleCore">
  <rule ref="moodle"/>
</ruleset>

如果您希望使用 moodle-extra 编码风格，则可以使用以下内容

<?xml version="1.0" encoding="UTF-8"?>
<ruleset name="MoodleCore">
  <rule ref="moodle-extra"/>
</ruleset>

注意：在这些版本的 Moodle 中，将不会忽略第三方库代码。