Folder structure

The TYPO3 Coding Standard consists of the SniffPool and a concrete standard (e.g. TYPO3CMS or TYPO3Flow). The folder TYPO3SniffPool contains the SniffPool. This is the home of all sniffs which we (re)implemented for our Coding Guidelines.

The folders TYPO3CMS and TYPO3Flow contains no sniffs but a ruleset.xml file. In this file we refer to the needed sniffs for the concrete standard. Its a mixture of shipped sniffs from PHP_CodeSniffer and from the SniffPool.

In both folders there are also package.xml files. This are the definition files for building PEAR packages from.

path/to/PHP/PHP_CodeSniffer/CodeSniffer/Standards/TYPO3CMS
├── Builds
│   ├── PHPCS_TYPO3v4_Standard-0.0.3.tgz
│   ├── PHPCS_TYPO3v4_Standard-0.0.4.tgz
│   ├── TYPO3CMS-0.0.5.tgz
│   ├── TYPO3CMS-0.0.6.tgz
│   └── TYPO3CMS-1.0.0.tgz
├── README.rst
├── composer.json
├── package.xml
└── ruleset.xml

path/to/PHP/PHP_CodeSniffer/CodeSniffer/Standards/TYPO3Flow
├── Builds
│   ├── PHPCS_FLOW3_Standard-0.0.1.tgz
│   ├── TYPO3Flow-0.0.2.tgz
│   └── TYPO3Flow-0.0.3.tgz
├── README.rst
├── composer.json
├── package.xml
└── ruleset.xml

path/to/PHP_CodeSniffer/CodeSniffer/Standards/TYPO3SniffPool
├── Builds
│   ├── PHPCS_TYPO3_SniffPool-0.0.3.tgz
│   ├── PHPCS_TYPO3_SniffPool-0.0.4.tgz
│   ├── TYPO3SniffPool-0.0.5.tgz
│   ├── TYPO3SniffPool-0.0.6.tgz
│   └── TYPO3SniffPool-1.0.0.tgz
├── Docs
│   ├── ControlStructures
│   │   ├── SwitchDeclarationStandard.xml
│   │   └── TernaryConditionalOperatorStandard.xml
│   ├── Strings
│   │   └── ConcatenationSpacingStandard.xml
│   └── WhiteSpace
│       └── ScopeClosingBraceStandard.xml
├── GenericStandard.html
├── README.rst
├── Sniffs
│   ├── Classes
│   │   └── LowercaseClassKeywordsSniff.php
│   ├── Commenting
│   │   ├── ClassCommentSniff.php
│   │   ├── DoubleSlashCommentsInNewLineSniff.php
│   │   ├── FunctionDocCommentSniff.php
│   │   ├── NoAuthorAnnotationInFunctionDocCommentSniff.php
│   │   ├── SpaceAfterDoubleSlashSniff.php
│   │   └── ValidCommentLineLengthSniff.php
│   ├── ControlStructures
│   │   ├── AlignedBreakStatementSniff.php
│   │   ├── DisallowEachInLoopConditionSniff.php
│   │   ├── DisallowElseIfConstructSniff.php
│   │   ├── ExtraBracesByAssignmentInLoopSniff.php
│   │   ├── SwitchDeclarationSniff.php
│   │   ├── TernaryConditionalOperatorSniff.php
│   │   ├── UnusedVariableInForEachLoopSniff.php
│   │   ├── ValidBreakStatementsInSwitchesSniff.php
│   │   └── ValidDefaultStatementsInSwitchesSniff.php
│   ├── Debug
│   │   └── DebugCodeSniff.php
│   ├── Files
│   │   ├── FileExtensionSniff.php
│   │   ├── FilenameSniff.php
│   │   └── IncludingFileSniff.php
│   ├── NamingConventions
│   │   ├── ValidFunctionNameSniff.php
│   │   └── ValidVariableNameSniff.php
│   ├── PHP
│   │   ├── CharacterAfterPHPClosingTagSniff.php
│   │   └── DisallowMultiplePHPTagsSniff.php
│   ├── Scope
│   │   └── AlwaysReturnSniff.php
│   ├── Strings
│   │   ├── ConcatenationSpacingSniff.php
│   │   └── UnnecessaryStringConcatSniff.php
│   └── WhiteSpace
│       ├── AssignmentArithmeticAndComparisonSpaceSniff.php
│       ├── AsteriksWhitespacesSniff.php
│       ├── DisallowSpaceIndentSniff.php
│       ├── ScopeClosingBraceSniff.php
│       └── WhitespaceAfterCommentSignsSniff.php
├── SquizStandard.html
├── Tests
│   ├── Classes
│   │   ├── LowercaseClassKeywordsUnitTest.inc
│   │   └── LowercaseClassKeywordsUnitTest.php
│   ├── Commenting
│   │   ├── ClassCommentUnitTest.inc
│   │   ├── ClassCommentUnitTest.php
│   │   ├── DoubleSlashCommentsInNewLineUnitTest.inc
│   │   ├── DoubleSlashCommentsInNewLineUnitTest.php
│   │   ├── FunctionDocCommentUnitTest.inc
│   │   ├── FunctionDocCommentUnitTest.php
│   │   ├── NoAuthorAnnotationInFunctionDocCommentUnitTest.inc
│   │   ├── NoAuthorAnnotationInFunctionDocCommentUnitTest.php
│   │   ├── SpaceAfterDoubleSlashUnitTest.inc
│   │   ├── SpaceAfterDoubleSlashUnitTest.php
│   │   ├── ValidCommentLineLengthUnitTest.inc
│   │   └── ValidCommentLineLengthUnitTest.php
│   ├── ControlStructures
│   │   ├── AlignedBreakStatementUnitTest.inc
│   │   ├── AlignedBreakStatementUnitTest.php
│   │   ├── DisallowEachInLoopConditionUnitTest.inc
│   │   ├── DisallowEachInLoopConditionUnitTest.php
│   │   ├── DisallowElseIfConstructUnitTest.inc
│   │   ├── DisallowElseIfConstructUnitTest.php
│   │   ├── ExtraBracesByAssignmentInLoopUnitTest.inc
│   │   ├── ExtraBracesByAssignmentInLoopUnitTest.php
│   │   ├── SwitchDeclarationUnitTest.inc
│   │   ├── SwitchDeclarationUnitTest.php
│   │   ├── TernaryConditionalOperatorUnitTest.inc
│   │   ├── TernaryConditionalOperatorUnitTest.php
│   │   ├── UnusedVariableInForEachLoopUnitTest.inc
│   │   ├── UnusedVariableInForEachLoopUnitTest.php
│   │   ├── ValidBreakStatementsInSwitchesUnitTest.inc
│   │   ├── ValidBreakStatementsInSwitchesUnitTest.php
│   │   ├── ValidDefaultStatementsInSwitchesUnitTest.inc
│   │   └── ValidDefaultStatementsInSwitchesUnitTest.php
│   ├── Debug
│   │   ├── DebugCodeUnitTest.inc
│   │   └── DebugCodeUnitTest.php
│   ├── Files
│   │   ├── FileExtensionUnitTest.inc
│   │   ├── FileExtensionUnitTest.php
│   │   ├── FilenameUnitTest.1.inc
│   │   ├── FilenameUnitTest.2.inc
│   │   ├── FilenameUnitTest.3.inc
│   │   ├── FilenameUnitTest.php
│   │   ├── IncludingFileUnitTest.inc
│   │   └── IncludingFileUnitTest.php
│   ├── NamingConventions
│   │   ├── ValidFunctionNameUnitTest.inc
│   │   ├── ValidFunctionNameUnitTest.php
│   │   ├── ValidVariableNameUnitTest.inc
│   │   └── ValidVariableNameUnitTest.php
│   ├── PHP
│   │   ├── CharacterAfterPHPClosingTagUnitTest.inc
│   │   ├── CharacterAfterPHPClosingTagUnitTest.php
│   │   ├── DisallowMultiplePHPTagsUnitTest.inc
│   │   └── DisallowMultiplePHPTagsUnitTest.php
│   ├── Scope
│   │   ├── AlwaysReturnUnitTest.inc
│   │   └── AlwaysReturnUnitTest.php
│   ├── Strings
│   │   ├── ConcatenationSpacingUnitTest.inc
│   │   ├── ConcatenationSpacingUnitTest.php
│   │   ├── UnnecessaryStringConcatUnitTest.inc
│   │   ├── UnnecessaryStringConcatUnitTest.js
│   │   └── UnnecessaryStringConcatUnitTest.php
│   └── WhiteSpace
│       ├── AssignmentArithmeticAndComparisonSpaceUnitTest.inc
│       ├── AssignmentArithmeticAndComparisonSpaceUnitTest.php
│       ├── AsteriksWhitespacesUnitTest.inc
│       ├── AsteriksWhitespacesUnitTest.php
│       ├── DisallowSpaceIndentUnitTest.inc
│       ├── DisallowSpaceIndentUnitTest.php
│       ├── ScopeClosingBraceUnitTest.inc
│       ├── ScopeClosingBraceUnitTest.php
│       ├── WhitespaceAfterCommentSignsUnitTest.inc
│       └── WhitespaceAfterCommentSignsUnitTest.php
├── build.xml
├── cache.properties
├── composer.json
├── documentation.html
├── package.xml
└── ruleset.xml