ESLintSniff
in package
implements
Sniff, DeprecatedSniff
Table of Contents
Interfaces
Properties
- $configFile : string|null
- ESLint configuration file path.
- $supportedTokenizers : array<string|int, mixed>
- A list of tokenizers this sniff supports.
Methods
- getDeprecationMessage() : string
- Provide a custom message to display with the deprecation.
- getDeprecationVersion() : string
- Provide the version number in which the sniff was deprecated.
- getRemovalVersion() : string
- Provide the version number in which the sniff will be removed.
- process() : int
- Processes the tokens that this sniff is interested in.
- register() : array<string|int, int|string>
- Returns the token types that this sniff is interested in.
Properties
$configFile
ESLint configuration file path.
public
string|null
$configFile
= null
Path to eslintrc. Null to autodetect.
$supportedTokenizers
A list of tokenizers this sniff supports.
public
array<string|int, mixed>
$supportedTokenizers
= ['JS']
Methods
getDeprecationMessage()
Provide a custom message to display with the deprecation.
public
getDeprecationMessage() : string
Return values
stringgetDeprecationVersion()
Provide the version number in which the sniff was deprecated.
public
getDeprecationVersion() : string
Return values
stringgetRemovalVersion()
Provide the version number in which the sniff will be removed.
public
getRemovalVersion() : string
Return values
stringprocess()
Processes the tokens that this sniff is interested in.
public
process(File $phpcsFile, int $stackPtr) : int
Parameters
- $phpcsFile : File
-
The file where the token was found.
- $stackPtr : int
-
The position in the stack where the token was found.
Tags
Return values
intregister()
Returns the token types that this sniff is interested in.
public
register() : array<string|int, int|string>