simplyadmire / composer-plugins
此包已被废弃且不再维护。未建议替代包。
Composer 插件,用于安装 PHP_CodeSniffer 标准
2.1.0
2016-05-12 11:58 UTC
Requires
- composer-plugin-api: ^1.0
- squizlabs/php_codesniffer: *
README
一组 composer 插件,用于对 composer 包进行特定的安装说明。
重要:如果您正在运行 Flow 3+ 并已使用主分发的 composer.json 安装了 typo3/ci-flow 包,您应该在那里将其删除,并在单独的文件夹中安装 codesniffer,例如:https://git.typo3.org/Neos/Distributions/Base.git/tree/refs/heads/master:/Build/PhpCodesniffer
PHP Codesniffer Standard 安装程序
PHP Codesniffer Standard 安装程序可以将 phpcs codesniffer 标准安装到 <vendor>/squizlabs/php_codesniffer/CodeSniffer/Standards/
文件夹。通过这样做,标准可以通过调用 bin/phpcs --standard <standard>
来使用。
如何使用
- 找到包含您想使用的 codesniffs 的包。此包应该是一个正常的 Codesniffing 包,包含一个
ruleset.xml
和一个composer.json
。 - composer 包类型必须是
phpcodesniffer-standard
- 包的名称必须反映标准的名称(如下文所述)
- 如果包有对
simplyadmire/composer-plugins
的要求,则最佳。这是确保在安装包之前安装程序可用的唯一方法。 - 现在将包添加为项目的开发依赖项
- 运行
bin/phpcs -i
并查看您的标准列表
命名规则
标准的名称是从 composer 包键派生出来的。/
之后的部分用作标准名称。第一个字符被转换为大写,并且所有 -
之后的所有字符都将被转换为大写。因此
vendor/mysniffs
变为Mysniffs
vendor/some-more-words
变为SomeMoreWords
TYPO3 特定
TYPO3 社区已在 Packagist 上提供了一些包,由于重命名包名是不良做法,我们添加了 3 个硬编码的标准名称。此外,厂商名称 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