typo3-ci / typo3sniffpool
该仓库包含与 PHP_CodeSniffer 兼容的自定义嗅探器。将此包视为嗅探池。它包含TYPO3项目中的所有自定义嗅探器。
Requires
- php: >=5.2.1
- simplyadmire/composer-plugins: ~2.0
- squizlabs/php_codesniffer: ~2.3
Requires (Dev)
- phpunit/phpunit: ~4.7
Suggests
- typo3-ci/typo3cms: The coding standard for TYPO3 CMS
- typo3-ci/typo3flow: The coding standard for TYPO3 Flow
Replaces
- typo3/codesniffer: *
This package is not auto-updated.
Last update: 2024-09-14 14:06:03 UTC
README
每个大型项目都有自己的编码标准和格式(编码指南/CGL)。例如,Zend Framework、PEAR、Drupal、Symfony2 等等。《TYPO3 CMS》和《TYPO3 Flow / Neos》也不例外。
使用 PHP_CodeSniffer,可以检测 PHP、JavaScript 和 CSS 文件中违反定义的规则集(称为嗅探器)的违规行为。
此仓库包含基于 PHP_CodeSniffer 的自行开发的嗅探器,用于 TYPO3 项目,以检查编码指南并检测违规行为。我们称此存储库为“TYPO3 嗅探池”,因为它包含我们在类似 TYPO3Flow 和 TYPO3CMS 的单独编码标准中使用的所有嗅探器。
如何安装
由于此标准是 TYPO3CMS 和 TYPO3Flow 标准的依赖项,因此您不需要直接安装此标准。在安装所提到的标准之一时,它将自动安装。
如何使用
由于它是一个自己的标准,因此可以调用它。
不建议这样做!这可能会引发奇怪的错误。
我们提供并建议使用与 TYPO3CMS 和 TYPO3Flow 编码指南相匹配的单独标准。
文档
我们在我们的 wiki 中收集了以下内容的完整文档:
- 此存储库
- 自行开发的嗅探器
- 如何安装我们的自定义标准
- 如何为此存储库做出贡献
- 您可以在哪里找到更多信息
。
贡献
欢迎贡献!
在 PHP_CodeSniffer 规则的开发过程中,许多人参与了其中并为此项目做出了贡献。以下是一份参与开发的所有人员的列表。如果您不在列表中,但您做出了贡献,请不要生气。我们只是凡人 :)。
- Laura Thewalt(代码/文档)
- Julian Kleinhans(代码)
- Bastian Waidelich(文档)
- Christian Trabold (CI-集成/ 文档)
- Tim Eilers (代码 / 文档)
- 更多贡献者信息可以在我们的贡献者页面找到
谢谢!你们真是太棒了!
如果您现在想贡献力量,我们已经在wiki中收集了一系列关于如何为此项目贡献的信息。在那里您可以找到关于使用的分支模型、如何执行单元测试或关于TravisCI的信息。