mirror of
https://github.com/danog/psalm.git
synced 2025-01-23 06:11:25 +01:00
Merge pull request #9813 from 2e3s/recursive-glob
Add a support for multilevel glob wildcards
This commit is contained in:
orklah
GitHub
commit
b99857cb9c
@ -10,12 +10,17 @@ use SimpleXMLElement;
|
||||
|
||||
use function array_filter;
|
||||
use function array_map;
|
||||
use function array_merge;
|
||||
use function array_shift;
|
||||
use function count;
|
||||
use function explode;
|
||||
use function glob;
|
||||
use function in_array;
|
||||
use function is_dir;
|
||||
use function is_iterable;
|
||||
use function preg_match;
|
||||
use function preg_replace;
|
||||
use function preg_split;
|
||||
use function readlink;
|
||||
use function realpath;
|
||||
use function restore_error_handler;
|
||||
@ -129,10 +134,12 @@ class FileFilter
|
||||
}
|
||||
|
||||
if (strpos($prospective_directory_path, '*') !== false) {
|
||||
$globs = array_map(
|
||||
'realpath',
|
||||
glob($prospective_directory_path, GLOB_ONLYDIR),
|
||||
);
|
||||
// Strip meaningless trailing recursive wildcard like "path/**/" or "path/**"
|
||||
$prospective_directory_path = preg_replace('#(\/\*\*)+\/?$#', '/', $prospective_directory_path);
|
||||
// Split by /**/, allow duplicated wildcards like "path/**/**/path" and any leading dir separator.
|
||||
/** @var non-empty-list<non-empty-string> $path_parts */
|
||||
$path_parts = preg_split('#(\/|\\\)(\*\*\/)+#', $prospective_directory_path);
|
||||
$globs = self::recursiveGlob($path_parts, true);
|
||||
|
||||
if (empty($globs)) {
|
||||
if ($allow_missing_files) {
|
||||
@ -145,8 +152,8 @@ class FileFilter
|
||||
);
|
||||
}
|
||||
|
||||
foreach ($globs as $glob_index => $directory_path) {
|
||||
if (!$directory_path) {
|
||||
foreach ($globs as $glob_index => $glob_directory_path) {
|
||||
if (!$glob_directory_path) {
|
||||
if ($allow_missing_files) {
|
||||
continue;
|
||||
}
|
||||
@ -158,14 +165,14 @@ class FileFilter
|
||||
}
|
||||
|
||||
if ($ignore_type_stats && $filter instanceof ProjectFileFilter) {
|
||||
$filter->ignore_type_stats[$directory_path] = true;
|
||||
$filter->ignore_type_stats[$glob_directory_path] = true;
|
||||
}
|
||||
|
||||
if ($declare_strict_types && $filter instanceof ProjectFileFilter) {
|
||||
$filter->declare_strict_types[$directory_path] = true;
|
||||
$filter->declare_strict_types[$glob_directory_path] = true;
|
||||
}
|
||||
|
||||
$filter->addDirectory($directory_path);
|
||||
$filter->addDirectory($glob_directory_path);
|
||||
}
|
||||
continue;
|
||||
}
|
||||
@ -246,13 +253,10 @@ class FileFilter
|
||||
}
|
||||
|
||||
if (strpos($prospective_file_path, '*') !== false) {
|
||||
$globs = array_map(
|
||||
'realpath',
|
||||
array_filter(
|
||||
glob($prospective_file_path, GLOB_NOSORT),
|
||||
'file_exists',
|
||||
),
|
||||
);
|
||||
// Split by /**/, allow duplicated wildcards like "path/**/**/path" and any leading dir separator.
|
||||
/** @var non-empty-list<non-empty-string> $path_parts */
|
||||
$path_parts = preg_split('#(\/|\\\)(\*\*\/)+#', $prospective_file_path);
|
||||
$globs = self::recursiveGlob($path_parts, false);
|
||||
|
||||
if (empty($globs)) {
|
||||
if ($allow_missing_files) {
|
||||
@ -265,14 +269,18 @@ class FileFilter
|
||||
);
|
||||
}
|
||||
|
||||
foreach ($globs as $glob_index => $file_path) {
|
||||
if (!$file_path && !$allow_missing_files) {
|
||||
foreach ($globs as $glob_index => $glob_file_path) {
|
||||
if (!$glob_file_path) {
|
||||
if ($allow_missing_files) {
|
||||
continue;
|
||||
}
|
||||
|
||||
throw new ConfigException(
|
||||
'Could not resolve config path to ' . $base_dir . DIRECTORY_SEPARATOR .
|
||||
$file_path . ':' . $glob_index,
|
||||
);
|
||||
}
|
||||
$filter->addFile($file_path);
|
||||
$filter->addFile($glob_file_path);
|
||||
}
|
||||
continue;
|
||||
}
|
||||
@ -445,6 +453,39 @@ class FileFilter
|
||||
return $is_regexp;
|
||||
}
|
||||
|
||||
/**
|
||||
* @mutation-free
|
||||
* @param non-empty-list<non-empty-string> $parts
|
||||
* @return array<string|false>
|
||||
*/
|
||||
private static function recursiveGlob(array $parts, bool $only_dir): array
|
||||
{
|
||||
if (count($parts) < 2) {
|
||||
if ($only_dir) {
|
||||
$list = glob($parts[0], GLOB_ONLYDIR | GLOB_NOSORT) ?: [];
|
||||
} else {
|
||||
$list = array_filter(
|
||||
glob($parts[0], GLOB_NOSORT) ?: [],
|
||||
'file_exists',
|
||||
);
|
||||
}
|
||||
|
||||
return array_map('realpath', $list);
|
||||
}
|
||||
|
||||
$first_dir = self::slashify($parts[0]);
|
||||
$paths = glob($first_dir . '*', GLOB_ONLYDIR | GLOB_NOSORT);
|
||||
$result = [];
|
||||
foreach ($paths as $path) {
|
||||
$parts[0] = $path;
|
||||
$result = array_merge($result, self::recursiveGlob($parts, $only_dir));
|
||||
}
|
||||
array_shift($parts);
|
||||
$parts[0] = $first_dir . $parts[0];
|
||||
|
||||
return array_merge($result, self::recursiveGlob($parts, $only_dir));
|
||||
}
|
||||
|
||||
/**
|
||||
* @psalm-pure
|
||||
*/
|
||||
|
||||
@ -233,7 +233,7 @@ class ConfigTest extends TestCase
|
||||
<projectFiles>
|
||||
<directory name="src" />
|
||||
<ignoreFiles>
|
||||
<directory name="src/**/Internal/Analyzer" />
|
||||
<directory name="src/*/Internal/Analyzer" />
|
||||
</ignoreFiles>
|
||||
</projectFiles>
|
||||
</psalm>',
|
||||
@ -248,6 +248,54 @@ class ConfigTest extends TestCase
|
||||
$this->assertFalse($config->isInProjectDirs(realpath('examples/TemplateScanner.php')));
|
||||
}
|
||||
|
||||
public function testIgnoreRecursiveWildcardProjectDirectory(): void
|
||||
{
|
||||
$this->project_analyzer = $this->getProjectAnalyzerWithConfig(
|
||||
Config::loadFromXML(
|
||||
dirname(__DIR__, 2),
|
||||
'<?xml version="1.0"?>
|
||||
<psalm>
|
||||
<projectFiles>
|
||||
<directory name="src" />
|
||||
<ignoreFiles>
|
||||
<directory name="src/**/BinaryOp*" />
|
||||
</ignoreFiles>
|
||||
</projectFiles>
|
||||
</psalm>',
|
||||
),
|
||||
);
|
||||
|
||||
$config = $this->project_analyzer->getConfig();
|
||||
|
||||
$this->assertTrue($config->isInProjectDirs(realpath('src/Psalm/Internal/Analyzer/Statements/Expression/BinaryOpAnalyzer.php')));
|
||||
$this->assertFalse($config->isInProjectDirs(realpath('src/Psalm/Internal/Analyzer/Statements/Expression/BinaryOp/OrAnalyzer.php')));
|
||||
$this->assertFalse($config->isInProjectDirs(realpath('src/Psalm/Node/Expr/BinaryOp/VirtualPlus.php')));
|
||||
}
|
||||
|
||||
public function testIgnoreRecursiveDoubleWildcardProjectFiles(): void
|
||||
{
|
||||
$this->project_analyzer = $this->getProjectAnalyzerWithConfig(
|
||||
Config::loadFromXML(
|
||||
dirname(__DIR__, 2),
|
||||
'<?xml version="1.0"?>
|
||||
<psalm>
|
||||
<projectFiles>
|
||||
<directory name="src" />
|
||||
<ignoreFiles>
|
||||
<file name="src/**/*Analyzer.php" />
|
||||
</ignoreFiles>
|
||||
</projectFiles>
|
||||
</psalm>',
|
||||
),
|
||||
);
|
||||
|
||||
$config = $this->project_analyzer->getConfig();
|
||||
|
||||
$this->assertTrue($config->isInProjectDirs(realpath('src/Psalm/Type.php')));
|
||||
$this->assertFalse($config->isInProjectDirs(realpath('src/Psalm/Internal/Analyzer/FileAnalyzer.php')));
|
||||
$this->assertFalse($config->isInProjectDirs(realpath('src/Psalm/Internal/Analyzer/Statements/ReturnAnalyzer.php')));
|
||||
}
|
||||
|
||||
public function testIgnoreWildcardFiles(): void
|
||||
{
|
||||
$this->project_analyzer = $this->getProjectAnalyzerWithConfig(
|
||||
@ -1682,6 +1730,42 @@ class ConfigTest extends TestCase
|
||||
$this->assertFalse($config->reportIssueInFile('MixedAssignment', realpath('src/Psalm/Type.php')));
|
||||
}
|
||||
|
||||
public function testConfigFileWithWildcardPathIssueHandler(): void
|
||||
{
|
||||
$this->project_analyzer = $this->getProjectAnalyzerWithConfig(
|
||||
Config::loadFromXML(
|
||||
dirname(__DIR__, 2),
|
||||
'<?xml version="1.0"?>
|
||||
<psalm>
|
||||
<projectFiles>
|
||||
<directory name="src" />
|
||||
<directory name="tests" />
|
||||
</projectFiles>
|
||||
|
||||
<issueHandlers>
|
||||
<MissingReturnType>
|
||||
<errorLevel type="suppress">
|
||||
<file name="src/**/*TypeAlias.php" />
|
||||
<directory name="src/**/BinaryOp*" />
|
||||
</errorLevel>
|
||||
</MissingReturnType>
|
||||
</issueHandlers>
|
||||
</psalm>',
|
||||
),
|
||||
);
|
||||
|
||||
$config = $this->project_analyzer->getConfig();
|
||||
|
||||
$this->assertTrue($config->reportIssueInFile('MissingReturnType', realpath(__FILE__)));
|
||||
$this->assertTrue($config->reportIssueInFile('MissingReturnType', realpath('src/Psalm/Type.php')));
|
||||
$this->assertTrue($config->reportIssueInFile('MissingReturnType', realpath('src/Psalm/Internal/Analyzer/Statements/ReturnAnalyzer.php')));
|
||||
|
||||
$this->assertFalse($config->reportIssueInFile('MissingReturnType', realpath('src/Psalm/Node/Expr/BinaryOp/VirtualPlus.php')));
|
||||
$this->assertFalse($config->reportIssueInFile('MissingReturnType', realpath('src/Psalm/Internal/Analyzer/Statements/Expression/BinaryOp/OrAnalyzer.php')));
|
||||
$this->assertFalse($config->reportIssueInFile('MissingReturnType', realpath('src/Psalm/Internal/Type/TypeAlias.php')));
|
||||
$this->assertFalse($config->reportIssueInFile('MissingReturnType', realpath('src/Psalm/Internal/Type/TypeAlias/ClassTypeAlias.php')));
|
||||
}
|
||||
|
||||
/**
|
||||
* @requires extension apcu
|
||||
* @deprecated Remove in Psalm 6.
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user