Page MenuHomePhorge
Diviner Arcanist Tech Docs ArcanistLinterStandard

abstract class ArcanistLinterStandard
Arcanist Technical Documentation (Lint)

A "linter standard" is a collection of linter rules with associated severities and configuration.

Basically, a linter standard allows a set of linter rules and configuration to be easily reused across multiple repositories without duplicating the contents of the .arclint file (and the associated maintenance costs in keeping changes to this file synchronized).

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.

abstract public function getKey()

Returns a unique identifier for the linter standard.

Return
string

abstract public function getName()

Returns a human-readable name for the linter standard.

Return
string

abstract public function getDescription()

Returns a human-readable description for the linter standard.

Return
string

abstract public function supportsLinter($linter)

Checks whether the linter standard supports a specified linter.

Parameters
ArcanistLinter$linterThe linter which is being configured.
Return
boolTrue if the linter standard supports the specified linter, otherwise false.

public function getLinterConfiguration()

Get linter configuration.

Returns linter configuration which is passed to ArcanistLinter::setLinterConfigurationValue().

Return
map<string, wild>

public function getLinterSeverityMap()

Get linter severities.

Returns linter severities which are passed to ArcanistLinter::addCustomSeverityMap().

Return
map

final public static function getStandard($key, $linter)

Load a linter standard by key.

Parameters
string$key
ArcanistLinter$linter
Return
ArcanistLinterStandard

final public static function loadAllStandards()

Load all linter standards.

Return
list<ArcanistLinterStandard>

final public static function loadAllStandardsForLinter($linter)

Load all linter standards which support a specified linter.

Parameters
ArcanistLinter$linter
Return
list<ArcanistLinterStandard>