TrailingCommaSniff
in package
implements
Sniff
FinalYes
Require a trailing comma for multi-line, multi-attribute attribute blocks and forbid trailing commas in single-line attribute blocks and multi-line attributes containing only a single attribute.
Tags
Table of Contents
Interfaces
Constants
- METRIC_NAME_MULTI_LINE : string = 'Trailing comma in multi-line attribute block'
- Name of the metric for multi-line attribute blocks.
- METRIC_NAME_SINGLE_LINE : string = 'Trailing comma in single-line attribute block'
- Name of the metric for single-line attribute blocks.
Methods
- process() : void
- Processes this test, when one of its tokens is encountered.
- register() : array<string|int, int|string>
- Returns an array of tokens this test wants to listen for.
Constants
METRIC_NAME_MULTI_LINE
Name of the metric for multi-line attribute blocks.
public
string
METRIC_NAME_MULTI_LINE
= 'Trailing comma in multi-line attribute block'
Tags
METRIC_NAME_SINGLE_LINE
Name of the metric for single-line attribute blocks.
public
string
METRIC_NAME_SINGLE_LINE
= 'Trailing comma in single-line attribute block'
Tags
Methods
process()
Processes this test, when one of its tokens is encountered.
public
process(File $phpcsFile, int $stackPtr) : void
Parameters
- $phpcsFile : File
-
The file being scanned.
- $stackPtr : int
-
The position of the current token in the stack passed in $tokens.
Tags
register()
Returns an array of tokens this test wants to listen for.
public
register() : array<string|int, int|string>