自动代码审查

admin 提交于 周三, 06/07/2023 - 15:21

代码审查

Drupal 有一系列代码规范,见官网文档。 信息量巨大,很难人为地一条条把它们记住,但必须要遵守代码规范, 否则项目必会乱到无法维护。

于是开源社区中产生了大量的代码审查工具,帮助开发人员遵守并审查各类代码。

Drupal 使用以下工具来实现代码审查:

PHP 代码审查

PHP_CodeSniffer 代码规范审查

尽管 PHP_CodeSniffer 提供了完善的功能,以及常见的规范支持, 但 Drupal 的 PHP 代码有自己的一套规范, 所以有了 drupal/coder , 它是一个 PHP_CodeSniffer 规范扩展包, 定义了 Drupal 自己的一套代码规范支持。

如果开发者添加 drupal/core-dev 依赖,drupal/coder 会被包含在间接依赖中而被安装。

drupal/coder/README.md 文件说明了 drupal/coder 的使用方法。 简单地安装 dealerdirect/phpcodesniffer-composer-installer composer 插件, 可以自动注册 drupal/coder 规范扩展包到 PHP_CodeSniffer