README

代码风格指南

Thunder 代码风格指南与 Drupal 代码风格一致。对于文件的通用验证使用 Drupal Coder。更详细的 JavaScript 代码验证通过使用预定义的 Drupal 设置 的 ESLint 进行。

Drupal Coder

为了使 Drupal Coder 运作，应执行以下步骤。

1. 安装 Composer (* 如果系统上已存在 composer，则可以跳过此步骤)

• 请遵循官方页面上的 指南

1. 在全局 Composer 目录中安装 Drupal/Coder

• 请遵循 Packagist 上的 安装指南

命令行使用

# check Code for Drupal coding standards
phpcs --standard=Drupal --extensions=php,module,inc,install,test,profile,theme '--ignore=*.md' -p <project root directory>

# autocorrect code for Drupal coding standards
phpcbf --standard=Drupal --extensions=php,module,inc,install,test,profile,theme '--ignore=*.md' <project root directory>

此外，这两个命令都可以使用选项 --standard=DrupalPractice 与检查定义的 Drupal 最佳实践。

ESLint

为了使 ESLint 运作，应执行以下步骤

1. 安装 Node.js (* 如果系统上已存在 Node.js，则可以跳过此步骤)

• 请遵循 Node.js 页面上的官方 指南

1. 安装 ESLint

npm install -g eslint

命令行使用

eslint <project root directory>

Thunder 指南检查器

此脚本由 Thunder 开发工具提供。它是 phpcs 和 eslint 工具的包装器。

要使用需求初始化项目，请执行

vendor/bin/check-guidelines.sh --init

请注意，在您的根 composer.json 文件中，可以自定义 vendor/bin 路径。

然后可以使用一些基本的选项来检查代码风格指南

-cs, --phpcs            use PHP Code Sniffer with Drupal code style standard
-js, --javascript       use ESLint with usage of project defined code standard
-ac, --auto-correct     apply auto formatting with validation of code styles

例如，要检查和自动修正 php 和 JavaScript 文件

vendor/bin/check-guidelines.sh --phpcs --javascript --auto-correct

将代码风格检查集成到 PHPStorm 中

Drupal Coder

1. 在 PHPStorm 首选项中搜索： Code Sniff
2. 选择选项 Languages & Frameworks | PHP | Code Sniffer
3. 通过按编辑按钮 [...] 打开配置对话框
4. 在配置对话框中添加新的配置或编辑现有的 Local。通过按编辑按钮 [...] 设置正确的 phpcs 路径。路径应该是： <composer home directory>/vendor/bin/phpcs 并为 Code Sniffer 保存这些设置
5. 要配置 PHP Code Sniffer 的使用，请选择 Editor | Inspections
6. 应通过搜索筛选出 PHP Code Sniffer validation 选项。启用该选项。
7. 并为此验证过程将 Coding standard 选项更改为 Drupal。 (* 有时如果预先选择 Drupal，PHPStorm 可能无法识别代码标准已更改。只需选择其他代码标准，然后再将其放回 Drupal)

在保存这些设置后，编辑器中将显示带有前缀 phpcs: 的警告。

ESLint

1. 在 PHPStorm 首选项中搜索： ESLint
2. 选择选项 Languages & Frameworks | JavaScript | Code Quality Tools | ESLint
3. 启用它

可以保留默认设置。ESLint 将自动搜索安装的 eslint 命令，并将从项目使用的代码风格配置文件。

Git 钩子

Git 预提交钩子

要检查在提交前代码是否有效，可以使用 git 预提交钩子执行 thunder 指南检查器脚本。在项目文件夹中创建脚本文件 .git/hooks/pre-commit，内容如下

#!/bin/sh
vendor/bin/check-guidelines.sh --phpcs --javascript

确保文件可执行。这将在提交前自动验证文件，显示可能的问题，并且只有当一切正确且有效时才会执行提交。