danog/psalm
1
0
Fork 0
mirror of https://github.com/danog/psalm.git synced 2025-01-22 05:41:20 +01:00
Code Issues Projects Releases Wiki Activity

Merge pull request #6895 from orklah/ignore-falsable

Browse Source 
make ignore falsable/nullable dependent on the config
This commit is contained in:
orklah 2021-11-13 11:37:57 +01:00 committed by GitHub
commit b35b9f92a6
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 88 additions and 91 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

135
src/Psalm/Config.php
View File

@ -552,6 +552,11 @@ class Config
*/
public $trigger_error_exits = 'default';
/**
* @var string[]
*/
public $internal_stubs = [];
protected function __construct()
{
self::$instance = $this;
@ -769,7 +774,9 @@ class Config
];
$config->config_issues = [];
$attributes = $dom_document->getElementsByTagName('psalm')->item(0)->attributes;
$psalm_element_item = $dom_document->getElementsByTagName('psalm')->item(0);
assert($psalm_element_item !== null);
$attributes = $psalm_element_item->attributes;
foreach ($attributes as $attribute) {
if (in_array($attribute->name, $deprecated_attributes, true)) {
$line = $attribute->getLineNo();
@ -1864,93 +1871,59 @@ class Config
$codebase->register_stub_files = true;
$core_generic_files = [
dirname(__DIR__, 2) . '/stubs/CoreGenericFunctions.phpstub',
dirname(__DIR__, 2) . '/stubs/CoreGenericClasses.phpstub',
dirname(__DIR__, 2) . '/stubs/CoreGenericIterators.phpstub',
dirname(__DIR__, 2) . '/stubs/CoreImmutableClasses.phpstub',
dirname(__DIR__, 2) . '/stubs/DOM.phpstub',
dirname(__DIR__, 2) . '/stubs/Reflection.phpstub',
dirname(__DIR__, 2) . '/stubs/SPL.phpstub',
$dir_lvl_2 = dirname(__DIR__, 2);
$this->internal_stubs = [
$dir_lvl_2 . DIRECTORY_SEPARATOR . 'stubs' . DIRECTORY_SEPARATOR . 'CoreGenericFunctions.phpstub',
$dir_lvl_2 . DIRECTORY_SEPARATOR . 'stubs' . DIRECTORY_SEPARATOR . 'CoreGenericClasses.phpstub',
$dir_lvl_2 . DIRECTORY_SEPARATOR . 'stubs' . DIRECTORY_SEPARATOR . 'CoreGenericIterators.phpstub',
$dir_lvl_2 . DIRECTORY_SEPARATOR . 'stubs' . DIRECTORY_SEPARATOR . 'CoreImmutableClasses.phpstub',
$dir_lvl_2 . DIRECTORY_SEPARATOR . 'stubs' . DIRECTORY_SEPARATOR . 'DOM.phpstub',
$dir_lvl_2 . DIRECTORY_SEPARATOR . 'stubs' . DIRECTORY_SEPARATOR . 'Reflection.phpstub',
$dir_lvl_2 . DIRECTORY_SEPARATOR . 'stubs' . DIRECTORY_SEPARATOR . 'SPL.phpstub',
];
foreach ($core_generic_files as $stub_path) {
if (\PHP_VERSION_ID >= 80000 && $codebase->php_major_version >= 8) {
$stringable_path = $dir_lvl_2 . DIRECTORY_SEPARATOR . 'stubs' . DIRECTORY_SEPARATOR . 'Php80.phpstub';
$this->internal_stubs[] = $stringable_path;
}
if (\PHP_VERSION_ID >= 80100 && $codebase->php_major_version >= 8 && $codebase->php_minor_version >= 1) {
$stringable_path = $dir_lvl_2 . DIRECTORY_SEPARATOR . 'stubs' . DIRECTORY_SEPARATOR . 'Php81.phpstub';
$this->internal_stubs[] = $stringable_path;
}
if (\extension_loaded('PDO')) {
$ext_pdo_path = $dir_lvl_2 . DIRECTORY_SEPARATOR . 'stubs' . DIRECTORY_SEPARATOR . 'pdo.phpstub';
$this->internal_stubs[] = $ext_pdo_path;
}
if (\extension_loaded('soap')) {
$ext_soap_path = $dir_lvl_2 . DIRECTORY_SEPARATOR . 'stubs' . DIRECTORY_SEPARATOR . 'soap.phpstub';
$this->internal_stubs[] = $ext_soap_path;
}
if (\extension_loaded('ds')) {
$ext_ds_path = $dir_lvl_2 . DIRECTORY_SEPARATOR . 'stubs' . DIRECTORY_SEPARATOR . 'ext-ds.phpstub';
$this->internal_stubs[] = $ext_ds_path;
}
if (\extension_loaded('mongodb')) {
$ext_mongodb_path = $dir_lvl_2 . DIRECTORY_SEPARATOR . 'stubs' . DIRECTORY_SEPARATOR . 'mongodb.phpstub';
$this->internal_stubs[] = $ext_mongodb_path;
}
if ($this->load_xdebug_stub) {
$xdebug_stub_path = $dir_lvl_2 . DIRECTORY_SEPARATOR . 'stubs' . DIRECTORY_SEPARATOR . 'Xdebug.phpstub';
$this->internal_stubs[] = $xdebug_stub_path;
}
foreach ($this->internal_stubs as $stub_path) {
if (!file_exists($stub_path)) {
throw new \UnexpectedValueException('Cannot locate ' . $stub_path);
}
}
if (\PHP_VERSION_ID >= 80000 && $codebase->php_major_version >= 8) {
$stringable_path = dirname(__DIR__, 2) . '/stubs/Php80.phpstub';
if (!file_exists($stringable_path)) {
throw new \UnexpectedValueException('Cannot locate PHP 8.0 classes');
}
$core_generic_files[] = $stringable_path;
}
if (\PHP_VERSION_ID >= 80100 && $codebase->php_major_version >= 8 && $codebase->php_minor_version >= 1) {
$stringable_path = dirname(__DIR__, 2) . '/stubs/Php81.phpstub';
if (!file_exists($stringable_path)) {
throw new \UnexpectedValueException('Cannot locate PHP 8.1 classes');
}
$core_generic_files[] = $stringable_path;
}
if (\extension_loaded('PDO')) {
$ext_pdo_path = dirname(__DIR__, 2) . '/stubs/pdo.phpstub';
if (!file_exists($ext_pdo_path)) {
throw new \UnexpectedValueException('Cannot locate pdo classes');
}
$core_generic_files[] = $ext_pdo_path;
}
if (\extension_loaded('soap')) {
$ext_soap_path = dirname(__DIR__, 2) . '/stubs/soap.phpstub';
if (!file_exists($ext_soap_path)) {
throw new \UnexpectedValueException('Cannot locate soap classes');
}
$core_generic_files[] = $ext_soap_path;
}
if (\extension_loaded('ds')) {
$ext_ds_path = dirname(__DIR__, 2) . '/stubs/ext-ds.phpstub';
if (!file_exists($ext_ds_path)) {
throw new \UnexpectedValueException('Cannot locate ext-ds classes');
}
$core_generic_files[] = $ext_ds_path;
}
if (\extension_loaded('mongodb')) {
$ext_mongodb_path = dirname(__DIR__, 2) . '/stubs/mongodb.phpstub';
if (!file_exists($ext_mongodb_path)) {
throw new \UnexpectedValueException('Cannot locate mongodb classes');
}
$core_generic_files[] = $ext_mongodb_path;
}
$stub_files = array_merge($core_generic_files, $this->stub_files);
if ($this->load_xdebug_stub) {
$xdebug_stub_path = dirname(__DIR__, 2) . '/stubs/Xdebug.phpstub';
if (!file_exists($xdebug_stub_path)) {
throw new \UnexpectedValueException('Cannot locate Xdebug stub');
}
$stub_files[] = $xdebug_stub_path;
}
$stub_files = array_merge($this->internal_stubs, $this->stub_files);
$phpstorm_meta_path = $this->base_dir . DIRECTORY_SEPARATOR . '.phpstorm.meta.php';

33
src/Psalm/Internal/PhpVisitor/Reflector/FunctionLikeDocblockScanner.php
View File

@ -28,6 +28,7 @@ use function array_filter;
use function array_merge;
use function count;
use function explode;
use function in_array;
use function preg_match;
use function preg_replace;
use function preg_split;
@ -118,11 +119,23 @@ class FunctionLikeDocblockScanner
$storage->specialize_call = true;
}
if ($docblock_info->ignore_nullable_return && $storage->return_type) {
// we make sure we only add ignore flag for internal stubs if the config is set to true
if ($docblock_info->ignore_nullable_return
&& $storage->return_type
&& ($codebase->config->ignore_internal_nullable_issues
|| !in_array($file_storage->file_path, $codebase->config->internal_stubs)
)
) {
$storage->return_type->ignore_nullable_issues = true;
}
if ($docblock_info->ignore_falsable_return && $storage->return_type) {
// we make sure we only add ignore flag for internal stubs if the config is set to true
if ($docblock_info->ignore_falsable_return
&& $storage->return_type
&& ($codebase->config->ignore_internal_falsable_issues
|| !in_array($file_storage->file_path, $codebase->config->internal_stubs)
)
) {
$storage->return_type->ignore_falsable_issues = true;
}
@ -958,11 +971,23 @@ class FunctionLikeDocblockScanner
);
}
if ($storage->return_type && $docblock_info->ignore_nullable_return) {
// we make sure we only add ignore flag for internal stubs if the config is set to true
if ($docblock_info->ignore_nullable_return
&& $storage->return_type
&& ($codebase->config->ignore_internal_nullable_issues
|| !in_array($file_storage->file_path, $codebase->config->internal_stubs)
)
) {
$storage->return_type->ignore_nullable_issues = true;
}
if ($storage->return_type && $docblock_info->ignore_falsable_return) {
// we make sure we only add ignore flag for internal stubs if the config is set to true
if ($docblock_info->ignore_falsable_return
&& $storage->return_type
&& ($codebase->config->ignore_internal_falsable_issues
|| !in_array($file_storage->file_path, $codebase->config->internal_stubs)
)
) {
$storage->return_type->ignore_falsable_issues = true;
}

5
src/Psalm/Internal/PhpVisitor/Reflector/FunctionLikeNodeScanner.php
View File

@ -39,6 +39,7 @@ use function array_pop;
use function count;
use function explode;
use function implode;
use function in_array;
use function is_string;
use function strlen;
use function strpos;
@ -205,9 +206,7 @@ class FunctionLikeNodeScanner
}
if ($param_storage->name === 'haystack'
&& (strpos($this->file_path, 'CoreGenericFunctions.phpstub')
|| strpos($this->file_path, 'CoreGenericClasses.phpstub')
|| strpos($this->file_path, 'CoreGenericIterators.phpstub'))
&& in_array($this->file_path, $this->codebase->config->internal_stubs)
) {
$param_storage->expect_variable = true;
}

6
src/Psalm/Type/Atomic.php
View File

@ -91,9 +91,9 @@ abstract class Atomic implements TypeNode
public $text;
/**
* @param array{int,int}|null $php_version
* @param array<string, array<string, Union>> $template_type_map
* @param array<string, TypeAlias> $type_aliases
* @param array{int,int}|null $php_version contains php version when the type comes from signature
* @param array<string, array<string, Union>> $template_type_map
* @param array<string, TypeAlias> $type_aliases
*/
public static function create(
string $value,