README

新的 CodeIgniter 编码标准 已正式发布！此版本使用 PHP CS Fixer 而不是 Code Sniffer，并进行了许多更改（最显著的是，符合 PSR-12）。访问仓库以获取更多信息。此库将保留，但可能不再维护，并且不再符合官方 CodeIgniter 4 框架样式。

CodeIgniter4-Standard

CodeIgniter 4 编码标准，用于与 PHP_CodeSniffer 3 一起使用。

版本 1

主分支	开发分支

这目前是一个正在进行中的项目。

请求时间：codeigniter4/CodeIgniter4#182

要求

PHP_CodeSniffer 3。 (3.1.1 或更高版本)。

PHP (7.1 或更高版本) 与 mbstring 扩展。

安装

Composer 安装

cd /Path/To/MyProject composer require codeigniter4/codeigniter4-standard --dev

在您的编辑器/插件配置中设置 phpcs standard path 和 phpcbf standard path 为

/Path/To/MyProject/vendor/codeigniter4/codeigniter4-standard/CodeIgniter4/ruleset.xml

下载安装

下载 CodeIgniter4-Standard。

将 standard 路径设置为您的本地文件系统

'/Path/To/CodeIgniter4-Standard/CodeIgniter4/ruleset.xml'

全局安装

使用各种方法全局安装 PHP_CodeSniffer。

完成后，您应该在命令行上能够执行 phpcs -i。

您应该看到类似以下内容：

已安装的编码标准为 MySource、PEAR、PSR1、PSR2、Squiz 和 Zend。

您可以克隆此仓库...

git clone -b master --depth 1 https://github.com/bcit-ci/CodeIgniter4-Standard.git.

或使用 composer...

composer global require codeigniter4/codeigniter4-standard

或下载。

请注意它们安装的路径。

在 php_codesniffer/src/Standards/ 中创建指向 CodeIgniter4-Standard/CodeIgniter4 目录的符号链接，例如。

ln -s ~/Documents/Projects/CodeIgniter4-Standard/CodeIgniter4 ~/.composer/vendor/squizlabs/php_codesniffer/src/Standards/CodeIgniter4

或复制 CodeIgniter4-Standard/CodeIgniter4 目录到 php_codesniffer/src/Standards/

现在执行 phpcs -i 应该会显示已安装 CodeIgniter4，例如。

已安装的编码标准包括 CodeIgniter4、MySource、PEAR、PSR1、PSR2、Squiz 和 Zend。

现在您应该能够将 'CodeIgniter4' 设置为您选择的插件/编辑器/IDE 中的 phpcs 标准。

命令行使用

嗅探错误和警告（报告）。

单个文件...

phpcs /Path/To/MyFile.php --standard='/Path/To/CodeIgniter4-Standard/CodeIgniter4/ruleset.xml'

或者如果全局安装。

phpcs /Path/To/MyFile.php --standard=CodeIgniter4

目录（递归）。

phpcs /Path/To/MyProject --standard='/Path/To/CodeIgniter4-Standard/CodeIgniter4/ruleset.xml'

或者如果全局安装。

phpcs /Path/To/MyProject --standard=CodeIgniter4

修复可修复的错误。

单个文件。

phpcbf /Path/To/MyFile.php --standard='/Path/To/CodeIgniter4-Standard/CodeIgniter4/ruleset.xml'

或者如果全局安装。

phpcbf /Path/To/MyFile.php --standard=CodeIgniter4

目录（递归）。

phpcbf /Path/To/MyProject --standard='/Path/To/CodeIgniter4-Standard/CodeIgniter4/ruleset.xml'

或者如果全局安装。

phpcbf /Path/To/MyProject --standard=CodeIgniter4

致谢

感谢 Greg Sherwood、Marc McIntyre、Andy Grunwald、Thomas Ernest 和 Erik Torsner 提供开源代码，这帮助我构建了这个标准，并向 Squiz Labs 表示衷心的感谢，因为它们创建了 PHP_CodeSniffer。

感谢 EllisLab 创造了 CodeIgniter，感谢 不列颠哥伦比亚理工学院 继续该项目。感谢所有在 CodeIgniter 4 上工作的开发者和贡献者。