README

为PHP_CodeSniffer 1.3.0及以上版本提供嗅探器，以检查CodeIgniter编码标准。

一些故事

PHP_CodeSniffer

PHP_CodeSniffer是一个PHP5脚本，它将PHP、JavaScript和CSS文件进行标记化并“嗅探”，以检测违反定义的编码标准的违规行为。

这是一个重要的开发工具，确保您的代码保持整洁和一致。它还可以帮助防止开发者犯的一些常见语义错误。

默认情况下，提供了一些编码约定（如PEAR、Zend、PHPCS和Squiz）的嗅探器。 CodeIgniter-for-PHP_CodeSniffer旨在添加对CodeIgniter编码约定的支持。

CodeIgniter编码标准

CodeIgniter是一个功能强大的PHP框架，占用的空间很小，专为需要简单优雅的工具包来创建全功能Web应用程序的PHP程序员而构建。

CodeIgniter由EllisLab开发。该公司在开发和CodeIgniter特别遵循一些特定的编码规则。

基于PHP_CodeSniffer，CodeIgniter-for-PHP_CodeSniffer帮助验证CodeIgniter编码标准中的大多数规则。

安装

使用composer

将其添加到您的composer.json中

{
 "require-dev": {
   ...
   "nerones/codeigniter-phpcs": "dev-master"
   ...
 },
}

然后运行composer install，之后您可以使用这些规则，例如

vendor/bin/phpcs --standard=vendor/nerones/codeigniter-phpcs/CodeIgniter/ --extensions=php src/

如果全局安装规则集，则需要更改使用的路径。

使用ant

在存储库的根目录下有一个Apache Ant脚本。它针对标准Linux环境，如通过PEAR安装了PHP_CodeSniffer 1.3.0或以上的Ubuntu。它需要PHP（第5版）。

只需转到项目的根目录并键入ant即可设置CodeIgniter-for-PHP_CodeSniffer。如果您在除"/usr/share/php/PHP/CodeSniffer/"之外的目录中安装了CodeSniffer，则可以将正确的目录作为参数传递给ant。只需键入ant -Dphpcs.dir="/path/to/CodeSniffer/"。

检查是否已安装，键入phpcs -i，您应该会看到已安装的标准列表。

然后您可以直接进入项目文件夹并运行phpcs --standard=CodeIgniter my-file-or-my-directory.php。

如果您在Windows平台上工作或出于任何原因，编辑安装脚本非常容易。您只需更改build.xml中的属性phpcs.dir，将其指向包含PHP_CodeSniffer的目录。