Page MenuHomePhorge
Diviner Arcanist Tech Docs ArcanistSingleLintEngine

final class ArcanistSingleLintEngine
Arcanist Technical Documentation (Lint)

Run a single linter on every path unconditionally. This is a glue engine for linters like ArcanistScriptAndRegexLinter, if you are averse to writing a phutil library. Your linter will receive every path, including paths which have been moved or deleted.

Set which linter should be run by configuring lint.engine.single.linter in .arcconfig or user config.

Methods

public function __get($name)
Inherited

This method is not documented.
Parameters
$name
Return
wild

public function __set($name, $value)
Inherited

This method is not documented.
Parameters
$name
$value
Return
wild

public function current()
Inherited

This method is not documented.
Return
wild

public function key()
Inherited

This method is not documented.
Return
wild

public function next()
Inherited

This method is not documented.
Return
wild

public function rewind()
Inherited

This method is not documented.
Return
wild

public function valid()
Inherited

This method is not documented.
Return
wild

private function throwOnAttemptedIteration()
Inherited

This method is not documented.
Return
wild

public function getPhobjectClassConstant($key, $byte_limit)
Inherited

Phobject

Read the value of a class constant.

This is the same as just typing self::CONSTANTNAME, but throws a more useful message if the constant is not defined and allows the constant to be limited to a maximum length.

Parameters
string$keyName of the constant.
int|null$byte_limitMaximum number of bytes permitted in the value.
Return
stringValue of the constant.

public function __construct()
Inherited

This method is not documented.
Return
this//Implicit.//

final public function setConfigurationManager($configuration_manager)
Inherited

This method is not documented.
Parameters
ArcanistConfigurationManager$configuration_manager
Return
wild

final public function getConfigurationManager()
Inherited

This method is not documented.
Return
wild

final public function setWorkingCopy($working_copy)
Inherited

This method is not documented.
Parameters
ArcanistWorkingCopyIdentity$working_copy
Return
wild

final public function getWorkingCopy()
Inherited

This method is not documented.
Return
wild

final public function setPaths($paths)
Inherited

This method is not documented.
Parameters
$paths
Return
wild

public function getPaths()
Inherited

This method is not documented.
Return
wild

final public function setPathChangedLines($path, $changed)
Inherited

This method is not documented.
Parameters
$path
$changed
Return
wild

final public function getPathChangedLines($path)
Inherited

This method is not documented.
Parameters
$path
Return
wild

final public function setFileData($data)
Inherited

This method is not documented.
Parameters
$data
Return
wild

final public function loadData($path)
Inherited

This method is not documented.
Parameters
$path
Return
wild

public function pathExists($path)
Inherited

This method is not documented.
Parameters
$path
Return
wild

final public function isDirectory($path)
Inherited

This method is not documented.
Parameters
$path
Return
wild

final public function isBinaryFile($path)
Inherited

This method is not documented.
Parameters
$path
Return
wild

final public function isSymbolicLink($path)
Inherited

This method is not documented.
Parameters
$path
Return
wild

final public function getFilePathOnDisk($path)
Inherited

This method is not documented.
Parameters
$path
Return
wild

final public function setMinimumSeverity($severity)
Inherited

This method is not documented.
Parameters
$severity
Return
wild

final public function run()
Inherited

This method is not documented.
Return
wild

final public function isSeverityEnabled($severity)
Inherited

This method is not documented.
Parameters
$severity
Return
wild

private function shouldUseCache($cache_granularity, $repository_version)
Inherited

This method is not documented.
Parameters
$cache_granularity
$repository_version
Return
wild

final public function setCachedResults($results)
Inherited

This method is not documented.
Parameters
dict<string$resultspath, dict<string version, list<dict message>>>
Return
this

final public function getResults()
Inherited

This method is not documented.
Return
wild

final public function getStoppedPaths()
Inherited

This method is not documented.
Return
wild

public function buildLinters()

This method is not documented.
Return
wild

final public function setRepositoryVersion($version)
Inherited

This method is not documented.
Parameters
$version
Return
wild

private function isRelevantMessage($message)
Inherited

This method is not documented.
Parameters
ArcanistLintMessage$message
Return
wild

final protected function getResultForPath($path)
Inherited

This method is not documented.
Parameters
$path
Return
wild

final public function getLineAndCharFromOffset($path, $offset)
Inherited

This method is not documented.
Parameters
$path
$offset
Return
wild

protected function getCacheVersion()
Inherited

This method is not documented.
Return
wild

public function getLinterResource($key, $default)
Inherited

ArcanistLintEngine

Get a named linter resource shared by another linter.

This mechanism allows linters to share arbitrary resources, like the results of computation. If several linters need to perform the same expensive computation step, they can use a named resource to synchronize construction of the result so it doesn't need to be built multiple times.

Parameters
string$keyResource identifier.
wild$defaultOptionally, default value to return if resource does not exist.
Return
wildResource, or default value if not present.

public function setLinterResource($key, $value)
Inherited

ArcanistLintEngine

Set a linter resource that other linters can access.

See getLinterResource() for a description of this mechanism.

Parameters
string$keyResource identifier.
wild$valueResource.
Return
this

private function getRunnableLinters($linters)
Inherited

This method is not documented.
Parameters
array$linters
Return
wild

private function executeLinters($runnable)
Inherited

This method is not documented.
Parameters
array$runnable
Return
wild

private function executeLintersOnChunk($runnable, $path_list)
Inherited

This method is not documented.
Parameters
array$runnable
array$path_list
Return
wild

private function beginLintServiceCall($linter, $paths)
Inherited

This method is not documented.
Parameters
ArcanistLinter$linter
array$paths
Return
wild

private function endLintServiceCall($call_id)
Inherited

This method is not documented.
Parameters
$call_id
Return
wild

private function executeLinterOnPaths($linter, $paths)
Inherited

This method is not documented.
Parameters
ArcanistLinter$linter
array$paths
Return
wild

private function executeDidLintOnPaths($linter, $paths)
Inherited

This method is not documented.
Parameters
ArcanistLinter$linter
array$paths
Return
wild

private function validateLintMessage($linter, $message)
Inherited

This method is not documented.
Parameters
ArcanistLinter$linter
ArcanistLintMessage$message
Return
wild
Defined
src/lint/engine/ArcanistSingleLintEngine.php:12
Extends
PhobjectArcanistLintEngine
Content licensed under Creative Commons Attribution-ShareAlike 4.0 (CC-BY-SA) unless otherwise noted; code licensed under Apache 2.0 or other open source licenses. · CC BY-SA 4.0 · Apache 2.0