moodlehq / moodle-local_codechecker
一个Moodle本地插件,提供简单的Web UI来运行PHP_CodeSniffer的MoodleCS标准检查。
Requires
- php: >=7.4
- moodlehq/moodle-cs: ^v3.4.10
- phpcompatibility/php-compatibility: dev-develop#96072c30
README
信息
此Moodle插件使用PHP CodeSniffer工具来检查代码是否符合Moodle编码风格。它使用Moodle编码风格 'sniffs'来检查代码的许多方面,包括令人惊叹的PHPCompatibility。
它是由开放大学(Open University)的开发者创建的,包括Sam Marshall、Tim Hunt和Jenny Gray。现在由Moodle HQ维护。
可用的版本可以从https://moodle.org/plugins/view.php?plugin=local_codechecker下载和安装。
要使用git安装,请在您的Moodle安装根目录下输入此命令
git clone https://github.com/moodlehq/moodle-local_codechecker.git local/codechecker
然后将 /local/codechecker 添加到您的git忽略文件。
此外,请记住,仅使用位于 phpcs/bin/phpcs
的PHPCS版本,而不是直接安装PHPCS。将PHPCS可执行文件的位置添加到系统路径,使用phpcs --config-set installed_paths /path/to/moodle-local_codechecker
告诉PHPCS关于Moodle编码标准的信息,并使用phpcs --config-set default_standard moodle
设置默认编码标准为Moodle。现在您可以测试一个文件(或文件夹)了:phpcs /path/to/file.php
。
或者,从https://github.com/moodlehq/moodle-local_codechecker/zipball/main下载zip文件,将其解压到本地文件夹中,然后将新文件夹重命名为"codechecker"。
安装此本地插件后,您应该在设置块中看到新的选项
网站管理 -> 开发 -> 代码检查器
希望您觉得这个工具很有用。请随意改进它!您还可以通过GitHub的问题和拉取请求报告任何想法或错误,谢谢!
集成
从v4.0.0版本开始,此插件不应作为与IDE或工具集成的源,而应使用Moodle编码风格(moodle-cs标准的新的源)。
请参阅该存储库中提供的信息,了解有关如何安装、配置以及将其与您的开发环境集成的更多信息。