Human Readable Information
Human Readable Information
- public function getInfoURI()
- public function getInfoDescription()
- public function getAdditionalInformation() — Return arbitrary additional information.
- public function getInfoName()
Runtime State
Runtime State
- final public function getActivePath()
- final public function setActivePath($path)
- final public function setEngine($engine)
- final protected function getEngine()
- final public function setLinterID($id) — Set the internal ID for this linter.
- final public function getLinterID() — Get the internal ID for this linter.
Executing the Linter
Executing the Linter
- public function willLintPaths($paths)
- final public function lintPath($path)
- public function didLintPaths($paths)
- final protected function getExecutableCommand() — Get the composed executable command, including the interpreter and binary but without flags or paths. This can be used to execute `--version` commands.
- final protected function getCommandFlags() — Get the composed flags for the executable, including both mandatory and configured flags.
Interpreters, Binaries and Flags
Interpreters, Binaries and Flags
- public function getDefaultBinary()
- public function getInstallInstructions()
- public function getUpgradeInstructions() — Return a human-readable string describing how to upgrade the linter.
- public function shouldExpectCommandErrors()
- protected function getMandatoryFlags()
- protected function getDefaultFlags()
- final public function setFlags($flags) — Override default flags with custom flags. If not overridden, flags provided by @{method:getDefaultFlags} are used.
- final public function setVersionRequirement($version) — Set the binary's version requirement.
- final public function getBinary() — Return the binary or script to execute. This method synthesizes defaults and configuration. You can override the binary with @{method:setBinary}.
- final public function setBinary($bin) — Override the default binary with a new one.
- public function shouldUseInterpreter() — Return true if this linter should use an interpreter (like "python" or "node") in addition to the script.
- public function getDefaultInterpreter() — Return the default interpreter, like "python" or "node". This method is only invoked if @{method:shouldUseInterpreter} has been overridden to return `true`.
- final public function getInterpreter() — Get the effective interpreter. This method synthesizes configuration and defaults.
- final public function setInterpreter($interpreter) — Set the interpreter, overriding any default.
Parsing Linter Output
Parsing Linter Output
- protected function parseLinterOutput($path, $err, $stdout, $stderr)
Other Methods
Other Methods
- public function getLinterPriority()
- public function setCustomSeverityMap($map)
- public function addCustomSeverityMap($map)
- public function setCustomSeverityRules($rules)
- final public function getProjectRoot()
- final public function getOtherLocation($offset, $path)
- final public function stopAllLinters()
- final public function didStopAllLinters()
- final public function addPath($path)
- final public function setPaths($paths)
- private function filterPaths($paths) — Filter out paths which this linter doesn't act on (for example, because they are binaries and the linter doesn't apply to binaries).
- final public function getPaths()
- final public function addData($path, $data)
- final protected function getData($path)
- public function getCacheVersion()
- final public function getLintMessageFullCode($short_code)
- final public function getLintMessageSeverity($code)
- protected function getDefaultMessageSeverity($code)
- final public function isMessageEnabled($code)
- final public function getLintMessageName($code)
- final protected function addLintMessage($message)
- final public function getLintMessages()
- final public function raiseLintAtLine($line, $char, $code, $description, $original, $replacement)
- final public function raiseLintAtPath($code, $desc)
- final public function raiseLintAtOffset($offset, $code, $description, $original, $replacement)
- public function canRun()
- public function getLinterName()
- public function getVersion()
- final protected function isCodeEnabled($code)
- public function getLintSeverityMap()
- public function getLintNameMap()
- public function getCacheGranularity()
- public function getLinterConfigurationName()
- public function getLinterConfigurationOptions()
- public function setLinterConfigurationValue($key, $value)
- protected function canCustomizeLintSeverities()
- protected function shouldLintBinaryFiles()
- protected function shouldLintDeletedFiles()
- protected function shouldLintDirectories()
- protected function shouldLintSymbolicLinks()
- protected function getLintCodeFromLinterConfigurationKey($code)
- protected function buildFutures($paths)
- protected function resolveFuture($path, $future)
- final protected function getFuturesLimit()
- protected function didResolveLinterFutures($futures) — Hook for cleaning up resources.
- final public function checkBinaryConfiguration() — Check that the binary and interpreter (if applicable) exist, and throw an exception with a message about how to install them if they do not.
- final protected function checkBinaryVersion($version) — If a binary version requirement has been specified, compare the version of the configured binary to the required version, and if the binary's version is not supported, throw an exception.
- protected function getPathArgumentForLinterFuture($path) — Prepare the path to be added to the command string.