No OneTemporary
Actions

Size

6 KB

Referenced Files

None

Subscribers

None

View Options

	diff --git a/src/lint/engine/ArcanistConfigurationDrivenLintEngine.php b/src/lint/engine/ArcanistConfigurationDrivenLintEngine.php
	index 08e5aba2..ef12f765 100644
	--- a/src/lint/engine/ArcanistConfigurationDrivenLintEngine.php
	+++ b/src/lint/engine/ArcanistConfigurationDrivenLintEngine.php
	@@ -1,198 +1,198 @@
	<?php

	final class ArcanistConfigurationDrivenLintEngine extends ArcanistLintEngine {

	public function buildLinters() {
	$working_copy = $this->getWorkingCopy();
	$config_path = $working_copy->getProjectPath('.arclint');

	if (!Filesystem::pathExists($config_path)) {
	throw new Exception(
	"Unable to find '.arclint' file to configure linters. Create a ".
	"'.arclint' file in the root directory of the working copy.");
	}

	$data = Filesystem::readFile($config_path);
	$config = json_decode($data, true);
	if (!is_array($config)) {
	throw new Exception(
	"Expected '.arclint' file to be a valid JSON file, but failed to ".
	"decode it: {$config_path}");
	}

	$linters = $this->loadAvailableLinters();

	PhutilTypeSpec::checkMap(
	$config,
	array(
	'linters' => 'map<string, map<string, wild>>',
	));

	$built_linters = array();
	$all_paths = $this->getPaths();
	foreach ($config['linters'] as $name => $spec) {
	$type = idx($spec, 'type');
	if ($type !== null) {
	if (empty($linters[$type])) {
	$list = implode(', ', array_keys($linters));
	throw new Exception(
	"Linter '{$name}' specifies invalid type '{$type}'. Available ".
	"linters are: {$list}.");
	}

	$linter = clone $linters[$type];
	$linter->setEngine($this);
	$more = $linter->getLinterConfigurationOptions();
	} else {
	// We'll raise an error below about the invalid "type" key.
	$linter = null;
	$more = array();
	}

	PhutilTypeSpec::checkMap(
	$spec,
	array(
	'type' => 'string',
	'include' => 'optional string \| list<string>',
	'exclude' => 'optional string \| list<string>',
	) + $more);

	foreach ($more as $key => $value) {
	if (array_key_exists($key, $spec)) {
	try {
	$linter->setLinterConfigurationValue($key, $spec[$key]);
	} catch (Exception $ex) {
	$message = pht(
	'Error in parsing ".arclint" file, in key "%s" for '.
	'linter "%s": %s',
	$key,
	$name,
	$ex->getMessage());
	throw new PhutilProxyException($message, $ex);
	}
	}
	}

	$include = (array)idx($spec, 'include', array());
	$exclude = (array)idx($spec, 'exclude', array());

	$this->validateRegexps($include, $name, 'include');
	$this->validateRegexps($exclude, $name, 'exclude');

	$console = PhutilConsole::getConsole();
	$console->writeLog("Examining paths for linter \"%s\".\n", $name);
	$paths = $this->matchPaths($all_paths, $include, $exclude);
	$console->writeLog(
	"Found %d matching paths for linter \"%s\".\n",
	count($paths),
	$name);

	$linter->setPaths($paths);


	$built_linters[] = $linter;
	}

	return $built_linters;
	}

	private function loadAvailableLinters() {
	$linters = id(new PhutilSymbolLoader())
	->setAncestorClass('ArcanistLinter')
	->loadObjects();

	$map = array();
	foreach ($linters as $linter) {
	$name = $linter->getLinterConfigurationName();

	// This linter isn't selectable through configuration.
	if ($name === null) {
	continue;
	}

	if (empty($map[$name])) {
	$map[$name] = $linter;
	continue;
	}

	$orig_class = get_class($map[$name]);
	$this_class = get_class($linter);
	throw new Exception(
	"Two linters ({$orig_class}, {$this_class}) both have the same ".
	"configuration name ({$name}). Linters must have unique configuration ".
	"names.");
	}

	return $map;
	}

	private function matchPaths(array $paths, array $include, array $exclude) {
	$console = PhutilConsole::getConsole();

	$match = array();
	foreach ($paths as $path) {
	$console->writeLog("Examining path '%s'...\n", $path);

	$keep = false;
	if (!$include) {
	$keep = true;
	$console->writeLog(
	" Including path by default because there is no 'include' rule.\n");
	} else {
	$console->writeLog(" Testing \"include\" rules.\n");
	foreach ($include as $rule) {
	if (preg_match($rule, $path)) {
	$keep = true;
	$console->writeLog(" Path matches include rule: %s\n", $rule);
	break;
	} else {
	$console->writeLog(
	" Path does not match include rule: %s\n",
	$rule);
	}
	}
	}

	if (!$keep) {
	- $console->writeLogLog(
	+ $console->writeLog(
	" Path does not match any include rules, discarding.\n");
	continue;
	}

	if ($exclude) {
	$console->writeLog(" Testing \"exclude\" rules.\n");
	foreach ($exclude as $rule) {
	if (preg_match($rule, $path)) {
	$console->writeLog(" Path matches \"exclude\" rule: %s\n", $rule);
	continue 2;
	} else {
	$console->writeLog(
	" Path does not match \"exclude\" rule: %s\n",
	$rule);
	}
	}
	}

	$console->writeLog(" Path matches.\n");
	$match[] = $path;
	}

	return $match;
	}

	private function validateRegexps(array $regexps, $linter, $config) {
	foreach ($regexps as $regexp) {
	$ok = @preg_match($regexp, '');
	if ($ok === false) {
	throw new Exception(
	pht(
	'Regular expression "%s" (in "%s" configuration for linter "%s") '.
	'is not a valid regular expression.',
	$regexp,
	$config,
	$linter));
	}
	}
	}

	}

File Metadata

Mime Type: text/x-diff
Expires: Sun, Jan 19, 18:03 (1 w, 5 d ago)
Storage Engine: blob
Storage Format: Raw Data
Storage Handle: 1127225
Default Alt Text: (6 KB)

No OneTemporaryActions

View Options

File Metadata

Event Timeline

No OneTemporary
Actions