README

描述

此标准由来自 TYPO3SniffPool 的嗅探器子集组成，并实现了 TYPO3 CMS 的编码指南。

它包含一个ruleset.xml文件，其中我们引用了来自 PHP_CodeSniffer 和来自 TYPO3SniffPool 的嗅探器。

如果您尚未安装 TYPO3SniffPool 或 PHP_CodeSniffer，没有问题。这些包被标记为此标准的依赖项，并将自动安装。

获取此标准有几种方法，我将逐一介绍。没有正确或错误之分。您选择哪种方式取决于您的偏好和至少是您的需求。

我们支持 Composer，PHP 的依赖管理器。

在您的项目根目录中创建一个 composer.json 文件或扩展现有的文件，并将此包声明为依赖项

{
	"minimum-stability": "dev",
	"require": {
		"typo3-ci/typo3cms": "dev-develop"
	}
}

{
	"require": {
		"typo3-ci/typo3cms": "dev-master"
	}
}

由于此包由 Packagist 管理，这就是您需要做的全部。

这将安装 PHP_CodeSniffer 和 TYPO3SniffPool 到您的项目的 vendor/ 文件夹中。有关Composer的更多信息，请参阅他们的文档。

对于系统范围内的安装，您可以使用

composer global require "typo3-ci/typo3cms=dev-master"

请确保 ~/.composer/vendor/bin/ 在您的路径中。

第二种方法是克隆 GitHub 上的存储库。在这种情况下，您必须自己负责依赖项。

$ git clone https://github.com/typo3-ci/TYPO3CMS.git
$ git clone https://github.com/typo3-ci/TYPO3SniffPool.git

安装方法有多少种，使用方法就有多少种。

切换到您的项目文件夹，并从那里调用 PHP_CodeSniffer

$ cd myproject
$ php vendor/squizlabs/php_codesniffer/scripts/phpcs --standard=TYPO3CMS /path/to/folder

也可以使用全局安装的 PHP_CodeSniffer（例如，通过 PEAR）调用此标准

$ cd myproject
$ phpcs --standard=vendor/squizlabs/php_codesniffer/CodeSniffer/Standards/TYPO3CMS/ruleset.xml /path/to/folder

在您克隆了标准及其依赖项之后，使用方法与上述几乎相同。主要有两种方法。

请参阅专门的维基页面了解如何贡献此项目的信息。