ardem / yii-coding-standard
Yii 框架 PHP CodeSniffer 编码标准。
dev-master
2013-08-06 22:28 UTC
Requires
- squizlabs/php_codesniffer: >=1.4.2
This package is not auto-updated.
Last update: 2024-09-23 15:10:48 UTC
README
您可以在以下位置了解 Yii 标准: https://github.com/yiisoft/yii/wiki/Core-framework-code-style
如何安装
-
安装 PEAR
http://pear.php.net/manual/en/installation.getting.php
-
安装 PHP_CodeSniffer
pear install PHP_CodeSniffer
-
安装 Yii 编码标准
git clone git://github.com/Ardem/yii-coding-standard.git Yii sudo ln -sv /path/to/yii-coding-standard/Yii $(pear config-get php_dir)/PHP/CodeSniffer/Standards
-
如果您想,可以将 Yii 设置为默认编码标准
phpcs --config-set default_standard Yii
如何进行简单测试
-
检查文件(如果 yii-coding-standard 是您的默认标准)
phpcs path/to/file.php
-
检查文件(如果 yii-coding-standard 不是您的默认标准)
phpcs --standard=Yii /path/to/file.php
-
检查目录(如果 yii-coding-standard 是您的默认标准)
phpcs /path/to/directory
-
检查目录(如果 yii-coding-standard 不是您的默认标准)
phpcs --standard=Yii /path/to/directory
如何在 IDE 中使用 CS
-
NetBeans
http://plugins.netbeans.org/plugin/40282/phpmd-php-codesniffer-plugin
-
PHPStorm
http://www.jetbrains.com/phpstorm/webhelp/using-php-code-sniffer-tool.html
-
Zend Studio
http://files.zend.com/help/Zend-Studio/content/working_with_php_codesniffer.htm
如何在团队中制定编码标准
使用 pre-commit 钩子,这将使每次提交都进行编码标准检查。
-
对于 Git
https://git-scm.cn/book/en/Customizing-Git-Git-Hooks
-
对于 SVN
http://pear.php.net/manual/ru/package.php.php-codesniffer.svn-pre-commit.php
Yii-coding-standard 和 Composer
要使用 "yii-coding-standard" 与 Composer,请将 "ardem/yii-coding-standard" 作为依赖项包含在您的 composer.json 文件中
{
"require": {
"ardem/yii-coding-standard": "dev-master"
}
}