maxicoffee/composer-plugins

用于安装 PHP_CodeSniffer 标准的 Composer 插件

安装: 360

依赖者: 0

建议者: 0

安全: 0

星级: 0

关注者: 1

分支: 8

类型:composer-plugin

2.0.2 2016-11-16 13:52 UTC

This package is not auto-updated.

Last update: 2024-09-23 12:40:46 UTC


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 的包。这个包应该是一个包含 ruleset.xmlcomposer.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