No OneTemporary
Actions

Size

11 KB

Referenced Files

None

Subscribers

None

View Options

	diff --git a/src/workflow/lint/ArcanistLintWorkflow.php b/src/workflow/lint/ArcanistLintWorkflow.php
	index 2ebc656d..9d50e356 100644
	--- a/src/workflow/lint/ArcanistLintWorkflow.php
	+++ b/src/workflow/lint/ArcanistLintWorkflow.php
	@@ -1,362 +1,362 @@
	<?php

	/*
	* Copyright 2012 Facebook, Inc.
	*
	* Licensed under the Apache License, Version 2.0 (the "License");
	* you may not use this file except in compliance with the License.
	* You may obtain a copy of the License at
	*
	* http://www.apache.org/licenses/LICENSE-2.0
	*
	* Unless required by applicable law or agreed to in writing, software
	* distributed under the License is distributed on an "AS IS" BASIS,
	* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
	* See the License for the specific language governing permissions and
	* limitations under the License.
	*/

	/**
	* Runs lint rules on changes.
	*
	* @group workflow
	*/
	class ArcanistLintWorkflow extends ArcanistBaseWorkflow {

	const RESULT_OKAY = 0;
	const RESULT_WARNINGS = 1;
	const RESULT_ERRORS = 2;
	const RESULT_SKIP = 3;

	private $unresolvedMessages;
	private $shouldAmendChanges = false;
	private $shouldAmendWithoutPrompt = false;
	private $shouldAmendAutofixesWithoutPrompt = false;

	public function setShouldAmendChanges($should_amend) {
	$this->shouldAmendChanges = $should_amend;
	return $this;
	}

	public function setShouldAmendWithoutPrompt($should_amend) {
	$this->shouldAmendWithoutPrompt = $should_amend;
	return $this;
	}

	public function setShouldAmendAutofixesWithoutPrompt($should_amend) {
	$this->shouldAmendAutofixesWithoutPrompt = $should_amend;
	return $this;
	}

	public function getCommandSynopses() {
	return phutil_console_format(<<<EOTEXT
	lint [__options__] [__paths__]
	lint [__options__] --rev [__rev__]
	EOTEXT
	);
	}

	public function getCommandHelp() {
	return phutil_console_format(<<<EOTEXT
	Supports: git, svn, hg
	Run static analysis on changes to check for mistakes. If no files
	are specified, lint will be run on all files which have been modified.
	EOTEXT
	);
	}

	public function getArguments() {
	return array(
	'lintall' => array(
	'help' =>
	"Show all lint warnings, not just those on changed lines."
	),
	'rev' => array(
	'param' => 'revision',
	'help' => "Lint changes since a specific revision.",
	'supports' => array(
	'git',
	'hg',
	),
	'nosupport' => array(
	'svn' => "Lint does not currently support --rev in SVN.",
	),
	),
	'output' => array(
	'param' => 'format',
	'help' =>
	"With 'summary', show lint warnings in a more compact format. ".
	"With 'json', show lint warnings in machine-readable JSON format. ".
	"With 'compiler', show lint warnings in suitable for your editor."
	),
	'advice' => array(
	'help' =>
	"Show lint advice, not just warnings and errors."
	),
	'engine' => array(
	'param' => 'classname',
	'help' =>
	"Override configured lint engine for this project."
	),
	'apply-patches' => array(
	'help' =>
	'Apply patches suggested by lint to the working copy without '.
	'prompting.',
	'conflicts' => array(
	'never-apply-patches' => true,
	),
	),
	'never-apply-patches' => array(
	'help' => 'Never apply patches suggested by lint.',
	'conflicts' => array(
	'apply-patches' => true,
	),
	),
	'amend-all' => array(
	'help' =>
	'When linting git repositories, amend HEAD with all patches '.
	'suggested by lint without prompting.',
	),
	'amend-autofixes' => array(
	'help' =>
	- 'When linting git repositories, amend HEAD with autofix '.
	- 'patches suggested by lint without prompting.',
	+ 'When linting git repositories, amend HEAD with autofix '.
	+ 'patches suggested by lint without prompting.',
	),
	'*' => 'paths',
	);
	}

	public function requiresWorkingCopy() {
	return true;
	}

	public function requiresRepositoryAPI() {
	return true;
	}

	public function run() {
	$working_copy = $this->getWorkingCopy();

	$engine = $this->getArgument('engine');
	if (!$engine) {
	$engine = $working_copy->getConfig('lint_engine');
	if (!$engine) {
	throw new ArcanistNoEngineException(
	"No lint engine configured for this project. Edit .arcconfig to ".
	"specify a lint engine.");
	}
	}

	$rev = $this->getArgument('rev');
	$paths = $this->getArgument('paths');

	if ($rev && $paths) {
	throw new ArcanistUsageException("Specify either --rev or paths.");
	}

	$should_lint_all = $this->getArgument('lintall');
	if ($paths) {
	// NOTE: When the user specifies paths, we imply --lintall and show all
	// warnings for the paths in question. This is easier to deal with for
	// us and less confusing for users.
	$should_lint_all = true;
	}

	$paths = $this->selectPathsForWorkflow($paths, $rev);

	PhutilSymbolLoader::loadClass($engine);
	if (!is_subclass_of($engine, 'ArcanistLintEngine')) {
	throw new ArcanistUsageException(
	"Configured lint engine '{$engine}' is not a subclass of ".
	"'ArcanistLintEngine'.");
	}

	$engine = newv($engine, array());
	$engine->setWorkingCopy($working_copy);

	if ($this->getArgument('advice')) {
	$engine->setMinimumSeverity(ArcanistLintSeverity::SEVERITY_ADVICE);
	} else {
	$engine->setMinimumSeverity(ArcanistLintSeverity::SEVERITY_AUTOFIX);
	}

	// Propagate information about which lines changed to the lint engine.
	// This is used so that the lint engine can drop warning messages
	// concerning lines that weren't in the change.
	$engine->setPaths($paths);
	if (!$should_lint_all) {
	foreach ($paths as $path) {
	// Note that getChangedLines() returns null to indicate that a file
	// is binary or a directory (i.e., changed lines are not relevant).
	$engine->setPathChangedLines(
	$path,
	$this->getChangedLines($path, 'new'));
	}
	}

	$results = $engine->run();

	if ($this->getArgument('never-apply-patches')) {
	$apply_patches = false;
	} else {
	$apply_patches = true;
	}

	if ($this->getArgument('apply-patches')) {
	$prompt_patches = false;
	} else {
	$prompt_patches = true;
	}

	if ($this->getArgument('amend-all')) {
	$this->shouldAmendChanges = true;
	$this->shouldAmendWithoutPrompt = true;
	}

	if ($this->getArgument('amend-autofixes')) {
	$prompt_autofix_patches = false;
	$this->shouldAmendChanges = true;
	$this->shouldAmendAutofixesWithoutPrompt = true;
	} else {
	$prompt_autofix_patches = true;
	}

	$wrote_to_disk = false;

	switch ($this->getArgument('output')) {
	case 'json':
	$renderer = new ArcanistLintJSONRenderer();
	$prompt_patches = false;
	$apply_patches = $this->getArgument('apply-patches');
	break;
	case 'summary':
	$renderer = new ArcanistLintSummaryRenderer();
	break;
	case 'compiler':
	$renderer = new ArcanistLintLikeCompilerRenderer();
	$prompt_patches = false;
	$apply_patches = $this->getArgument('apply-patches');
	break;
	default:
	$renderer = new ArcanistLintRenderer();
	$renderer->setShowAutofixPatches($prompt_autofix_patches);
	break;
	}

	$all_autofix = true;

	foreach ($results as $result) {
	$result_all_autofix = $result->isAllAutofix();

	if (!$result->getMessages() && !$result_all_autofix) {
	continue;
	}

	if (!$result_all_autofix) {
	$all_autofix = false;
	}

	$lint_result = $renderer->renderLintResult($result);
	if ($lint_result) {
	echo $lint_result;
	}

	if ($apply_patches && $result->isPatchable()) {
	$patcher = ArcanistLintPatcher::newFromArcanistLintResult($result);
	$old = $patcher->getUnmodifiedFileContent();
	$new = $patcher->getModifiedFileContent();

	if ($prompt_patches &&
	!($result_all_autofix && !$prompt_autofix_patches)) {
	$old_file = $result->getFilePathOnDisk();
	if (!Filesystem::pathExists($old_file)) {
	$old_file = '/dev/null';
	}
	$new_file = new TempFile();
	Filesystem::writeFile($new_file, $new);

	// TODO: Improve the behavior here, make it more like
	// difference_render().
	passthru(csprintf("diff -u %s %s", $old_file, $new_file));

	$prompt = phutil_console_format(
	"Apply this patch to __%s__?",
	$result->getPath());
	if (!phutil_console_confirm($prompt, $default_no = false)) {
	continue;
	}
	}

	$patcher->writePatchToDisk();
	$wrote_to_disk = true;
	}
	}

	$repository_api = $this->getRepositoryAPI();
	if ($wrote_to_disk &&
	($repository_api instanceof ArcanistGitAPI) &&
	$this->shouldAmendChanges) {

	if ($this->shouldAmendWithoutPrompt \|\|
	($this->shouldAmendAutofixesWithoutPrompt && $all_autofix)) {
	echo phutil_console_format(
	"<bg:yellow> LINT NOTICE </bg> Automatically amending HEAD ".
	"with lint patches.\n");
	$amend = true;
	} else {
	$amend = phutil_console_confirm("Amend HEAD with lint patches?");
	}

	if ($amend) {
	execx(
	'(cd %s; git commit -a --amend -C HEAD)',
	$repository_api->getPath());
	} else {
	throw new ArcanistUsageException(
	"Sort out the lint changes that were applied to the working ".
	"copy and relint.");
	}
	}

	$unresolved = array();
	$has_warnings = false;
	$has_errors = false;

	foreach ($results as $result) {
	foreach ($result->getMessages() as $message) {
	if (!$message->isPatchApplied()) {
	if ($message->isError()) {
	$has_errors = true;
	} else if ($message->isWarning()) {
	$has_warnings = true;
	}
	$unresolved[] = $message;
	}
	}
	}
	$this->unresolvedMessages = $unresolved;

	// Take the most severe lint message severity and use that
	// as the result code.
	if ($has_errors) {
	$result_code = self::RESULT_ERRORS;
	} else if ($has_warnings) {
	$result_code = self::RESULT_WARNINGS;
	} else {
	$result_code = self::RESULT_OKAY;
	}

	if (!$this->getParentWorkflow()) {
	if ($result_code == self::RESULT_OKAY) {
	echo $renderer->renderOkayResult();
	}
	}

	return $result_code;
	}

	public function getUnresolvedMessages() {
	return $this->unresolvedMessages;
	}

	}

File Metadata

Mime Type: text/x-diff
Expires: Jan 19 2025, 12:00 (4 w, 5 d ago)
Storage Engine: blob
Storage Format: Raw Data
Storage Handle: 1124326
Default Alt Text: (11 KB)

No OneTemporaryActions

View Options

File Metadata

Event Timeline

No OneTemporary
Actions