README

关于

• PHP_CodeSniffer 是一组由两个 PHP 脚本组成的工具；主要的 phpcs 脚本用于标记 PHP、JavaScript 和 CSS 文件，以检测违反定义的编码标准的违规行为，另一个 phpcbf 脚本用于自动纠正编码标准的违规行为。 PHP_CodeSniffer 是一个基本的开发工具，确保您的代码保持清洁和一致。
• Framgia PHP Standard 是 Framgia Vietnam 的 PHP 团队使用的一系列编码约定。它基于 PSR-2 编码风格指南，并添加了一些额外的规则。
• 这是 Code Sniffer 的编码标准包，用于检查您的代码是否符合 Framgia 标准。
• 新功能：此标准与 PHP CodeSniffer 版本 2 和 3 都兼容。如果您使用 PHP CodeSniffer 2，请使用 0.2 分支中的代码。如果您使用 PHP CodeSniffer 3，请使用 master 分支中的代码。

安装

本地安装

您可以在每个项目文件夹中安装

composer require --dev dealerdirect/phpcodesniffer-composer-installer
composer require --dev wataridori/framgia-php-codesniffer

phpcs 命令将安装到 vendor/bin 文件夹。

现在您可以检查并运行 phpcs

./vendor/bin/phpcs -i

./vendor/bin/phpcs --standard=Framgia /path/to/your/code

全局安装

• 通过 composer 全局安装 PHP_CodeSniffer。请确保您的 PATH 中有 ~/.composer/vendor/bin/。

composer global require "squizlabs/php_codesniffer=*"

• 克隆此存储库

// Version 2
cd ~/.composer/vendor/squizlabs/php_codesniffer/CodeSniffer/Standards
git clone -b 0.2 git@github.com:wataridori/framgia-php-codesniffer.git FramgiaPHPCS

// Version 3
cd ~/.composer/vendor/squizlabs/php_codesniffer/src/Standards
git clone git@github.com:wataridori/framgia-php-codesniffer.git FramgiaPHPCS

• 将其路径添加到 PHP_CodeSniffer 配置中

phpcs --config-set installed_paths /path/to/FramgiaPHPCS

注意：如果您想设置多个已安装路径，可以通过命令获取旧路径

phpcs --config-show installed_paths

然后您可以通过命令设置多个路径

phpcs --config-set installed_paths /absolute/path/1,/absolute/path/2,/yet/another/absolute/path/

• 检查 Framgia 标准是否已成功安装

phpcs -i

• 使用 Framgia 标准检查您的代码

phpcs --standard=Framgia /path/to/your/code

• 如果您不希望在 CodeSniffer Standards 文件夹中安装此包，您可以将它克隆到任何您想的地方，并在运行 phpcs 命令时指定安装文件夹。

phpcs --standard=/path/to/your/framgia-php-codesniffer /path/to/your/code

• 遗憾的是，PHP_CodeSniffer 默认使用的编码是 ISO-8859-1。是的，它不是 UTF-8。因此，如果您在代码中使用日语，您可能会遇到单词计数器的一些问题。您最好将默认编码更改为 UTF-8。

phpcs --config-set encoding utf-8

或者在运行命令时将编码设置为 UTF-8。

phpcs --standard=Framgia /path/to/your/code --encoding=utf-8