ise / php-codingstandards-codeigniter
PHPCS 的 CodeIgniter 编码规范
Requires
- php: >=7.3
- codeigniter/framework: ^3.0.0
- squizlabs/php_codesniffer: ^3.0.0
Requires (Dev)
- ise/php-metapackage-development: ^2.2.2
This package is auto-updated.
Last update: 2024-08-28 00:27:49 UTC
README
原始仓库
- https://github.com/thomas-ernest/CodeIgniter-for-PHP_CodeSniffer
- https://github.com/ganl/CodeIgniter-for-PHP_CodeSniffer
使用说明
composer require ise/php-codingstandards-codeigniter:^1.0.0
提供用于检查 PHP_CodeSniffer 3.x 的 sniff,以确保 CodeIgniter3 编码规范。
CI4 可以使用 CodeIgniter4 标准 来检查 CodeIgniter4 编码规范
PHP_CodeSniffer
PHP_CodeSniffer 是一组两个 PHP 脚本;主要的 phpcs 脚本用于将 PHP、JavaScript 和 CSS 文件进行标记化,以检测违反定义的编码规范,第二个 phpcbf 脚本用于自动纠正编码规范违反。
PHP_CodeSniffer 是一种必不可少的开发工具,确保您的代码保持整洁和一致。
默认情况下,提供了对一些编码约定的 sniff,如 PEAR、Zend、PHPCS 和 Squiz。 CodeIgniter-for-PHP_CodeSniffer 旨在添加对 CodeIgniter 编码约定的支持。
CodeIgniter 编码规范
CodeIgniter 是一个功能强大的 PHP 框架,具有非常小的体积,专为需要简单且优雅的工具包来创建功能齐全的 Web 应用程序的 PHP 开发人员构建。
CodeIgniter 由 EllisLab 开发。该公司为其开发和 CodeIgniter 尤其遵循一些特定的 编码规则。
基于 PHP_CodeSniffer,CodeIgniter-for-PHP_CodeSniffer 帮助验证 CodeIgniter 编码规范中的大部分规则。
安装
git clone https://github.com/ganl/CodeIgniter-for-PHP_CodeSniffer.git
配置 PHP_CodeSniffer 以使用 CodeIgniter-for-PHP_CodeSniffer。
phpcs --config-set installed_paths /path/to/CodeIgniter-for-PHP_CodeSniffer/CodeIgniter
检查是否已安装,输入 phpcs -i
,您应该会看到一个已安装标准的列表。
然后您可以去您的项目文件夹,并运行 phpcs --standard=CodeIgniter my-file-or-my-directory.php
。