disableExtension($extension);
}
}
} elseif (is_string($options['disable-extension'])) {
$ini_handler->disableExtension($options['disable-extension']);
}
}
if ($threads > 1) {
$ini_handler->disableExtension('grpc');
}
$type_map_location = null;
if (isset($options['generate-type-map']) && is_string($options['generate-type-map'])) {
$type_map_location = $options['generate-type-map'];
}
// If XDebug is enabled, restart without it
$ini_handler->check();
setlocale(LC_CTYPE, 'C');
if (isset($options['set-baseline'])) {
if (is_array($options['set-baseline'])) {
die('Only one baseline file can be created at a time' . PHP_EOL);
}
}
if (isset($options['i'])) {
if (file_exists($current_dir . 'psalm.xml')) {
die('A config file already exists in the current directory' . PHP_EOL);
}
$args = array_values(array_filter(
$args,
/**
* @param string $arg
*
* @return bool
*/
function ($arg) {
return $arg !== '--ansi'
&& $arg !== '--no-ansi'
&& $arg !== '-i'
&& $arg !== '--init'
&& strpos($arg, '--root=') !== 0
&& strpos($arg, '--r=') !== 0;
}
));
$level = 3;
$source_dir = 'src';
if (count($args)) {
if (count($args) > 2) {
die('Too many arguments provided for psalm --init' . PHP_EOL);
}
if (isset($args[1])) {
if (!preg_match('/^[1-8]$/', $args[1])) {
die('Config strictness must be a number between 1 and 8 inclusive' . PHP_EOL);
}
$level = (int)$args[1];
}
$source_dir = $args[0];
}
if (!is_dir($source_dir)) {
$bad_dir_path = getcwd() . DIRECTORY_SEPARATOR . $source_dir;
if (!isset($args[0])) {
die('Please specify a directory - the default, "src", was not found in this project.' . PHP_EOL);
}
die('The given path "' . $bad_dir_path . '" does not appear to be a directory' . PHP_EOL);
}
$template_file_name = dirname(__DIR__) . '/assets/config_levels/' . $level . '.xml';
if (!file_exists($template_file_name)) {
die('Could not open config template ' . $template_file_name . PHP_EOL);
}
$template = (string)file_get_contents($template_file_name);
$template = str_replace(
'',
'',
$template
);
if (!file_put_contents($current_dir . 'psalm.xml', $template)) {
die('Could not write to psalm.xml' . PHP_EOL);
}
exit('Config file created successfully. Please re-run psalm.' . PHP_EOL);
}
$output_format = isset($options['output-format']) && is_string($options['output-format'])
? $options['output-format']
: ProjectAnalyzer::TYPE_CONSOLE;
$paths_to_check = getPathsToCheck(isset($options['f']) ? $options['f'] : null);
$plugins = [];
if (isset($options['plugin'])) {
$plugins = $options['plugin'];
if (!is_array($plugins)) {
$plugins = [$plugins];
}
}
$path_to_config = isset($options['c']) && is_string($options['c']) ? realpath($options['c']) : null;
if ($path_to_config === false) {
/** @psalm-suppress InvalidCast */
echo 'Could not resolve path to config ' . (string)$options['c'] . PHP_EOL;
exit(1);
}
$show_info = isset($options['show-info'])
? $options['show-info'] !== 'false' && $options['show-info'] !== '0'
: true;
$is_diff = isset($options['diff']);
/** @var false|'always'|'auto' $find_dead_code */
$find_dead_code = false;
if (isset($options['find-dead-code'])) {
if ($options['find-dead-code'] === 'always') {
$find_dead_code = 'always';
} else {
$find_dead_code = 'auto';
}
}
$find_references_to = isset($options['find-references-to']) && is_string($options['find-references-to'])
? $options['find-references-to']
: null;
// initialise custom config, if passed
try {
if ($path_to_config) {
$config = Config::loadFromXMLFile($path_to_config, $current_dir);
} else {
$config = Config::getConfigForPath($current_dir, $current_dir, $output_format);
}
} catch (Psalm\Exception\ConfigException $e) {
echo $e->getMessage();
exit(1);
}
if (isset($options['with-spirit'])) {
if (is_string($options['with-spirit'])) {
$config->spirit_host = $options['with-spirit'];
}
$spirit_plugin = __DIR__ . '/Psalm/Plugin/SpiritGuide.php';
if (!file_exists($spirit_plugin)) {
die('Could not find Spirit plugin location ' . $spirit_plugin . PHP_EOL);
}
$plugins[] = $spirit_plugin;
}
$config->setComposerClassLoader($first_autoloader);
if (isset($options['clear-cache'])) {
$cache_directory = $config->getCacheDirectory();
Config::removeCacheDirectory($cache_directory);
echo 'Cache directory deleted' . PHP_EOL;
exit;
}
if (isset($options['clear-global-cache'])) {
$cache_directory = $config->getGlobalCacheDirectory();
Config::removeCacheDirectory($cache_directory);
echo 'Global cache directory deleted' . PHP_EOL;
exit;
}
$debug = array_key_exists('debug', $options) || array_key_exists('debug-by-line', $options);
if (isset($options['no-cache'])) {
$providers = new Provider\Providers(
new Provider\FileProvider
);
} else {
$no_reflection_cache = isset($options['no-reflection-cache']);
$file_storage_cache_provider = $no_reflection_cache
? null
: new Provider\FileStorageCacheProvider($config);
$classlike_storage_cache_provider = $no_reflection_cache
? null
: new Provider\ClassLikeStorageCacheProvider($config);
$providers = new Provider\Providers(
new Provider\FileProvider,
new Provider\ParserCacheProvider($config),
$file_storage_cache_provider,
$classlike_storage_cache_provider,
new Provider\FileReferenceCacheProvider($config)
);
}
$project_analyzer = new ProjectAnalyzer(
$config,
$providers,
!array_key_exists('m', $options),
$show_info,
$output_format,
$threads,
$debug,
isset($options['report']) && is_string($options['report']) ? $options['report'] : null,
!isset($options['show-snippet']) || $options['show-snippet'] !== "false"
);
if (isset($options['php-version'])) {
if (!is_string($options['php-version'])) {
die('Expecting a version number in the format x.y' . PHP_EOL);
}
$project_analyzer->setPhpVersion($options['php-version']);
}
$project_analyzer->getCodebase()->diff_methods = isset($options['diff-methods']);
if ($type_map_location) {
$project_analyzer->getCodebase()->store_node_types = true;
}
$start_time = microtime(true);
$config->visitComposerAutoloadFiles($project_analyzer, $debug);
$now_time = microtime(true);
if ($debug) {
echo 'Visiting autoload files took ' . number_format($now_time - $start_time, 3) . 's' . "\n";
}
if (array_key_exists('debug-by-line', $options)) {
$project_analyzer->debug_lines = true;
}
if ($config->find_unused_code) {
$find_dead_code = 'auto';
}
if ($find_dead_code || $find_references_to !== null) {
$project_analyzer->getCodebase()->collectReferences();
if ($find_references_to) {
$project_analyzer->show_issues = false;
}
}
if ($find_dead_code) {
$project_analyzer->getCodebase()->reportUnusedCode();
}
if ($config->find_unused_variables) {
$project_analyzer->getCodebase()->reportUnusedVariables();
}
/** @var string $plugin_path */
foreach ($plugins as $plugin_path) {
$config->addPluginPath($plugin_path);
}
if ($paths_to_check === null) {
$project_analyzer->check($current_dir, $is_diff);
} elseif ($paths_to_check) {
$project_analyzer->checkPaths($paths_to_check);
}
if ($find_references_to) {
$project_analyzer->findReferencesTo($find_references_to);
} elseif (($find_dead_code === 'always') || ($find_dead_code === 'auto' && !$paths_to_check && !$is_diff)) {
if ($threads > 1) {
if ($output_format === ProjectAnalyzer::TYPE_CONSOLE) {
echo 'Unused classes and methods cannot currently be found in multithreaded mode' . PHP_EOL;
}
} else {
$project_analyzer->checkClassReferences();
}
}
if (isset($options['set-baseline']) && is_string($options['set-baseline'])) {
echo 'Writing error baseline to file...', PHP_EOL;
ErrorBaseline::create(
new \Psalm\Internal\Provider\FileProvider,
$options['set-baseline'],
IssueBuffer::getIssuesData()
);
echo "Baseline saved to {$options['set-baseline']}.";
/** @var string $configFile */
$configFile = Config::locateConfigFile($path_to_config ?? $current_dir);
$configFileContents = $amendedConfigFileContents = file_get_contents($configFile);
if ($config->error_baseline) {
$amendedConfigFileContents = preg_replace(
'/errorBaseline=".*?"/',
"errorBaseline=\"{$options['set-baseline']}\"",
$configFileContents
);
} else {
$endPsalmOpenTag = strpos($configFileContents, '>', (int)strpos($configFileContents, '",
$endPsalmOpenTag,
1
);
} else {
$amendedConfigFileContents = substr_replace(
$configFileContents,
" errorBaseline=\"{$options['set-baseline']}\">",
$endPsalmOpenTag,
1
);
}
}
file_put_contents($configFile, $amendedConfigFileContents);
echo PHP_EOL;
}
$issue_baseline = [];
if (isset($options['update-baseline'])) {
$baselineFile = Config::getInstance()->error_baseline;
if (empty($baselineFile)) {
die('Cannot update baseline, because no baseline file is configured.' . PHP_EOL);
}
try {
$issue_current_baseline = ErrorBaseline::read(
new \Psalm\Internal\Provider\FileProvider,
$baselineFile
);
$total_issues_current_baseline = ErrorBaseline::countTotalIssues($issue_current_baseline);
$issue_baseline = ErrorBaseline::update(
new \Psalm\Internal\Provider\FileProvider,
$baselineFile,
IssueBuffer::getIssuesData()
);
$total_issues_updated_baseline = ErrorBaseline::countTotalIssues($issue_baseline);
$total_fixed_issues = $total_issues_current_baseline - $total_issues_updated_baseline;
if ($total_fixed_issues > 0) {
echo str_repeat('-', 30) . "\n";
echo $total_fixed_issues . ' errors fixed' . "\n";
}
} catch (\Psalm\Exception\ConfigException $exception) {
die('Could not update baseline file: ' . $exception->getMessage());
}
}
if (!empty(Config::getInstance()->error_baseline) && !isset($options['ignore-baseline'])) {
try {
$issue_baseline = ErrorBaseline::read(
new \Psalm\Internal\Provider\FileProvider,
(string)Config::getInstance()->error_baseline
);
} catch (\Psalm\Exception\ConfigException $exception) {
die('Error while reading baseline: ' . $exception->getMessage());
}
}
if ($type_map_location) {
$file_map = $providers->file_reference_provider->getFileMaps();
$name_file_map = [];
$expected_references = [];
foreach ($file_map as $file_path => $map) {
$file_name = $config->shortenFileName($file_path);
foreach ($map[0] as $map_parts) {
$expected_references[$map_parts[1]] = true;
}
$map[2] = [];
$name_file_map[$file_name] = $map;
}
$reference_dictionary = [];
foreach ($providers->classlike_storage_provider->getAll() as $storage) {
if (!$storage->location) {
continue;
}
$fq_classlike_name = $storage->name;
if (isset($expected_references[$fq_classlike_name])) {
$reference_dictionary[$fq_classlike_name]
= $storage->location->file_name
. ':' . $storage->location->getLineNumber()
. ':' . $storage->location->getColumn();
}
foreach ($storage->methods as $method_name => $method_storage) {
if (!$method_storage->location) {
continue;
}
if (isset($expected_references[$fq_classlike_name . '::' . $method_name . '()'])) {
$reference_dictionary[$fq_classlike_name . '::' . $method_name . '()']
= $method_storage->location->file_name
. ':' . $method_storage->location->getLineNumber()
. ':' . $method_storage->location->getColumn();
}
}
foreach ($storage->properties as $property_name => $property_storage) {
if (!$property_storage->location) {
continue;
}
if (isset($expected_references[$fq_classlike_name . '::$' . $property_name])) {
$reference_dictionary[$fq_classlike_name . '::$' . $property_name]
= $property_storage->location->file_name
. ':' . $property_storage->location->getLineNumber()
. ':' . $property_storage->location->getColumn();
}
}
}
$providers->file_provider->setContents(
$type_map_location,
json_encode(['files' => $name_file_map, 'references' => $reference_dictionary])
);
}
IssueBuffer::finish(
$project_analyzer,
!$paths_to_check,
$start_time,
isset($options['stats']),
$issue_baseline
);