Differential D14430 Diff 35012 src/lint/linter/ArcanistElixirDogmaLinter.php

Changeset View

Standalone View

src/lint/linter/ArcanistElixirDogmaLinter.php

This file was added.

				<?php

				final class ArcanistElixirDogmaLinter extends ArcanistExternalLinter {

				private $projectRootDir = null;

				public function getInfoName() {
				return 'ElixirDogma';
				}

				public function getInfoURI() {
				return 'https://github.com/lpil/dogma';
				}

				public function getInfoDescription() {
				return pht('A code style linter for Elixir, powered by shame.');
				}

				public function getLinterName() {
				return 'ELIXIRDOGMA';
				}

				public function getLinterConfigurationName() {
				return 'elixirdogma';
				}
				public function getLinterConfigurationOptions() {
				$options = array(
				'elixirdogma.project-root-dir' => array(
				'type' => 'optional string',
				'help' => pht(
				'Adjust the project root directory in which mix is executed.'.
				'This is useful in case the Elixir project\'s root'.
				'resides in a subdirectory of the repository.'),
				),
				);

				return $options + parent::getLinterConfigurationOptions();
				}

				public function setProjectRootDir($new_dir) {
				$this->projectRootDir = $new_dir;
				return $this;
				}

				public function setLinterConfigurationValue($key, $value) {
				switch ($key) {
				case 'elixirdogma.project-root-dir':
				$this->setProjectRootDir($value);
				return;
				}

				return parent::setLinterConfigurationValue($key, $value);
				}

				public function getDefaultBinary() {
				return 'mix';
				}

				protected function getMandatoryFlags() {
				$flags = array();
				if ($this->projectRootDir) {
				$flags[] = 'cmd';
				$flags[] = 'cd '.$this->projectRootDir;
				$flags[] = '&&';
				$flags[] = 'mix';
				}
				$flags[] = 'dogma --format=flycheck';
				return $flags;
				}

				public function getInstallInstructions() {
				return pht(
				'Install dogma by adding it as a dependency to your deps and
				executing mix deps.get');
				}

				public function shouldExpectCommandErrors() {
				return true;
				}

				protected function canCustomizeLintSeverities() {
				return false;
				}

				protected function parseLinterOutput($path, $err, $stdout, $stderr) {
				$lines = phutil_split_lines($stdout, false);

				$messages = array();
				foreach ($lines as $line) {
				$matches = explode(':', $line, 5);

				if (count($matches) === 5) {
				$message = new ArcanistLintMessage();
				$message->setPath($path);
				$message->setLine($matches[1]);
				$message->setChar($matches[2]);
				$message->setCode($this->getLinterName());
				$message->setName($this->getLinterName());
				$message->setDescription(ucfirst(trim($matches[4])));
				$message->setSeverity($this->getSeverity(ucfirst(trim($matches[3]))));

				$messages[] = $message;
				}
				}

				return $messages;
				}

				private function getSeverity($identifier) {
				switch ($identifier) {
				case 'W':
				return ArcanistLintSeverity::SEVERITY_WARNING;
				case 'E':
				return ArcanistLintSeverity::SEVERITY_ERROR;
				}
				return ArcanistLintSeverity::SEVERITY_ADVICE;
				}
				}