konafets / composer-plugins
Composer插件,用于安装PHP_CodeSniffer标准
2.0.0
2015-02-24 19:23 UTC
Requires
- composer-plugin-api: 1.0.0
- squizlabs/php_codesniffer: *
This package is auto-updated.
Last update: 2024-09-17 11:19:32 UTC
README
一组用于为Composer包提供特定安装指令的composer插件。
PHP Codesniffer Standard安装程序
PHP Codesniffer Standard安装程序可以将phpcs codesniffer标准安装到<vendor>/squizlabs/php_codesniffer/CodeSniffer/Standards/
文件夹中。通过这样做,标准将通过调用bin/phpcs --standard <standard>
来使用。
如何使用
- 找到包含您想要使用的codesniffs的包。这个包应该是一个包含
ruleset.xml
和composer.json
的正常Codesniffing包。 - Composer包类型必须是
phpcodesniffer-standard
- 包的名称必须反映标准的名称(下面解释)
- 如果包需要
simplyadmire/composer-plugins
,这是确保在安装包之前安装程序可用的唯一方法。 - 现在将包作为开发依赖项添加到您的项目中
- 运行
bin/phpcs -i
,并查看您的标准列表
命名规则
标准的名称是从composer包key派生出来的。/
后面的部分作为标准名称。第一个字符被转换为大写,所有在-
后面的字符也将被转换为大写。所以
vendor/mysniffs
变为Mysniffs
vendor/some-more-words
变为SomeMoreWords
TYPO3特定
TYPO3社区已经在packagist上提供了包,由于重命名包名是不良实践,我们添加了3个硬编码的标准名称。此外,vendor名称TYPO3
将始终强制大写。
要向您的项目添加TYPO3 CGL,可以使用以下命令之一(根据您想要使用的CGL,TYPO3 Flow或TYPO3 CMS)
TYPO3 Flow
composer require --dev typo3-ci/typo3flow=dev-master
TYPO3 CMS
composer require --dev typo3-ci/typo3cms=dev-master
现在您可以使用例如来嗅探您的包
bin/phpcs --extensions=php --standard=TYPO3Flow Packages/Application/My.Package