revi-archive/phorge-arcanist
1
0
Fork 0
mirror of https://we.phorge.it/source/arcanist.git synced 2024-11-09 16:32:39 +01:00
Code Issues Releases Wiki Activity

When lint identifies an unknown symbol, attempt to correct it if it is miscapitalized

Browse source 
Summary:
Ref T13598. If you spell a symbol like "Polygon" as "PoLyGoN", you currently get an "unknown symbol" lint message. However, provided "Polygon" is a valid symbol, we can unambiguously correct the spelling of the symbol.

Note that this patch can only correct the spelling of application symbols, not builtin symbols (since none of the library maps contain builtin symbols).

Test Plan: {F8374599}

Maniphest Tasks: T13598

Differential Revision: https://secure.phabricator.com/D21537
This commit is contained in:
epriestley 2021-02-03 08:23:46 -08:00
parent b2e715fc5a
commit 08dbbbba5a
1 changed files with 146 additions and 40 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

186
src/lint/linter/ArcanistPhutilLibraryLinter.php
View file

@ -13,6 +13,7 @@ final class ArcanistPhutilLibraryLinter extends ArcanistLinter {
const LINT_UNKNOWN_SYMBOL = 1; const LINT_UNKNOWN_SYMBOL = 1;
const LINT_DUPLICATE_SYMBOL = 2; const LINT_DUPLICATE_SYMBOL = 2;
const LINT_ONE_CLASS_PER_FILE = 3; const LINT_ONE_CLASS_PER_FILE = 3;
const LINT_NONCANONICAL_SYMBOL = 4;
public function getInfoName() { public function getInfoName() {
return pht('Phutil Library Linter'); return pht('Phutil Library Linter');
@ -43,6 +44,7 @@ final class ArcanistPhutilLibraryLinter extends ArcanistLinter {
self::LINT_UNKNOWN_SYMBOL => pht('Unknown Symbol'), self::LINT_UNKNOWN_SYMBOL => pht('Unknown Symbol'),
self::LINT_DUPLICATE_SYMBOL => pht('Duplicate Symbol'), self::LINT_DUPLICATE_SYMBOL => pht('Duplicate Symbol'),
self::LINT_ONE_CLASS_PER_FILE => pht('One Class Per File'), self::LINT_ONE_CLASS_PER_FILE => pht('One Class Per File'),
self::LINT_NONCANONICAL_SYMBOL => pht('Noncanonical Symbol'),
); );
} }
@ -123,14 +125,29 @@ final class ArcanistPhutilLibraryLinter extends ArcanistLinter {
} }
} }
$libtype_map = array(
'class' => 'class',
'function' => 'function',
'interface' => 'class',
'class/interface' => 'class',
);
// Check for duplicate symbols: two files providing the same class or // Check for duplicate symbols: two files providing the same class or
// function. // function. While doing this, we also build a map of normalized symbol
// names to original symbol names: we want a definition of "idx()" to
// collide with a definition of "IdX()", and want to perform spelling
// corrections later.
$normal_symbols = array();
foreach ($map as $file => $spec) { foreach ($map as $file => $spec) {
$have = idx($spec, 'have', array()); $have = idx($spec, 'have', array());
foreach (array('class', 'function', 'interface') as $type) { foreach (array('class', 'function', 'interface') as $type) {
$libtype = ($type == 'interface') ? 'class' : $type; $libtype = $libtype_map[$type];
foreach (idx($have, $type, array()) as $symbol => $offset) { foreach (idx($have, $type, array()) as $symbol => $offset) {
if (empty($all_symbols[$libtype][$symbol])) { $normal_symbol = $this->normalizeSymbol($symbol);
if (empty($normal_symbols[$libtype][$normal_symbol])) {
$normal_symbols[$libtype][$normal_symbol] = $symbol;
$all_symbols[$libtype][$symbol] = array( $all_symbols[$libtype][$symbol] = array(
'library' => $library, 'library' => $library,
'file' => $file, 'file' => $file,
@ -139,8 +156,9 @@ final class ArcanistPhutilLibraryLinter extends ArcanistLinter {
continue; continue;
} }
$osrc = $all_symbols[$libtype][$symbol]['file']; $old_symbol = $normal_symbols[$libtype][$normal_symbol];
$olib = $all_symbols[$libtype][$symbol]['library']; $old_src = $all_symbols[$libtype][$old_symbol]['file'];
$old_lib = $all_symbols[$libtype][$old_symbol]['library'];
$this->raiseLintInLibrary( $this->raiseLintInLibrary(
$library, $library,
@ -148,14 +166,15 @@ final class ArcanistPhutilLibraryLinter extends ArcanistLinter {
$offset, $offset,
self::LINT_DUPLICATE_SYMBOL, self::LINT_DUPLICATE_SYMBOL,
pht( pht(
"Definition of %s '%s' in '%s' in library '%s' duplicates ". 'Definition of symbol "%s" (of type "%s") in file "%s" in '.
"prior definition in '%s' in library '%s'.", 'library "%s" duplicates prior definition in file "%s" in '.
$type, 'library "%s".',
$symbol, $symbol,
$type,
$file, $file,
$library, $library,
$osrc, $old_src,
$olib)); $old_lib));
} }
} }
} }
@ -169,61 +188,148 @@ final class ArcanistPhutilLibraryLinter extends ArcanistLinter {
foreach ($map as $file => $spec) { foreach ($map as $file => $spec) {
$need = idx($spec, 'need', array()); $need = idx($spec, 'need', array());
foreach ($types as $type) { foreach ($types as $type) {
$libtype = $type; $libtype = $libtype_map[$type];
if ($type == 'interface' || $type == 'class/interface') {
$libtype = 'class';
}
foreach (idx($need, $type, array()) as $symbol => $offset) { foreach (idx($need, $type, array()) as $symbol => $offset) {
if (!empty($all_symbols[$libtype][$symbol])) { if (!empty($all_symbols[$libtype][$symbol])) {
// Symbol is defined somewhere. // Symbol is defined somewhere.
continue; continue;
} }
$libphutil_root = dirname(phutil_get_library_root('arcanist')); $normal_symbol = $this->normalizeSymbol($symbol);
if (!empty($normal_symbols[$libtype][$normal_symbol])) {
$proper_symbol = $normal_symbols[$libtype][$normal_symbol];
switch ($type) {
case 'class':
$summary = pht(
'Class symbol "%s" should be written as "%s".',
$symbol,
$proper_symbol);
break;
case 'function':
$summary = pht(
'Function symbol "%s" should be written as "%s".',
$symbol,
$proper_symbol);
break;
case 'interface':
$summary = pht(
'Interface symbol "%s" should be written as "%s".',
$symbol,
$proper_symbol);
break;
case 'class/interface':
$summary = pht(
'Class or interface symbol "%s" should be written as "%s".',
$symbol,
$proper_symbol);
break;
default:
throw new Exception(
pht('Unknown symbol type "%s".', $type));
}
$this->raiseLintInLibrary(
$library,
$file,
$offset,
self::LINT_NONCANONICAL_SYMBOL,
$summary,
$symbol,
$proper_symbol);
continue;
}
$arcanist_root = dirname(phutil_get_library_root('arcanist'));
switch ($type) {
case 'class':
$summary = pht(
'Use of unknown class symbol "%s".',
$symbol);
break;
case 'function':
$summary = pht(
'Use of unknown function symbol "%s".',
$symbol);
break;
case 'interface':
$summary = pht(
'Use of unknown interface symbol "%s".',
$symbol);
break;
case 'class/interface':
$summary = pht(
'Use of unknown class or interface symbol "%s".',
$symbol);
break;
}
$details = pht(
"Common causes are:\n".
"\n".
" - Your copy of Arcanist is out of date.\n".
" This is the most common cause.\n".
" Update this copy of Arcanist:\n".
"\n".
" %s\n".
"\n".
" - Some other library is out of date.\n".
" Update the library this symbol appears in.\n".
"\n".
" - The symbol is misspelled.\n".
" Spell the symbol name correctly.\n".
"\n".
" - You added the symbol recently, but have not updated\n".
" the symbol map for the library.\n".
" Run \"arc liberate\" in the library where the symbol is\n".
" defined.\n".
"\n".
" - This symbol is defined in an external library.\n".
" Use \"@phutil-external-symbol\" to annotate it.\n".
" Use \"grep\" to find examples of usage.",
$arcanist_root);
$message = implode(
"\n\n",
array(
$summary,
$details,
));
$this->raiseLintInLibrary( $this->raiseLintInLibrary(
$library, $library,
$file, $file,
$offset, $offset,
self::LINT_UNKNOWN_SYMBOL, self::LINT_UNKNOWN_SYMBOL,
pht( $message);
"Use of unknown %s '%s'. Common causes are:\n\n".
" - Your %s is out of date.\n".
" This is the most common cause.\n".
" Update this copy of libphutil: %s\n\n".
" - Some other library is out of date.\n".
" Update the library this symbol appears in.\n\n".
" - This symbol is misspelled.\n".
" Spell the symbol name correctly.\n".
" Symbol name spelling is case-sensitive.\n\n".
" - This symbol was added recently.\n".
" Run `%s` on the library it was added to.\n\n".
" - This symbol is external. Use `%s`.\n".
" Use `%s` to find usage examples of this directive.\n\n".
"*** ALTHOUGH USUALLY EASY TO FIX, THIS IS A SERIOUS ERROR.\n".
"*** THIS ERROR IS YOUR FAULT. YOU MUST RESOLVE IT.",
$type,
$symbol,
'libphutil/',
$libphutil_root,
'arc liberate',
'@phutil-external-symbol',
'grep'));
} }
} }
} }
} }
} }
private function raiseLintInLibrary($library, $path, $offset, $code, $desc) { private function raiseLintInLibrary(
$library,
$path,
$offset,
$code,
$desc,
$original = null,
$replacement = null) {
$root = phutil_get_library_root($library); $root = phutil_get_library_root($library);
$this->activePath = $root.'/'.$path; $this->activePath = $root.'/'.$path;
$this->raiseLintAtOffset($offset, $code, $desc); $this->raiseLintAtOffset($offset, $code, $desc, $original, $replacement);
} }
public function lintPath($path) { public function lintPath($path) {
return; return;
} }
private function normalizeSymbol($symbol) {
return phutil_utf8_strtolower($symbol);
}
} }