2016-06-06 07:07:50 +02:00
|
|
|
<?php
|
2016-07-26 00:37:44 +02:00
|
|
|
namespace Psalm;
|
2016-06-06 07:07:50 +02:00
|
|
|
|
2018-03-03 21:19:05 +01:00
|
|
|
use Composer\Autoload\ClassLoader;
|
2018-11-06 03:57:36 +01:00
|
|
|
use Psalm\Internal\Analyzer\ClassLikeAnalyzer;
|
|
|
|
use Psalm\Internal\Analyzer\ProjectAnalyzer;
|
2019-05-03 23:12:20 +02:00
|
|
|
use Psalm\Issue\ClassIssue;
|
|
|
|
use Psalm\Issue\CodeIssue;
|
|
|
|
use Psalm\Issue\FunctionIssue;
|
|
|
|
use Psalm\Issue\MethodIssue;
|
|
|
|
use Psalm\Issue\ArgumentIssue;
|
|
|
|
use Psalm\Issue\PropertyIssue;
|
2016-12-30 02:07:42 +01:00
|
|
|
use Psalm\Config\IssueHandler;
|
|
|
|
use Psalm\Config\ProjectFileFilter;
|
2016-11-02 07:29:00 +01:00
|
|
|
use Psalm\Exception\ConfigException;
|
2019-01-02 12:58:49 +01:00
|
|
|
use Psalm\Internal\Analyzer\FileAnalyzer;
|
2018-11-06 03:57:36 +01:00
|
|
|
use Psalm\Internal\Scanner\FileScanner;
|
2019-01-02 15:00:45 +01:00
|
|
|
use Psalm\Plugin\Hook;
|
Plugin loading (#855)
* add ability to load plugins by class names
- Plugins need to implement `__invoke(PluginFacade $psalm):void` method
- Plugins are enabled by adding `<pluginClass
class="Qualified\Class\Name"/>`
- `PluginFacade` provides a single point of contact with Psalm, so that
plugins cannot become coupled to Psalm internals
* added `psalm-plugin` cli tool to manage plugins
Available commands:
`psalm-plugin list` - lists available and enabled plugins
`psalm-plugin enable 'Plugin\Class\Name'` - enables plugin (modifies `psalm.xml`)
`psalm-plugin disable 'Plugin\Class\Name'` - disables plugin (modifies `psalm.xml`)
Plugin installation:
`composer install plugin-vendor/plugin-package-name`
Plugin authoring:
Plugins are identified by package `type` field, which should contain
`psalm-plugin` string.
`extra.pluginClass` should refer to the name of the class implementing
`__invoke(PluginFacade $psalm):void` function
Todo:
- better config file search
- better output for `psalm-plugin`
- better formatting for modified xml file
- composer skeleton project for plugins
- ability to refer to plugins by package name (cli only)
- composer plugin to (optionally) enable plugin upon installation
- documentation on plugin installation and authoring
- interfaces for plugin dependencies
- interface for plugin entry point
- migration path for legacy plugins
* documented previously undocumented plugin methods
* split legacy plugin registration into a wrapper class
also added `PluginApi` namespace and `RegistrationInterface`
* reuse psalm's config search algorithm
* enable/disable plugins by composer package name
* allow specifying alternative config file name
* whitelist PluginApi namespace
three times, but well, it works now
* interface for plugin entry points
* psalm-plugin as a symfony console app
* fixed errors found by psalm
* suppressed false positive UnusedMethods
* cs fix
* better psalm-plugin output
* don't leave empty `plugins` node to avoid old schema violation
* removed junk file that shouldn't be there
* cs fix
* fixed phpunit failure (constant redefinition)
* work around missing docblock in on symfony console
* php 7.0 compatibility
* allow `pluginClass` child elements as plugin configuration
* decouple console commands from undelying implementation
- introduce PluginListFactory
- add `PluginList::enable(string $class)` and `PluginList::disable(string $class)`
* PluginList tests
* ComposerLock test
* droppped debugging statement
* added part of console command tests
* added tests for EnableCommand
* added DisableCommand tests
* ignore unused args
* ConfigFile test
* disable travis cache in attempt to fix builds
* nah, that didn't work
* update for upstream changes
* rebase fixes
* namespaced `extra` entry for entry point
* s/PluginFacade/PluginRegistrationSocket/g
* Added $config parameter to PluginEntryPointInterface::__invoke()
* cs fixes
* entry point interface php7.0 compatibility
* cleaned up old cruft
- dropped todos I'm not going to pursues
- locked entry point to be a class implementing entry point interface
* fixed legacy plugins docs
* Added RegistrationInterface::registerHooksFromClass()
It mimics the way old plugins were registered in Psalm\Config, so
handler classes extending Psalm\Plugin should be fully compatible with
it.
Since Psalm\Plugin-style plugin registration was moved to
RegistrationSocket, LegacyPlugin now only load file-based plugins, so it
was renamed to FileBasedPluginAdapter.
* Converted EchoChecker plugin to composer-based format
- Its subfolder is registered as a local composer package in the root
composer.json, so it's directly installable with
```
composer require psalm/echo-checker-plugin
```
- Migration is trivial: drop the plugin into a separate folder, then add
simple composer.json and the entry point class.
* Updated docs
* Don't reject hook handlers that inherit handling methods
* strip void return type in stub file
2018-11-11 05:23:36 +01:00
|
|
|
use Psalm\PluginRegistrationSocket;
|
2019-05-16 23:12:31 +02:00
|
|
|
use Psalm\Progress\Progress;
|
|
|
|
use Psalm\Progress\DefaultProgress;
|
2019-01-02 15:00:45 +01:00
|
|
|
use SimpleXMLElement;
|
2016-06-10 00:08:25 +02:00
|
|
|
|
2016-06-06 07:07:50 +02:00
|
|
|
class Config
|
|
|
|
{
|
2016-07-26 00:39:36 +02:00
|
|
|
const DEFAULT_FILE_NAME = 'psalm.xml';
|
2016-06-25 00:18:11 +02:00
|
|
|
const REPORT_INFO = 'info';
|
|
|
|
const REPORT_ERROR = 'error';
|
2016-06-26 19:45:20 +02:00
|
|
|
const REPORT_SUPPRESS = 'suppress';
|
2016-06-25 00:18:11 +02:00
|
|
|
|
2016-11-02 07:29:00 +01:00
|
|
|
/**
|
|
|
|
* @var array<string>
|
|
|
|
*/
|
2016-06-27 21:10:13 +02:00
|
|
|
public static $ERROR_LEVELS = [
|
2016-06-25 00:18:11 +02:00
|
|
|
self::REPORT_INFO,
|
|
|
|
self::REPORT_ERROR,
|
2017-05-27 02:05:57 +02:00
|
|
|
self::REPORT_SUPPRESS,
|
2016-06-25 00:18:11 +02:00
|
|
|
];
|
|
|
|
|
2016-12-19 01:17:39 +01:00
|
|
|
/**
|
|
|
|
* @var array
|
|
|
|
*/
|
2019-04-26 00:02:19 +02:00
|
|
|
const MIXED_ISSUES = [
|
2016-12-19 01:17:39 +01:00
|
|
|
'MixedArgument',
|
|
|
|
'MixedArrayAccess',
|
2017-11-19 19:42:48 +01:00
|
|
|
'MixedArrayAssignment',
|
2016-12-19 01:17:39 +01:00
|
|
|
'MixedArrayOffset',
|
2019-04-29 18:19:51 +02:00
|
|
|
'MixedArrayTypeCoercion',
|
2016-12-19 01:17:39 +01:00
|
|
|
'MixedAssignment',
|
2019-02-10 22:15:52 +01:00
|
|
|
'MixedFunctionCall',
|
2016-12-19 01:17:39 +01:00
|
|
|
'MixedInferredReturnType',
|
|
|
|
'MixedMethodCall',
|
2016-12-24 03:30:32 +01:00
|
|
|
'MixedOperand',
|
2016-12-19 01:17:39 +01:00
|
|
|
'MixedPropertyFetch',
|
|
|
|
'MixedPropertyAssignment',
|
2018-01-05 03:36:16 +01:00
|
|
|
'MixedReturnStatement',
|
2017-05-27 02:05:57 +02:00
|
|
|
'MixedStringOffsetAssignment',
|
2017-11-19 19:42:48 +01:00
|
|
|
'MixedTypeCoercion',
|
2019-04-26 00:02:19 +02:00
|
|
|
'MixedArgumentTypeCoercion',
|
|
|
|
'MixedPropertyTypeCoercion',
|
|
|
|
'MixedReturnTypeCoercion',
|
2016-12-19 01:17:39 +01:00
|
|
|
];
|
|
|
|
|
2016-11-02 07:29:00 +01:00
|
|
|
/**
|
|
|
|
* @var self|null
|
|
|
|
*/
|
2018-01-21 19:38:51 +01:00
|
|
|
private static $instance;
|
2016-06-10 00:08:25 +02:00
|
|
|
|
2016-06-27 04:40:57 +02:00
|
|
|
/**
|
|
|
|
* Whether or not to use types as defined in docblocks
|
2016-11-01 05:39:41 +01:00
|
|
|
*
|
2017-05-27 02:16:18 +02:00
|
|
|
* @var bool
|
2016-06-27 04:40:57 +02:00
|
|
|
*/
|
2016-08-24 06:22:38 +02:00
|
|
|
public $use_docblock_types = true;
|
2016-06-10 00:08:25 +02:00
|
|
|
|
2018-01-13 06:32:20 +01:00
|
|
|
/**
|
|
|
|
* Whether or not to use types as defined in property docblocks.
|
|
|
|
* This is distinct from the above because you may want to use
|
|
|
|
* property docblocks, but not function docblocks.
|
|
|
|
*
|
|
|
|
* @var bool
|
|
|
|
*/
|
|
|
|
public $use_docblock_property_types = true;
|
|
|
|
|
2016-06-27 04:40:57 +02:00
|
|
|
/**
|
|
|
|
* Whether or not to throw an exception on first error
|
2016-11-01 05:39:41 +01:00
|
|
|
*
|
2017-05-27 02:16:18 +02:00
|
|
|
* @var bool
|
2016-06-27 04:40:57 +02:00
|
|
|
*/
|
|
|
|
public $throw_exception = false;
|
|
|
|
|
2016-07-26 21:00:40 +02:00
|
|
|
/**
|
2016-11-04 22:45:12 +01:00
|
|
|
* The directory to store PHP Parser (and other) caches
|
|
|
|
*
|
|
|
|
* @var string
|
|
|
|
*/
|
2017-01-15 23:20:54 +01:00
|
|
|
public $cache_directory;
|
2016-11-04 22:45:12 +01:00
|
|
|
|
2018-10-15 17:29:57 +02:00
|
|
|
/**
|
|
|
|
* The directory to store all Psalm project caches
|
|
|
|
*
|
2019-04-14 19:04:25 +02:00
|
|
|
* @var string|null
|
2018-10-15 17:29:57 +02:00
|
|
|
*/
|
|
|
|
public $global_cache_directory;
|
|
|
|
|
2016-11-04 22:45:12 +01:00
|
|
|
/**
|
|
|
|
* Path to the autoader
|
2016-11-01 05:39:41 +01:00
|
|
|
*
|
2016-07-26 21:00:40 +02:00
|
|
|
* @var string|null
|
|
|
|
*/
|
|
|
|
public $autoloader;
|
|
|
|
|
2016-11-02 07:29:00 +01:00
|
|
|
/**
|
2016-12-30 02:07:42 +01:00
|
|
|
* @var ProjectFileFilter|null
|
2016-11-02 07:29:00 +01:00
|
|
|
*/
|
2017-07-25 23:04:58 +02:00
|
|
|
protected $project_files;
|
2016-06-10 00:08:25 +02:00
|
|
|
|
2016-09-01 05:12:35 +02:00
|
|
|
/**
|
|
|
|
* The base directory of this config file
|
2016-11-01 05:39:41 +01:00
|
|
|
*
|
2016-09-01 05:12:35 +02:00
|
|
|
* @var string
|
|
|
|
*/
|
2018-10-07 02:11:19 +02:00
|
|
|
public $base_dir;
|
2016-06-06 07:07:50 +02:00
|
|
|
|
2016-11-02 07:29:00 +01:00
|
|
|
/**
|
|
|
|
* @var array<int, string>
|
|
|
|
*/
|
2017-02-12 00:56:38 +01:00
|
|
|
private $file_extensions = ['php'];
|
2016-06-10 20:47:44 +02:00
|
|
|
|
2016-11-02 07:29:00 +01:00
|
|
|
/**
|
2019-01-02 15:00:45 +01:00
|
|
|
* @var array<string, class-string<FileScanner>>
|
2016-11-02 07:29:00 +01:00
|
|
|
*/
|
2018-01-21 19:38:51 +01:00
|
|
|
private $filetype_scanners = [];
|
|
|
|
|
|
|
|
/**
|
2019-01-02 15:00:45 +01:00
|
|
|
* @var array<string, class-string<FileAnalyzer>>
|
2018-01-21 19:38:51 +01:00
|
|
|
*/
|
2018-11-11 18:01:14 +01:00
|
|
|
private $filetype_analyzers = [];
|
2016-06-20 06:38:13 +02:00
|
|
|
|
2018-02-12 02:56:34 +01:00
|
|
|
/**
|
|
|
|
* @var array<string, string>
|
|
|
|
*/
|
|
|
|
private $filetype_scanner_paths = [];
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @var array<string, string>
|
|
|
|
*/
|
2018-11-11 18:01:14 +01:00
|
|
|
private $filetype_analyzer_paths = [];
|
2018-02-12 02:56:34 +01:00
|
|
|
|
2016-09-09 22:21:49 +02:00
|
|
|
/**
|
2016-12-30 02:07:42 +01:00
|
|
|
* @var array<string, IssueHandler>
|
2016-09-09 22:21:49 +02:00
|
|
|
*/
|
2017-02-12 00:56:38 +01:00
|
|
|
private $issue_handlers = [];
|
2016-06-10 20:47:44 +02:00
|
|
|
|
2016-11-02 07:29:00 +01:00
|
|
|
/**
|
|
|
|
* @var array<int, string>
|
|
|
|
*/
|
2017-02-12 00:56:38 +01:00
|
|
|
private $mock_classes = [];
|
2016-06-06 07:07:50 +02:00
|
|
|
|
2017-02-01 01:21:33 +01:00
|
|
|
/**
|
|
|
|
* @var array<int, string>
|
|
|
|
*/
|
2017-02-12 00:56:38 +01:00
|
|
|
private $stub_files = [];
|
2017-02-01 01:21:33 +01:00
|
|
|
|
2016-11-02 07:29:00 +01:00
|
|
|
/**
|
2017-05-27 02:16:18 +02:00
|
|
|
* @var bool
|
2016-11-02 07:29:00 +01:00
|
|
|
*/
|
2016-09-01 05:12:35 +02:00
|
|
|
public $hide_external_errors = true;
|
|
|
|
|
2016-12-07 00:27:22 +01:00
|
|
|
/** @var bool */
|
2016-12-06 22:41:42 +01:00
|
|
|
public $allow_includes = true;
|
|
|
|
|
2016-12-19 01:17:39 +01:00
|
|
|
/** @var bool */
|
|
|
|
public $totally_typed = false;
|
|
|
|
|
2016-12-24 03:30:32 +01:00
|
|
|
/** @var bool */
|
|
|
|
public $strict_binary_operands = false;
|
|
|
|
|
2017-01-24 08:28:54 +01:00
|
|
|
/** @var bool */
|
|
|
|
public $add_void_docblocks = true;
|
|
|
|
|
2017-01-28 21:17:14 +01:00
|
|
|
/**
|
|
|
|
* If true, assert() calls can be used to check types of variables
|
|
|
|
*
|
2017-05-27 02:16:18 +02:00
|
|
|
* @var bool
|
2017-01-28 21:17:14 +01:00
|
|
|
*/
|
2018-04-13 23:35:56 +02:00
|
|
|
public $use_assert_for_type = true;
|
2017-01-28 21:17:14 +01:00
|
|
|
|
2017-04-15 03:32:14 +02:00
|
|
|
/**
|
2017-05-27 02:16:18 +02:00
|
|
|
* @var bool
|
2017-04-15 03:32:14 +02:00
|
|
|
*/
|
|
|
|
public $remember_property_assignments_after_call = true;
|
|
|
|
|
2017-10-15 18:38:47 +02:00
|
|
|
/** @var bool */
|
|
|
|
public $use_igbinary = false;
|
|
|
|
|
2018-02-01 07:10:27 +01:00
|
|
|
/**
|
|
|
|
* @var bool
|
|
|
|
*/
|
|
|
|
public $allow_phpstorm_generics = false;
|
|
|
|
|
2018-03-06 17:20:54 +01:00
|
|
|
/**
|
|
|
|
* @var bool
|
|
|
|
*/
|
2018-11-12 18:03:55 +01:00
|
|
|
public $allow_string_standin_for_class = false;
|
2018-03-06 17:20:54 +01:00
|
|
|
|
2018-04-22 04:44:54 +02:00
|
|
|
/**
|
|
|
|
* @var bool
|
|
|
|
*/
|
2018-11-30 21:13:25 +01:00
|
|
|
public $use_phpdoc_method_without_magic_or_parent = false;
|
2018-04-22 04:44:54 +02:00
|
|
|
|
2018-04-28 19:05:43 +02:00
|
|
|
/**
|
|
|
|
* @var bool
|
|
|
|
*/
|
|
|
|
public $memoize_method_calls = false;
|
|
|
|
|
2018-06-01 15:07:22 +02:00
|
|
|
/**
|
|
|
|
* @var bool
|
|
|
|
*/
|
|
|
|
public $hoist_constants = false;
|
|
|
|
|
2018-06-07 18:23:10 +02:00
|
|
|
/**
|
|
|
|
* @var bool
|
|
|
|
*/
|
|
|
|
public $add_param_default_to_docblock_type = false;
|
|
|
|
|
2018-06-22 07:13:49 +02:00
|
|
|
/**
|
|
|
|
* @var bool
|
|
|
|
*/
|
|
|
|
public $check_for_throws_docblock = false;
|
|
|
|
|
2019-03-24 21:17:14 +01:00
|
|
|
/**
|
|
|
|
* @var bool
|
|
|
|
*/
|
|
|
|
public $check_for_throws_in_global_scope = false;
|
|
|
|
|
2018-12-19 22:15:19 +01:00
|
|
|
/**
|
|
|
|
* @var bool
|
|
|
|
*/
|
|
|
|
public $ignore_internal_falsable_issues = true;
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @var bool
|
|
|
|
*/
|
|
|
|
public $ignore_internal_nullable_issues = true;
|
|
|
|
|
2018-06-22 07:26:10 +02:00
|
|
|
/**
|
|
|
|
* @var array<string, bool>
|
|
|
|
*/
|
|
|
|
public $ignored_exceptions = [];
|
|
|
|
|
2019-04-10 16:49:27 +02:00
|
|
|
/**
|
|
|
|
* @var array<string, bool>
|
|
|
|
*/
|
|
|
|
public $ignored_exceptions_in_global_scope = [];
|
|
|
|
|
2019-02-01 00:40:40 +01:00
|
|
|
/**
|
|
|
|
* @var array<string, bool>
|
|
|
|
*/
|
|
|
|
public $ignored_exceptions_and_descendants = [];
|
|
|
|
|
2019-04-10 16:49:27 +02:00
|
|
|
/**
|
|
|
|
* @var array<string, bool>
|
|
|
|
*/
|
|
|
|
public $ignored_exceptions_and_descendants_in_global_scope = [];
|
|
|
|
|
2018-09-18 22:42:51 +02:00
|
|
|
/**
|
|
|
|
* @var array<string, bool>
|
|
|
|
*/
|
|
|
|
public $forbidden_functions = [];
|
|
|
|
|
2018-09-18 23:08:32 +02:00
|
|
|
/**
|
|
|
|
* @var bool
|
|
|
|
*/
|
|
|
|
public $forbid_echo = false;
|
|
|
|
|
2019-03-05 21:45:09 +01:00
|
|
|
/**
|
|
|
|
* @var bool
|
|
|
|
*/
|
|
|
|
public $find_unused_code = false;
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @var bool
|
|
|
|
*/
|
|
|
|
public $find_unused_variables = false;
|
|
|
|
|
2016-06-18 20:45:55 +02:00
|
|
|
/**
|
2018-02-12 02:56:34 +01:00
|
|
|
* @var string[]
|
|
|
|
*/
|
2018-09-04 21:28:03 +02:00
|
|
|
public $plugin_paths = [];
|
2018-02-12 02:56:34 +01:00
|
|
|
|
Plugin loading (#855)
* add ability to load plugins by class names
- Plugins need to implement `__invoke(PluginFacade $psalm):void` method
- Plugins are enabled by adding `<pluginClass
class="Qualified\Class\Name"/>`
- `PluginFacade` provides a single point of contact with Psalm, so that
plugins cannot become coupled to Psalm internals
* added `psalm-plugin` cli tool to manage plugins
Available commands:
`psalm-plugin list` - lists available and enabled plugins
`psalm-plugin enable 'Plugin\Class\Name'` - enables plugin (modifies `psalm.xml`)
`psalm-plugin disable 'Plugin\Class\Name'` - disables plugin (modifies `psalm.xml`)
Plugin installation:
`composer install plugin-vendor/plugin-package-name`
Plugin authoring:
Plugins are identified by package `type` field, which should contain
`psalm-plugin` string.
`extra.pluginClass` should refer to the name of the class implementing
`__invoke(PluginFacade $psalm):void` function
Todo:
- better config file search
- better output for `psalm-plugin`
- better formatting for modified xml file
- composer skeleton project for plugins
- ability to refer to plugins by package name (cli only)
- composer plugin to (optionally) enable plugin upon installation
- documentation on plugin installation and authoring
- interfaces for plugin dependencies
- interface for plugin entry point
- migration path for legacy plugins
* documented previously undocumented plugin methods
* split legacy plugin registration into a wrapper class
also added `PluginApi` namespace and `RegistrationInterface`
* reuse psalm's config search algorithm
* enable/disable plugins by composer package name
* allow specifying alternative config file name
* whitelist PluginApi namespace
three times, but well, it works now
* interface for plugin entry points
* psalm-plugin as a symfony console app
* fixed errors found by psalm
* suppressed false positive UnusedMethods
* cs fix
* better psalm-plugin output
* don't leave empty `plugins` node to avoid old schema violation
* removed junk file that shouldn't be there
* cs fix
* fixed phpunit failure (constant redefinition)
* work around missing docblock in on symfony console
* php 7.0 compatibility
* allow `pluginClass` child elements as plugin configuration
* decouple console commands from undelying implementation
- introduce PluginListFactory
- add `PluginList::enable(string $class)` and `PluginList::disable(string $class)`
* PluginList tests
* ComposerLock test
* droppped debugging statement
* added part of console command tests
* added tests for EnableCommand
* added DisableCommand tests
* ignore unused args
* ConfigFile test
* disable travis cache in attempt to fix builds
* nah, that didn't work
* update for upstream changes
* rebase fixes
* namespaced `extra` entry for entry point
* s/PluginFacade/PluginRegistrationSocket/g
* Added $config parameter to PluginEntryPointInterface::__invoke()
* cs fixes
* entry point interface php7.0 compatibility
* cleaned up old cruft
- dropped todos I'm not going to pursues
- locked entry point to be a class implementing entry point interface
* fixed legacy plugins docs
* Added RegistrationInterface::registerHooksFromClass()
It mimics the way old plugins were registered in Psalm\Config, so
handler classes extending Psalm\Plugin should be fully compatible with
it.
Since Psalm\Plugin-style plugin registration was moved to
RegistrationSocket, LegacyPlugin now only load file-based plugins, so it
was renamed to FileBasedPluginAdapter.
* Converted EchoChecker plugin to composer-based format
- Its subfolder is registered as a local composer package in the root
composer.json, so it's directly installable with
```
composer require psalm/echo-checker-plugin
```
- Migration is trivial: drop the plugin into a separate folder, then add
simple composer.json and the entry point class.
* Updated docs
* Don't reject hook handlers that inherit handling methods
* strip void return type in stub file
2018-11-11 05:23:36 +01:00
|
|
|
/**
|
2019-02-17 15:15:37 +01:00
|
|
|
* @var array<array{class:string,config:?SimpleXMLElement}>
|
Plugin loading (#855)
* add ability to load plugins by class names
- Plugins need to implement `__invoke(PluginFacade $psalm):void` method
- Plugins are enabled by adding `<pluginClass
class="Qualified\Class\Name"/>`
- `PluginFacade` provides a single point of contact with Psalm, so that
plugins cannot become coupled to Psalm internals
* added `psalm-plugin` cli tool to manage plugins
Available commands:
`psalm-plugin list` - lists available and enabled plugins
`psalm-plugin enable 'Plugin\Class\Name'` - enables plugin (modifies `psalm.xml`)
`psalm-plugin disable 'Plugin\Class\Name'` - disables plugin (modifies `psalm.xml`)
Plugin installation:
`composer install plugin-vendor/plugin-package-name`
Plugin authoring:
Plugins are identified by package `type` field, which should contain
`psalm-plugin` string.
`extra.pluginClass` should refer to the name of the class implementing
`__invoke(PluginFacade $psalm):void` function
Todo:
- better config file search
- better output for `psalm-plugin`
- better formatting for modified xml file
- composer skeleton project for plugins
- ability to refer to plugins by package name (cli only)
- composer plugin to (optionally) enable plugin upon installation
- documentation on plugin installation and authoring
- interfaces for plugin dependencies
- interface for plugin entry point
- migration path for legacy plugins
* documented previously undocumented plugin methods
* split legacy plugin registration into a wrapper class
also added `PluginApi` namespace and `RegistrationInterface`
* reuse psalm's config search algorithm
* enable/disable plugins by composer package name
* allow specifying alternative config file name
* whitelist PluginApi namespace
three times, but well, it works now
* interface for plugin entry points
* psalm-plugin as a symfony console app
* fixed errors found by psalm
* suppressed false positive UnusedMethods
* cs fix
* better psalm-plugin output
* don't leave empty `plugins` node to avoid old schema violation
* removed junk file that shouldn't be there
* cs fix
* fixed phpunit failure (constant redefinition)
* work around missing docblock in on symfony console
* php 7.0 compatibility
* allow `pluginClass` child elements as plugin configuration
* decouple console commands from undelying implementation
- introduce PluginListFactory
- add `PluginList::enable(string $class)` and `PluginList::disable(string $class)`
* PluginList tests
* ComposerLock test
* droppped debugging statement
* added part of console command tests
* added tests for EnableCommand
* added DisableCommand tests
* ignore unused args
* ConfigFile test
* disable travis cache in attempt to fix builds
* nah, that didn't work
* update for upstream changes
* rebase fixes
* namespaced `extra` entry for entry point
* s/PluginFacade/PluginRegistrationSocket/g
* Added $config parameter to PluginEntryPointInterface::__invoke()
* cs fixes
* entry point interface php7.0 compatibility
* cleaned up old cruft
- dropped todos I'm not going to pursues
- locked entry point to be a class implementing entry point interface
* fixed legacy plugins docs
* Added RegistrationInterface::registerHooksFromClass()
It mimics the way old plugins were registered in Psalm\Config, so
handler classes extending Psalm\Plugin should be fully compatible with
it.
Since Psalm\Plugin-style plugin registration was moved to
RegistrationSocket, LegacyPlugin now only load file-based plugins, so it
was renamed to FileBasedPluginAdapter.
* Converted EchoChecker plugin to composer-based format
- Its subfolder is registered as a local composer package in the root
composer.json, so it's directly installable with
```
composer require psalm/echo-checker-plugin
```
- Migration is trivial: drop the plugin into a separate folder, then add
simple composer.json and the entry point class.
* Updated docs
* Don't reject hook handlers that inherit handling methods
* strip void return type in stub file
2018-11-11 05:23:36 +01:00
|
|
|
*/
|
|
|
|
private $plugin_classes = [];
|
|
|
|
|
2018-02-12 02:56:34 +01:00
|
|
|
/**
|
|
|
|
* Static methods to be called after method checks have completed
|
|
|
|
*
|
2019-01-02 15:00:45 +01:00
|
|
|
* @var class-string<Hook\AfterMethodCallAnalysisInterface>[]
|
2018-02-12 02:56:34 +01:00
|
|
|
*/
|
|
|
|
public $after_method_checks = [];
|
|
|
|
|
2018-06-01 03:59:55 +02:00
|
|
|
/**
|
|
|
|
* Static methods to be called after function checks have completed
|
|
|
|
*
|
2019-01-02 15:00:45 +01:00
|
|
|
* @var class-string<Hook\AfterFunctionCallAnalysisInterface>[]
|
2018-06-01 03:59:55 +02:00
|
|
|
*/
|
|
|
|
public $after_function_checks = [];
|
|
|
|
|
2018-02-12 02:56:34 +01:00
|
|
|
/**
|
|
|
|
* Static methods to be called after expression checks have completed
|
2016-11-02 07:29:00 +01:00
|
|
|
*
|
2019-01-02 15:00:45 +01:00
|
|
|
* @var class-string<Hook\AfterExpressionAnalysisInterface>[]
|
2016-06-18 20:45:55 +02:00
|
|
|
*/
|
2018-02-12 02:56:34 +01:00
|
|
|
public $after_expression_checks = [];
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Static methods to be called after statement checks have completed
|
|
|
|
*
|
2019-01-02 15:00:45 +01:00
|
|
|
* @var class-string<Hook\AfterStatementAnalysisInterface>[]
|
2018-02-12 02:56:34 +01:00
|
|
|
*/
|
|
|
|
public $after_statement_checks = [];
|
|
|
|
|
2019-05-21 05:14:41 +02:00
|
|
|
/**
|
|
|
|
* Static methods to be called after method checks have completed
|
|
|
|
*
|
|
|
|
* @var class-string<Hook\StringInterpreterInterface>[]
|
|
|
|
*/
|
|
|
|
public $string_interpreters = [];
|
|
|
|
|
2018-02-12 02:56:34 +01:00
|
|
|
/**
|
|
|
|
* Static methods to be called after classlike exists checks have completed
|
|
|
|
*
|
2019-01-02 15:00:45 +01:00
|
|
|
* @var class-string<Hook\AfterClassLikeExistenceCheckInterface>[]
|
2018-02-12 02:56:34 +01:00
|
|
|
*/
|
|
|
|
public $after_classlike_exists_checks = [];
|
|
|
|
|
2019-01-09 14:28:12 +01:00
|
|
|
/**
|
|
|
|
* Static methods to be called after classlike checks have completed
|
|
|
|
*
|
|
|
|
* @var class-string<Hook\AfterClassLikeAnalysisInterface>[]
|
|
|
|
*/
|
|
|
|
public $after_classlike_checks = [];
|
|
|
|
|
2018-02-12 02:56:34 +01:00
|
|
|
/**
|
|
|
|
* Static methods to be called after classlikes have been scanned
|
|
|
|
*
|
2019-01-02 15:00:45 +01:00
|
|
|
* @var class-string<Hook\AfterClassLikeVisitInterface>[]
|
2018-02-12 02:56:34 +01:00
|
|
|
*/
|
|
|
|
public $after_visit_classlikes = [];
|
2016-06-18 20:45:55 +02:00
|
|
|
|
2019-02-24 17:40:06 +01:00
|
|
|
/**
|
|
|
|
* Static methods to be called after codebase has been populated
|
|
|
|
* @var class-string<Hook\AfterCodebasePopulatedInterface>[]
|
|
|
|
*/
|
|
|
|
public $after_codebase_populated = [];
|
|
|
|
|
2019-03-23 17:47:46 +01:00
|
|
|
/**
|
|
|
|
* Static methods to be called after codebase has been populated
|
|
|
|
* @var class-string<Hook\AfterAnalysisInterface>[]
|
|
|
|
*/
|
|
|
|
public $after_analysis = [];
|
|
|
|
|
2016-11-21 03:49:06 +01:00
|
|
|
/** @var array<string, mixed> */
|
2017-02-12 00:56:38 +01:00
|
|
|
private $predefined_constants;
|
2016-11-21 03:49:06 +01:00
|
|
|
|
2019-04-10 00:09:57 +02:00
|
|
|
/** @var array<callable-string, bool> */
|
2017-02-12 00:56:38 +01:00
|
|
|
private $predefined_functions = [];
|
2017-01-16 02:11:02 +01:00
|
|
|
|
2018-03-03 21:19:05 +01:00
|
|
|
/** @var ClassLoader|null */
|
|
|
|
private $composer_class_loader;
|
|
|
|
|
2018-07-13 05:26:08 +02:00
|
|
|
/**
|
|
|
|
* Custom functions that always exit
|
|
|
|
*
|
|
|
|
* @var array<string, bool>
|
|
|
|
*/
|
|
|
|
public $exit_functions = [];
|
|
|
|
|
2018-09-26 00:37:24 +02:00
|
|
|
/**
|
2018-11-01 22:42:48 +01:00
|
|
|
* @var string
|
2018-09-26 00:37:24 +02:00
|
|
|
*/
|
2018-11-01 22:42:48 +01:00
|
|
|
public $hash = '';
|
2018-09-26 00:37:24 +02:00
|
|
|
|
2018-10-30 15:32:20 +01:00
|
|
|
/** @var string|null */
|
|
|
|
public $error_baseline = null;
|
|
|
|
|
2019-03-23 17:49:37 +01:00
|
|
|
/** @var string */
|
2019-03-31 20:02:30 +02:00
|
|
|
public $shepherd_host = 'shepherd.dev';
|
2019-03-23 17:49:37 +01:00
|
|
|
|
2019-03-06 00:08:41 +01:00
|
|
|
/**
|
|
|
|
* @var array<string, string>
|
|
|
|
*/
|
|
|
|
public $globals = [];
|
|
|
|
|
2019-04-22 16:01:25 +02:00
|
|
|
/**
|
|
|
|
* @var bool
|
|
|
|
*/
|
|
|
|
public $parse_sql = false;
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @var int
|
|
|
|
*/
|
|
|
|
public $max_string_length = 1000;
|
|
|
|
|
2016-12-14 18:28:38 +01:00
|
|
|
protected function __construct()
|
2016-06-06 07:07:50 +02:00
|
|
|
{
|
2018-01-21 19:38:51 +01:00
|
|
|
self::$instance = $this;
|
2016-06-06 07:07:50 +02:00
|
|
|
}
|
|
|
|
|
2018-01-21 16:22:04 +01:00
|
|
|
/**
|
|
|
|
* Gets a Config object from an XML file.
|
|
|
|
*
|
|
|
|
* Searches up a folder hierarchy for the most immediate config.
|
|
|
|
*
|
|
|
|
* @param string $path
|
|
|
|
* @param string $base_dir
|
|
|
|
* @param string $output_format
|
|
|
|
*
|
|
|
|
* @throws ConfigException if a config path is not found
|
|
|
|
*
|
|
|
|
* @return Config
|
2018-04-14 16:24:23 +02:00
|
|
|
* @psalm-suppress MixedArgument
|
2018-01-21 16:22:04 +01:00
|
|
|
*/
|
|
|
|
public static function getConfigForPath($path, $base_dir, $output_format)
|
2018-11-01 18:05:33 +01:00
|
|
|
{
|
|
|
|
$config_path = self::locateConfigFile($path);
|
|
|
|
|
|
|
|
if (!$config_path) {
|
2018-11-06 03:57:36 +01:00
|
|
|
if ($output_format === ProjectAnalyzer::TYPE_CONSOLE) {
|
2018-11-01 18:05:33 +01:00
|
|
|
exit(
|
|
|
|
'Could not locate a config XML file in path ' . $path . '. Have you run \'psalm --init\' ?' .
|
|
|
|
PHP_EOL
|
|
|
|
);
|
|
|
|
}
|
|
|
|
throw new ConfigException('Config not found for path ' . $path);
|
|
|
|
}
|
|
|
|
|
|
|
|
return self::loadFromXMLFile($config_path, $base_dir);
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Searches up a folder hierarchy for the most immediate config.
|
|
|
|
*
|
|
|
|
* @throws ConfigException
|
|
|
|
* @return ?string
|
|
|
|
*/
|
|
|
|
public static function locateConfigFile(string $path)
|
2018-01-21 16:22:04 +01:00
|
|
|
{
|
|
|
|
$dir_path = realpath($path);
|
|
|
|
|
|
|
|
if ($dir_path === false) {
|
|
|
|
throw new ConfigException('Config not found for path ' . $path);
|
|
|
|
}
|
|
|
|
|
|
|
|
if (!is_dir($dir_path)) {
|
|
|
|
$dir_path = dirname($dir_path);
|
|
|
|
}
|
|
|
|
|
|
|
|
do {
|
|
|
|
$maybe_path = $dir_path . DIRECTORY_SEPARATOR . Config::DEFAULT_FILE_NAME;
|
|
|
|
|
2018-04-14 15:57:51 +02:00
|
|
|
if (file_exists($maybe_path) || file_exists($maybe_path .= '.dist')) {
|
2018-11-01 18:05:33 +01:00
|
|
|
return $maybe_path;
|
2018-01-21 16:22:04 +01:00
|
|
|
}
|
|
|
|
|
|
|
|
$dir_path = dirname($dir_path);
|
|
|
|
} while (dirname($dir_path) !== $dir_path);
|
2018-11-01 18:05:33 +01:00
|
|
|
return null;
|
2018-01-21 16:22:04 +01:00
|
|
|
}
|
|
|
|
|
2016-06-26 19:45:20 +02:00
|
|
|
/**
|
|
|
|
* Creates a new config object from the file
|
2016-11-02 07:29:00 +01:00
|
|
|
*
|
2017-02-01 01:21:33 +01:00
|
|
|
* @param string $file_path
|
2017-05-04 20:25:58 +02:00
|
|
|
* @param string $base_dir
|
2017-05-27 02:16:18 +02:00
|
|
|
*
|
2016-12-29 16:24:10 +01:00
|
|
|
* @return self
|
|
|
|
*/
|
2017-05-04 20:25:58 +02:00
|
|
|
public static function loadFromXMLFile($file_path, $base_dir)
|
2016-12-29 16:24:10 +01:00
|
|
|
{
|
|
|
|
$file_contents = file_get_contents($file_path);
|
|
|
|
|
|
|
|
if ($file_contents === false) {
|
|
|
|
throw new \InvalidArgumentException('Cannot open ' . $file_path);
|
|
|
|
}
|
|
|
|
|
2018-04-19 23:29:07 +02:00
|
|
|
try {
|
|
|
|
$config = self::loadFromXML($base_dir, $file_contents);
|
2019-05-08 17:58:34 +02:00
|
|
|
$config->hash = sha1($file_contents . \PSALM_VERSION);
|
2018-04-19 23:29:07 +02:00
|
|
|
} catch (ConfigException $e) {
|
|
|
|
throw new ConfigException(
|
|
|
|
'Problem parsing ' . $file_path . ":\n" . ' ' . $e->getMessage()
|
|
|
|
);
|
|
|
|
}
|
|
|
|
|
|
|
|
return $config;
|
2016-12-29 16:24:10 +01:00
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Creates a new config object from an XML string
|
|
|
|
*
|
2017-05-04 20:25:58 +02:00
|
|
|
* @param string $base_dir
|
2017-02-01 01:21:33 +01:00
|
|
|
* @param string $file_contents
|
2017-05-27 02:16:18 +02:00
|
|
|
*
|
2016-11-01 05:39:41 +01:00
|
|
|
* @return self
|
2016-11-05 02:14:04 +01:00
|
|
|
* @psalm-suppress MixedArgument
|
|
|
|
* @psalm-suppress MixedPropertyFetch
|
|
|
|
* @psalm-suppress MixedMethodCall
|
2016-12-17 06:48:31 +01:00
|
|
|
* @psalm-suppress MixedAssignment
|
2016-12-24 12:03:55 +01:00
|
|
|
* @psalm-suppress MixedOperand
|
2017-02-24 01:36:51 +01:00
|
|
|
* @psalm-suppress MixedPropertyAssignment
|
2016-06-26 19:45:20 +02:00
|
|
|
*/
|
2018-01-28 18:43:19 +01:00
|
|
|
public static function loadFromXML($base_dir, $file_contents)
|
2016-06-10 00:08:25 +02:00
|
|
|
{
|
2017-02-01 01:21:33 +01:00
|
|
|
$config = new static();
|
2016-06-21 01:30:38 +02:00
|
|
|
|
2017-05-04 20:25:58 +02:00
|
|
|
$config->base_dir = $base_dir;
|
2016-06-10 20:47:44 +02:00
|
|
|
|
2016-12-30 04:11:10 +01:00
|
|
|
$schema_path = dirname(dirname(__DIR__)) . '/config.xsd';
|
|
|
|
|
|
|
|
if (!file_exists($schema_path)) {
|
|
|
|
throw new ConfigException('Cannot locate config schema');
|
|
|
|
}
|
|
|
|
|
|
|
|
$dom_document = new \DOMDocument();
|
|
|
|
$dom_document->loadXML($file_contents);
|
|
|
|
|
2018-04-22 01:05:26 +02:00
|
|
|
$psalm_nodes = $dom_document->getElementsByTagName('psalm');
|
|
|
|
|
|
|
|
/** @var \DomElement|null */
|
|
|
|
$psalm_node = $psalm_nodes->item(0);
|
|
|
|
|
|
|
|
if (!$psalm_node) {
|
|
|
|
throw new ConfigException(
|
|
|
|
'Missing psalm node'
|
|
|
|
);
|
|
|
|
}
|
|
|
|
|
|
|
|
if (!$psalm_node->hasAttribute('xmlns')) {
|
|
|
|
$psalm_node->setAttribute('xmlns', 'https://getpsalm.org/schema/config');
|
|
|
|
|
|
|
|
$old_dom_document = $dom_document;
|
|
|
|
$dom_document = new \DOMDocument();
|
2019-01-12 16:52:23 +01:00
|
|
|
$dom_document->loadXML($old_dom_document->saveXML());
|
2018-04-22 01:05:26 +02:00
|
|
|
}
|
|
|
|
|
2016-12-30 04:11:10 +01:00
|
|
|
// Enable user error handling
|
|
|
|
libxml_use_internal_errors(true);
|
|
|
|
|
|
|
|
if (!$dom_document->schemaValidate($schema_path)) {
|
|
|
|
$errors = libxml_get_errors();
|
|
|
|
foreach ($errors as $error) {
|
|
|
|
if ($error->level === LIBXML_ERR_FATAL || $error->level === LIBXML_ERR_ERROR) {
|
2017-04-28 06:31:55 +02:00
|
|
|
throw new ConfigException(
|
2018-04-19 23:29:07 +02:00
|
|
|
'Error on line ' . $error->line . ":\n" . ' ' . $error->message
|
2017-04-28 06:31:55 +02:00
|
|
|
);
|
2016-12-30 04:11:10 +01:00
|
|
|
}
|
|
|
|
}
|
|
|
|
libxml_clear_errors();
|
|
|
|
}
|
|
|
|
|
2016-06-10 00:08:25 +02:00
|
|
|
$config_xml = new SimpleXMLElement($file_contents);
|
|
|
|
|
2016-06-25 00:18:11 +02:00
|
|
|
if (isset($config_xml['useDocblockTypes'])) {
|
|
|
|
$attribute_text = (string) $config_xml['useDocblockTypes'];
|
|
|
|
$config->use_docblock_types = $attribute_text === 'true' || $attribute_text === '1';
|
2016-06-10 00:08:25 +02:00
|
|
|
}
|
|
|
|
|
2018-01-13 06:32:20 +01:00
|
|
|
if (isset($config_xml['useDocblockPropertyTypes'])) {
|
|
|
|
$attribute_text = (string) $config_xml['useDocblockPropertyTypes'];
|
|
|
|
$config->use_docblock_property_types = $attribute_text === 'true' || $attribute_text === '1';
|
|
|
|
}
|
|
|
|
|
2016-06-27 04:40:57 +02:00
|
|
|
if (isset($config_xml['throwExceptionOnError'])) {
|
|
|
|
$attribute_text = (string) $config_xml['throwExceptionOnError'];
|
|
|
|
$config->throw_exception = $attribute_text === 'true' || $attribute_text === '1';
|
|
|
|
}
|
|
|
|
|
2016-09-01 05:12:35 +02:00
|
|
|
if (isset($config_xml['hideExternalErrors'])) {
|
|
|
|
$attribute_text = (string) $config_xml['hideExternalErrors'];
|
|
|
|
$config->hide_external_errors = $attribute_text === 'true' || $attribute_text === '1';
|
|
|
|
}
|
|
|
|
|
2016-07-26 21:00:40 +02:00
|
|
|
if (isset($config_xml['autoloader'])) {
|
2019-01-02 17:18:22 +01:00
|
|
|
$autoloader_path = $config->base_dir . DIRECTORY_SEPARATOR . $config_xml['autoloader'];
|
|
|
|
|
|
|
|
if (!file_exists($autoloader_path)) {
|
2019-01-16 08:05:58 +01:00
|
|
|
throw new ConfigException('Cannot locate autoloader');
|
2019-01-02 17:18:22 +01:00
|
|
|
}
|
|
|
|
|
|
|
|
$config->autoloader = realpath($autoloader_path);
|
2016-07-26 21:00:40 +02:00
|
|
|
}
|
|
|
|
|
2016-11-04 22:45:12 +01:00
|
|
|
if (isset($config_xml['cacheDirectory'])) {
|
2017-01-16 21:58:35 +01:00
|
|
|
$config->cache_directory = (string)$config_xml['cacheDirectory'];
|
2017-01-15 23:20:54 +01:00
|
|
|
} else {
|
|
|
|
$config->cache_directory = sys_get_temp_dir() . '/psalm';
|
2016-11-04 22:45:12 +01:00
|
|
|
}
|
|
|
|
|
2018-10-15 17:29:57 +02:00
|
|
|
$config->global_cache_directory = $config->cache_directory;
|
|
|
|
|
|
|
|
$config->cache_directory .= DIRECTORY_SEPARATOR . sha1($base_dir);
|
|
|
|
|
2019-03-31 17:17:00 +02:00
|
|
|
if (is_dir($config->cache_directory) === false && @mkdir($config->cache_directory, 0777, true) === false) {
|
2017-01-16 21:58:35 +01:00
|
|
|
trigger_error('Could not create cache directory: ' . $config->cache_directory, E_USER_ERROR);
|
|
|
|
}
|
|
|
|
|
2016-12-06 22:41:42 +01:00
|
|
|
if (isset($config_xml['allowFileIncludes'])) {
|
|
|
|
$attribute_text = (string) $config_xml['allowFileIncludes'];
|
|
|
|
$config->allow_includes = $attribute_text === 'true' || $attribute_text === '1';
|
|
|
|
}
|
|
|
|
|
2016-12-19 01:17:39 +01:00
|
|
|
if (isset($config_xml['totallyTyped'])) {
|
|
|
|
$attribute_text = (string) $config_xml['totallyTyped'];
|
|
|
|
$config->totally_typed = $attribute_text === 'true' || $attribute_text === '1';
|
|
|
|
}
|
|
|
|
|
2016-12-24 03:30:32 +01:00
|
|
|
if (isset($config_xml['strictBinaryOperands'])) {
|
|
|
|
$attribute_text = (string) $config_xml['strictBinaryOperands'];
|
|
|
|
$config->strict_binary_operands = $attribute_text === 'true' || $attribute_text === '1';
|
|
|
|
}
|
|
|
|
|
2017-02-01 16:13:37 +01:00
|
|
|
if (isset($config_xml['requireVoidReturnType'])) {
|
|
|
|
$attribute_text = (string) $config_xml['requireVoidReturnType'];
|
2017-01-24 08:28:54 +01:00
|
|
|
$config->add_void_docblocks = $attribute_text === 'true' || $attribute_text === '1';
|
|
|
|
}
|
|
|
|
|
2017-01-28 21:17:14 +01:00
|
|
|
if (isset($config_xml['useAssertForType'])) {
|
|
|
|
$attribute_text = (string) $config_xml['useAssertForType'];
|
|
|
|
$config->use_assert_for_type = $attribute_text === 'true' || $attribute_text === '1';
|
|
|
|
}
|
|
|
|
|
2017-04-15 03:32:14 +02:00
|
|
|
if (isset($config_xml['rememberPropertyAssignmentsAfterCall'])) {
|
|
|
|
$attribute_text = (string) $config_xml['rememberPropertyAssignmentsAfterCall'];
|
|
|
|
$config->remember_property_assignments_after_call = $attribute_text === 'true' || $attribute_text === '1';
|
|
|
|
}
|
|
|
|
|
2017-10-15 18:38:47 +02:00
|
|
|
if (isset($config_xml['serializer'])) {
|
|
|
|
$attribute_text = (string) $config_xml['serializer'];
|
|
|
|
$config->use_igbinary = $attribute_text === 'igbinary';
|
2018-02-19 17:14:07 +01:00
|
|
|
} elseif ($igbinary_version = phpversion('igbinary')) {
|
|
|
|
$config->use_igbinary = version_compare($igbinary_version, '2.0.5') >= 0;
|
2017-10-15 18:38:47 +02:00
|
|
|
}
|
|
|
|
|
2018-02-01 07:10:27 +01:00
|
|
|
if (isset($config_xml['allowPhpStormGenerics'])) {
|
|
|
|
$attribute_text = (string) $config_xml['allowPhpStormGenerics'];
|
|
|
|
$config->allow_phpstorm_generics = $attribute_text === 'true' || $attribute_text === '1';
|
|
|
|
}
|
|
|
|
|
2018-03-06 17:20:54 +01:00
|
|
|
if (isset($config_xml['allowStringToStandInForClass'])) {
|
2019-01-21 12:02:45 +01:00
|
|
|
$attribute_text = (string) $config_xml['allowStringToStandInForClass'];
|
2018-03-06 17:20:54 +01:00
|
|
|
$config->allow_string_standin_for_class = $attribute_text === 'true' || $attribute_text === '1';
|
|
|
|
}
|
|
|
|
|
2018-04-22 05:08:08 +02:00
|
|
|
if (isset($config_xml['usePhpDocMethodsWithoutMagicCall'])) {
|
|
|
|
$attribute_text = (string) $config_xml['usePhpDocMethodsWithoutMagicCall'];
|
2018-11-30 21:13:25 +01:00
|
|
|
$config->use_phpdoc_method_without_magic_or_parent = $attribute_text === 'true' || $attribute_text === '1';
|
2018-04-22 04:44:54 +02:00
|
|
|
}
|
|
|
|
|
2018-04-28 19:05:43 +02:00
|
|
|
if (isset($config_xml['memoizeMethodCallResults'])) {
|
|
|
|
$attribute_text = (string) $config_xml['memoizeMethodCallResults'];
|
|
|
|
$config->memoize_method_calls = $attribute_text === 'true' || $attribute_text === '1';
|
|
|
|
}
|
|
|
|
|
2018-06-01 15:07:22 +02:00
|
|
|
if (isset($config_xml['hoistConstants'])) {
|
|
|
|
$attribute_text = (string) $config_xml['hoistConstants'];
|
|
|
|
$config->hoist_constants = $attribute_text === 'true' || $attribute_text === '1';
|
|
|
|
}
|
|
|
|
|
2018-06-07 18:23:10 +02:00
|
|
|
if (isset($config_xml['addParamDefaultToDocblockType'])) {
|
|
|
|
$attribute_text = (string) $config_xml['addParamDefaultToDocblockType'];
|
|
|
|
$config->add_param_default_to_docblock_type = $attribute_text === 'true' || $attribute_text === '1';
|
|
|
|
}
|
|
|
|
|
2018-06-22 07:13:49 +02:00
|
|
|
if (isset($config_xml['checkForThrowsDocblock'])) {
|
|
|
|
$attribute_text = (string) $config_xml['checkForThrowsDocblock'];
|
|
|
|
$config->check_for_throws_docblock = $attribute_text === 'true' || $attribute_text === '1';
|
2019-03-24 21:17:14 +01:00
|
|
|
}
|
|
|
|
|
|
|
|
if (isset($config_xml['checkForThrowsInGlobalScope'])) {
|
|
|
|
$attribute_text = (string) $config_xml['checkForThrowsInGlobalScope'];
|
|
|
|
$config->check_for_throws_in_global_scope = $attribute_text === 'true' || $attribute_text === '1';
|
2018-06-22 07:13:49 +02:00
|
|
|
}
|
|
|
|
|
2018-09-18 23:08:32 +02:00
|
|
|
if (isset($config_xml['forbidEcho'])) {
|
|
|
|
$attribute_text = (string) $config_xml['forbidEcho'];
|
|
|
|
$config->forbid_echo = $attribute_text === 'true' || $attribute_text === '1';
|
|
|
|
}
|
|
|
|
|
2019-03-05 21:45:09 +01:00
|
|
|
if (isset($config_xml['findUnusedCode'])) {
|
|
|
|
$attribute_text = (string) $config_xml['findUnusedCode'];
|
|
|
|
$config->find_unused_code = $attribute_text === 'true' || $attribute_text === '1';
|
|
|
|
$config->find_unused_variables = $config->find_unused_code;
|
|
|
|
}
|
|
|
|
|
|
|
|
if (isset($config_xml['findUnusedVariablesAndParams'])) {
|
|
|
|
$attribute_text = (string) $config_xml['findUnusedVariablesAndParams'];
|
|
|
|
$config->find_unused_variables = $attribute_text === 'true' || $attribute_text === '1';
|
|
|
|
}
|
|
|
|
|
2018-12-19 23:56:29 +01:00
|
|
|
if (isset($config_xml['ignoreInternalFunctionFalseReturn'])) {
|
|
|
|
$attribute_text = (string) $config_xml['ignoreInternalFunctionFalseReturn'];
|
2018-12-19 22:15:19 +01:00
|
|
|
$config->ignore_internal_falsable_issues = $attribute_text === 'true' || $attribute_text === '1';
|
|
|
|
}
|
|
|
|
|
2018-12-20 00:03:02 +01:00
|
|
|
if (isset($config_xml['ignoreInternalFunctionNullReturn'])) {
|
2018-12-19 23:56:29 +01:00
|
|
|
$attribute_text = (string) $config_xml['ignoreInternalFunctionNullReturn'];
|
2018-12-19 22:15:19 +01:00
|
|
|
$config->ignore_internal_nullable_issues = $attribute_text === 'true' || $attribute_text === '1';
|
|
|
|
}
|
|
|
|
|
2018-10-30 15:32:20 +01:00
|
|
|
if (isset($config_xml['errorBaseline'])) {
|
|
|
|
$attribute_text = (string) $config_xml['errorBaseline'];
|
|
|
|
$config->error_baseline = $attribute_text;
|
|
|
|
}
|
|
|
|
|
2019-04-22 16:01:25 +02:00
|
|
|
if (isset($config_xml['maxStringLength'])) {
|
|
|
|
$attribute_text = intval($config_xml['maxStringLength']);
|
|
|
|
$config->max_string_length = $attribute_text;
|
|
|
|
}
|
|
|
|
|
|
|
|
if (isset($config_xml['parseSql'])) {
|
|
|
|
$attribute_text = (string) $config_xml['parseSql'];
|
|
|
|
$config->parse_sql = $attribute_text === 'true' || $attribute_text === '1';
|
|
|
|
}
|
|
|
|
|
2016-12-29 14:42:39 +01:00
|
|
|
if (isset($config_xml->projectFiles)) {
|
2017-05-04 20:25:58 +02:00
|
|
|
$config->project_files = ProjectFileFilter::loadFromXMLElement($config_xml->projectFiles, $base_dir, true);
|
2016-06-10 00:08:25 +02:00
|
|
|
}
|
|
|
|
|
|
|
|
if (isset($config_xml->fileExtensions)) {
|
2016-06-21 01:30:38 +02:00
|
|
|
$config->file_extensions = [];
|
2016-06-10 20:47:44 +02:00
|
|
|
|
2016-06-21 01:30:38 +02:00
|
|
|
$config->loadFileExtensions($config_xml->fileExtensions->extension);
|
2016-06-10 20:47:44 +02:00
|
|
|
}
|
|
|
|
|
|
|
|
if (isset($config_xml->mockClasses) && isset($config_xml->mockClasses->class)) {
|
2016-11-22 01:07:56 +01:00
|
|
|
/** @var \SimpleXMLElement $mock_class */
|
2016-06-10 20:47:44 +02:00
|
|
|
foreach ($config_xml->mockClasses->class as $mock_class) {
|
2018-12-18 05:29:27 +01:00
|
|
|
$config->mock_classes[] = strtolower((string)$mock_class['name']);
|
2016-06-10 00:08:25 +02:00
|
|
|
}
|
2016-06-10 20:47:44 +02:00
|
|
|
}
|
|
|
|
|
2019-02-01 00:40:40 +01:00
|
|
|
if (isset($config_xml->ignoreExceptions)) {
|
|
|
|
if (isset($config_xml->ignoreExceptions->class)) {
|
|
|
|
/** @var \SimpleXMLElement $exception_class */
|
|
|
|
foreach ($config_xml->ignoreExceptions->class as $exception_class) {
|
2019-04-10 16:49:27 +02:00
|
|
|
$exception_name = (string) $exception_class['name'];
|
|
|
|
$global_attribute_text = (string) $exception_class['onlyGlobalScope'];
|
|
|
|
if ($global_attribute_text !== 'true' && $global_attribute_text !== '1') {
|
|
|
|
$config->ignored_exceptions[$exception_name] = true;
|
|
|
|
}
|
|
|
|
$config->ignored_exceptions_in_global_scope[$exception_name] = true;
|
2019-02-01 00:40:40 +01:00
|
|
|
}
|
|
|
|
}
|
|
|
|
if (isset($config_xml->ignoreExceptions->classAndDescendants)) {
|
|
|
|
/** @var \SimpleXMLElement $exception_class */
|
|
|
|
foreach ($config_xml->ignoreExceptions->classAndDescendants as $exception_class) {
|
2019-04-10 16:49:27 +02:00
|
|
|
$exception_name = (string) $exception_class['name'];
|
|
|
|
$global_attribute_text = (string) $exception_class['onlyGlobalScope'];
|
|
|
|
if ($global_attribute_text !== 'true' && $global_attribute_text !== '1') {
|
|
|
|
$config->ignored_exceptions_and_descendants[$exception_name] = true;
|
|
|
|
}
|
|
|
|
$config->ignored_exceptions_and_descendants_in_global_scope[$exception_name] = true;
|
2019-02-01 00:40:40 +01:00
|
|
|
}
|
2018-07-13 05:26:08 +02:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2018-09-18 22:42:51 +02:00
|
|
|
if (isset($config_xml->forbiddenFunctions) && isset($config_xml->forbiddenFunctions->function)) {
|
|
|
|
/** @var \SimpleXMLElement $forbidden_function */
|
|
|
|
foreach ($config_xml->forbiddenFunctions->function as $forbidden_function) {
|
|
|
|
$config->forbidden_functions[strtolower((string) $forbidden_function['name'])] = true;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2018-07-13 05:26:08 +02:00
|
|
|
if (isset($config_xml->exitFunctions) && isset($config_xml->exitFunctions->function)) {
|
|
|
|
/** @var \SimpleXMLElement $exit_function */
|
|
|
|
foreach ($config_xml->exitFunctions->function as $exit_function) {
|
|
|
|
$config->exit_functions[strtolower((string) $exit_function['name'])] = true;
|
2018-06-22 07:26:10 +02:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2017-02-01 01:21:33 +01:00
|
|
|
if (isset($config_xml->stubs) && isset($config_xml->stubs->file)) {
|
|
|
|
/** @var \SimpleXMLElement $stub_file */
|
|
|
|
foreach ($config_xml->stubs->file as $stub_file) {
|
2018-03-04 01:05:15 +01:00
|
|
|
$file_path = realpath($config->base_dir . DIRECTORY_SEPARATOR . $stub_file['name']);
|
2017-02-01 01:21:33 +01:00
|
|
|
|
|
|
|
if (!$file_path) {
|
2017-04-28 06:31:55 +02:00
|
|
|
throw new Exception\ConfigException(
|
2018-03-04 01:05:15 +01:00
|
|
|
'Cannot resolve stubfile path ' . $config->base_dir . DIRECTORY_SEPARATOR . $stub_file['name']
|
2017-04-28 06:31:55 +02:00
|
|
|
);
|
2017-02-01 01:21:33 +01:00
|
|
|
}
|
|
|
|
|
Plugin loading (#855)
* add ability to load plugins by class names
- Plugins need to implement `__invoke(PluginFacade $psalm):void` method
- Plugins are enabled by adding `<pluginClass
class="Qualified\Class\Name"/>`
- `PluginFacade` provides a single point of contact with Psalm, so that
plugins cannot become coupled to Psalm internals
* added `psalm-plugin` cli tool to manage plugins
Available commands:
`psalm-plugin list` - lists available and enabled plugins
`psalm-plugin enable 'Plugin\Class\Name'` - enables plugin (modifies `psalm.xml`)
`psalm-plugin disable 'Plugin\Class\Name'` - disables plugin (modifies `psalm.xml`)
Plugin installation:
`composer install plugin-vendor/plugin-package-name`
Plugin authoring:
Plugins are identified by package `type` field, which should contain
`psalm-plugin` string.
`extra.pluginClass` should refer to the name of the class implementing
`__invoke(PluginFacade $psalm):void` function
Todo:
- better config file search
- better output for `psalm-plugin`
- better formatting for modified xml file
- composer skeleton project for plugins
- ability to refer to plugins by package name (cli only)
- composer plugin to (optionally) enable plugin upon installation
- documentation on plugin installation and authoring
- interfaces for plugin dependencies
- interface for plugin entry point
- migration path for legacy plugins
* documented previously undocumented plugin methods
* split legacy plugin registration into a wrapper class
also added `PluginApi` namespace and `RegistrationInterface`
* reuse psalm's config search algorithm
* enable/disable plugins by composer package name
* allow specifying alternative config file name
* whitelist PluginApi namespace
three times, but well, it works now
* interface for plugin entry points
* psalm-plugin as a symfony console app
* fixed errors found by psalm
* suppressed false positive UnusedMethods
* cs fix
* better psalm-plugin output
* don't leave empty `plugins` node to avoid old schema violation
* removed junk file that shouldn't be there
* cs fix
* fixed phpunit failure (constant redefinition)
* work around missing docblock in on symfony console
* php 7.0 compatibility
* allow `pluginClass` child elements as plugin configuration
* decouple console commands from undelying implementation
- introduce PluginListFactory
- add `PluginList::enable(string $class)` and `PluginList::disable(string $class)`
* PluginList tests
* ComposerLock test
* droppped debugging statement
* added part of console command tests
* added tests for EnableCommand
* added DisableCommand tests
* ignore unused args
* ConfigFile test
* disable travis cache in attempt to fix builds
* nah, that didn't work
* update for upstream changes
* rebase fixes
* namespaced `extra` entry for entry point
* s/PluginFacade/PluginRegistrationSocket/g
* Added $config parameter to PluginEntryPointInterface::__invoke()
* cs fixes
* entry point interface php7.0 compatibility
* cleaned up old cruft
- dropped todos I'm not going to pursues
- locked entry point to be a class implementing entry point interface
* fixed legacy plugins docs
* Added RegistrationInterface::registerHooksFromClass()
It mimics the way old plugins were registered in Psalm\Config, so
handler classes extending Psalm\Plugin should be fully compatible with
it.
Since Psalm\Plugin-style plugin registration was moved to
RegistrationSocket, LegacyPlugin now only load file-based plugins, so it
was renamed to FileBasedPluginAdapter.
* Converted EchoChecker plugin to composer-based format
- Its subfolder is registered as a local composer package in the root
composer.json, so it's directly installable with
```
composer require psalm/echo-checker-plugin
```
- Migration is trivial: drop the plugin into a separate folder, then add
simple composer.json and the entry point class.
* Updated docs
* Don't reject hook handlers that inherit handling methods
* strip void return type in stub file
2018-11-11 05:23:36 +01:00
|
|
|
$config->addStubFile($file_path);
|
2017-02-01 01:21:33 +01:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2016-06-18 20:45:55 +02:00
|
|
|
// this plugin loading system borrows heavily from etsy/phan
|
Plugin loading (#855)
* add ability to load plugins by class names
- Plugins need to implement `__invoke(PluginFacade $psalm):void` method
- Plugins are enabled by adding `<pluginClass
class="Qualified\Class\Name"/>`
- `PluginFacade` provides a single point of contact with Psalm, so that
plugins cannot become coupled to Psalm internals
* added `psalm-plugin` cli tool to manage plugins
Available commands:
`psalm-plugin list` - lists available and enabled plugins
`psalm-plugin enable 'Plugin\Class\Name'` - enables plugin (modifies `psalm.xml`)
`psalm-plugin disable 'Plugin\Class\Name'` - disables plugin (modifies `psalm.xml`)
Plugin installation:
`composer install plugin-vendor/plugin-package-name`
Plugin authoring:
Plugins are identified by package `type` field, which should contain
`psalm-plugin` string.
`extra.pluginClass` should refer to the name of the class implementing
`__invoke(PluginFacade $psalm):void` function
Todo:
- better config file search
- better output for `psalm-plugin`
- better formatting for modified xml file
- composer skeleton project for plugins
- ability to refer to plugins by package name (cli only)
- composer plugin to (optionally) enable plugin upon installation
- documentation on plugin installation and authoring
- interfaces for plugin dependencies
- interface for plugin entry point
- migration path for legacy plugins
* documented previously undocumented plugin methods
* split legacy plugin registration into a wrapper class
also added `PluginApi` namespace and `RegistrationInterface`
* reuse psalm's config search algorithm
* enable/disable plugins by composer package name
* allow specifying alternative config file name
* whitelist PluginApi namespace
three times, but well, it works now
* interface for plugin entry points
* psalm-plugin as a symfony console app
* fixed errors found by psalm
* suppressed false positive UnusedMethods
* cs fix
* better psalm-plugin output
* don't leave empty `plugins` node to avoid old schema violation
* removed junk file that shouldn't be there
* cs fix
* fixed phpunit failure (constant redefinition)
* work around missing docblock in on symfony console
* php 7.0 compatibility
* allow `pluginClass` child elements as plugin configuration
* decouple console commands from undelying implementation
- introduce PluginListFactory
- add `PluginList::enable(string $class)` and `PluginList::disable(string $class)`
* PluginList tests
* ComposerLock test
* droppped debugging statement
* added part of console command tests
* added tests for EnableCommand
* added DisableCommand tests
* ignore unused args
* ConfigFile test
* disable travis cache in attempt to fix builds
* nah, that didn't work
* update for upstream changes
* rebase fixes
* namespaced `extra` entry for entry point
* s/PluginFacade/PluginRegistrationSocket/g
* Added $config parameter to PluginEntryPointInterface::__invoke()
* cs fixes
* entry point interface php7.0 compatibility
* cleaned up old cruft
- dropped todos I'm not going to pursues
- locked entry point to be a class implementing entry point interface
* fixed legacy plugins docs
* Added RegistrationInterface::registerHooksFromClass()
It mimics the way old plugins were registered in Psalm\Config, so
handler classes extending Psalm\Plugin should be fully compatible with
it.
Since Psalm\Plugin-style plugin registration was moved to
RegistrationSocket, LegacyPlugin now only load file-based plugins, so it
was renamed to FileBasedPluginAdapter.
* Converted EchoChecker plugin to composer-based format
- Its subfolder is registered as a local composer package in the root
composer.json, so it's directly installable with
```
composer require psalm/echo-checker-plugin
```
- Migration is trivial: drop the plugin into a separate folder, then add
simple composer.json and the entry point class.
* Updated docs
* Don't reject hook handlers that inherit handling methods
* strip void return type in stub file
2018-11-11 05:23:36 +01:00
|
|
|
if (isset($config_xml->plugins)) {
|
|
|
|
if (isset($config_xml->plugins->plugin)) {
|
|
|
|
/** @var \SimpleXMLElement $plugin */
|
|
|
|
foreach ($config_xml->plugins->plugin as $plugin) {
|
2019-05-03 16:27:09 +02:00
|
|
|
$plugin_file_name = (string) $plugin['filename'];
|
2016-06-20 06:38:13 +02:00
|
|
|
|
2019-05-03 16:27:09 +02:00
|
|
|
$path = isAbsolutePath($plugin_file_name)
|
|
|
|
? $plugin_file_name
|
|
|
|
: $config->base_dir . $plugin_file_name;
|
2016-06-20 06:38:13 +02:00
|
|
|
|
Plugin loading (#855)
* add ability to load plugins by class names
- Plugins need to implement `__invoke(PluginFacade $psalm):void` method
- Plugins are enabled by adding `<pluginClass
class="Qualified\Class\Name"/>`
- `PluginFacade` provides a single point of contact with Psalm, so that
plugins cannot become coupled to Psalm internals
* added `psalm-plugin` cli tool to manage plugins
Available commands:
`psalm-plugin list` - lists available and enabled plugins
`psalm-plugin enable 'Plugin\Class\Name'` - enables plugin (modifies `psalm.xml`)
`psalm-plugin disable 'Plugin\Class\Name'` - disables plugin (modifies `psalm.xml`)
Plugin installation:
`composer install plugin-vendor/plugin-package-name`
Plugin authoring:
Plugins are identified by package `type` field, which should contain
`psalm-plugin` string.
`extra.pluginClass` should refer to the name of the class implementing
`__invoke(PluginFacade $psalm):void` function
Todo:
- better config file search
- better output for `psalm-plugin`
- better formatting for modified xml file
- composer skeleton project for plugins
- ability to refer to plugins by package name (cli only)
- composer plugin to (optionally) enable plugin upon installation
- documentation on plugin installation and authoring
- interfaces for plugin dependencies
- interface for plugin entry point
- migration path for legacy plugins
* documented previously undocumented plugin methods
* split legacy plugin registration into a wrapper class
also added `PluginApi` namespace and `RegistrationInterface`
* reuse psalm's config search algorithm
* enable/disable plugins by composer package name
* allow specifying alternative config file name
* whitelist PluginApi namespace
three times, but well, it works now
* interface for plugin entry points
* psalm-plugin as a symfony console app
* fixed errors found by psalm
* suppressed false positive UnusedMethods
* cs fix
* better psalm-plugin output
* don't leave empty `plugins` node to avoid old schema violation
* removed junk file that shouldn't be there
* cs fix
* fixed phpunit failure (constant redefinition)
* work around missing docblock in on symfony console
* php 7.0 compatibility
* allow `pluginClass` child elements as plugin configuration
* decouple console commands from undelying implementation
- introduce PluginListFactory
- add `PluginList::enable(string $class)` and `PluginList::disable(string $class)`
* PluginList tests
* ComposerLock test
* droppped debugging statement
* added part of console command tests
* added tests for EnableCommand
* added DisableCommand tests
* ignore unused args
* ConfigFile test
* disable travis cache in attempt to fix builds
* nah, that didn't work
* update for upstream changes
* rebase fixes
* namespaced `extra` entry for entry point
* s/PluginFacade/PluginRegistrationSocket/g
* Added $config parameter to PluginEntryPointInterface::__invoke()
* cs fixes
* entry point interface php7.0 compatibility
* cleaned up old cruft
- dropped todos I'm not going to pursues
- locked entry point to be a class implementing entry point interface
* fixed legacy plugins docs
* Added RegistrationInterface::registerHooksFromClass()
It mimics the way old plugins were registered in Psalm\Config, so
handler classes extending Psalm\Plugin should be fully compatible with
it.
Since Psalm\Plugin-style plugin registration was moved to
RegistrationSocket, LegacyPlugin now only load file-based plugins, so it
was renamed to FileBasedPluginAdapter.
* Converted EchoChecker plugin to composer-based format
- Its subfolder is registered as a local composer package in the root
composer.json, so it's directly installable with
```
composer require psalm/echo-checker-plugin
```
- Migration is trivial: drop the plugin into a separate folder, then add
simple composer.json and the entry point class.
* Updated docs
* Don't reject hook handlers that inherit handling methods
* strip void return type in stub file
2018-11-11 05:23:36 +01:00
|
|
|
$config->addPluginPath($path);
|
|
|
|
}
|
|
|
|
}
|
|
|
|
if (isset($config_xml->plugins->pluginClass)) {
|
|
|
|
/** @var \SimpleXMLElement $plugin */
|
|
|
|
foreach ($config_xml->plugins->pluginClass as $plugin) {
|
|
|
|
$plugin_class_name = $plugin['class'];
|
|
|
|
// any child elements are used as plugin configuration
|
|
|
|
$plugin_config = null;
|
|
|
|
if ($plugin->count()) {
|
|
|
|
$plugin_config = $plugin->children();
|
|
|
|
}
|
|
|
|
|
|
|
|
$config->addPluginClass($plugin_class_name, $plugin_config);
|
|
|
|
}
|
2016-06-18 20:45:55 +02:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2016-12-30 02:07:42 +01:00
|
|
|
if (isset($config_xml->issueHandlers)) {
|
2016-11-22 01:07:56 +01:00
|
|
|
/** @var \SimpleXMLElement $issue_handler */
|
2016-12-30 02:07:42 +01:00
|
|
|
foreach ($config_xml->issueHandlers->children() as $key => $issue_handler) {
|
2019-01-07 14:38:56 +01:00
|
|
|
if ($key === 'PluginIssue') {
|
|
|
|
$custom_class_name = (string) $issue_handler['name'];
|
|
|
|
/** @var string $key */
|
|
|
|
$config->issue_handlers[$custom_class_name] = IssueHandler::loadFromXMLElement(
|
|
|
|
$issue_handler,
|
|
|
|
$base_dir
|
|
|
|
);
|
|
|
|
} else {
|
|
|
|
/** @var string $key */
|
|
|
|
$config->issue_handlers[$key] = IssueHandler::loadFromXMLElement(
|
|
|
|
$issue_handler,
|
|
|
|
$base_dir
|
|
|
|
);
|
|
|
|
}
|
2016-06-10 00:08:25 +02:00
|
|
|
}
|
|
|
|
}
|
2016-06-26 19:45:20 +02:00
|
|
|
|
2019-03-06 00:08:41 +01:00
|
|
|
if (isset($config_xml->globals) && isset($config_xml->globals->var)) {
|
|
|
|
/** @var \SimpleXMLElement $var */
|
|
|
|
foreach ($config_xml->globals->var as $var) {
|
2019-03-14 01:15:29 +01:00
|
|
|
$config->globals['$' . (string) $var['name']] = (string) $var['type'];
|
2019-03-06 00:08:41 +01:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2016-06-26 19:45:20 +02:00
|
|
|
return $config;
|
2016-06-10 00:08:25 +02:00
|
|
|
}
|
|
|
|
|
2018-04-13 16:32:08 +02:00
|
|
|
/**
|
|
|
|
* @param string $autoloader_path
|
|
|
|
*
|
|
|
|
* @return void
|
|
|
|
*
|
|
|
|
* @psalm-suppress UnresolvableInclude
|
|
|
|
*/
|
|
|
|
private function requireAutoloader($autoloader_path)
|
|
|
|
{
|
|
|
|
require_once($autoloader_path);
|
|
|
|
}
|
|
|
|
|
2016-06-10 00:08:25 +02:00
|
|
|
/**
|
|
|
|
* @return $this
|
|
|
|
*/
|
2016-06-06 07:07:50 +02:00
|
|
|
public static function getInstance()
|
|
|
|
{
|
2018-01-21 19:38:51 +01:00
|
|
|
if (self::$instance) {
|
|
|
|
return self::$instance;
|
2016-06-06 07:07:50 +02:00
|
|
|
}
|
|
|
|
|
2018-01-21 19:38:51 +01:00
|
|
|
throw new \UnexpectedValueException('No config initialized');
|
2016-06-06 07:07:50 +02:00
|
|
|
}
|
|
|
|
|
2018-03-03 21:25:35 +01:00
|
|
|
/**
|
|
|
|
* @return void
|
|
|
|
*/
|
2019-04-20 22:37:27 +02:00
|
|
|
public function setComposerClassLoader(ClassLoader $loader = null)
|
2018-03-03 21:19:05 +01:00
|
|
|
{
|
|
|
|
$this->composer_class_loader = $loader;
|
|
|
|
}
|
|
|
|
|
2016-12-09 04:37:59 +01:00
|
|
|
/**
|
|
|
|
* @param string $issue_key
|
|
|
|
* @param string $error_level
|
2017-05-27 02:16:18 +02:00
|
|
|
*
|
2016-12-09 04:37:59 +01:00
|
|
|
* @return void
|
|
|
|
*/
|
|
|
|
public function setCustomErrorLevel($issue_key, $error_level)
|
|
|
|
{
|
2016-12-30 02:07:42 +01:00
|
|
|
$this->issue_handlers[$issue_key] = new IssueHandler();
|
|
|
|
$this->issue_handlers[$issue_key]->setErrorLevel($error_level);
|
2016-12-09 04:37:59 +01:00
|
|
|
}
|
|
|
|
|
2016-10-30 17:46:18 +01:00
|
|
|
/**
|
2018-01-02 03:17:23 +01:00
|
|
|
* @param array<SimpleXMLElement> $extensions
|
2017-05-27 02:16:18 +02:00
|
|
|
*
|
|
|
|
* @throws ConfigException if a Config file could not be found
|
|
|
|
*
|
2016-10-30 17:46:18 +01:00
|
|
|
* @return void
|
|
|
|
*/
|
2017-02-12 00:56:38 +01:00
|
|
|
private function loadFileExtensions($extensions)
|
2016-06-20 06:38:13 +02:00
|
|
|
{
|
|
|
|
foreach ($extensions as $extension) {
|
2016-11-05 02:14:04 +01:00
|
|
|
$extension_name = preg_replace('/^\.?/', '', (string)$extension['name']);
|
2016-06-20 06:38:13 +02:00
|
|
|
$this->file_extensions[] = $extension_name;
|
|
|
|
|
2018-01-21 19:38:51 +01:00
|
|
|
if (isset($extension['scanner'])) {
|
|
|
|
$path = $this->base_dir . (string)$extension['scanner'];
|
|
|
|
|
|
|
|
if (!file_exists($path)) {
|
|
|
|
throw new Exception\ConfigException('Error parsing config: cannot find file ' . $path);
|
|
|
|
}
|
|
|
|
|
2018-02-12 02:56:34 +01:00
|
|
|
$this->filetype_scanner_paths[$extension_name] = $path;
|
2018-01-21 19:38:51 +01:00
|
|
|
}
|
|
|
|
|
|
|
|
if (isset($extension['checker'])) {
|
|
|
|
$path = $this->base_dir . (string)$extension['checker'];
|
2016-06-20 06:38:13 +02:00
|
|
|
|
|
|
|
if (!file_exists($path)) {
|
2016-06-20 07:05:44 +02:00
|
|
|
throw new Exception\ConfigException('Error parsing config: cannot find file ' . $path);
|
2016-06-20 06:38:13 +02:00
|
|
|
}
|
|
|
|
|
2018-11-11 18:01:14 +01:00
|
|
|
$this->filetype_analyzer_paths[$extension_name] = $path;
|
2017-01-02 21:31:18 +01:00
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
2016-06-20 06:38:13 +02:00
|
|
|
|
2018-02-12 02:56:34 +01:00
|
|
|
/**
|
|
|
|
* @param string $path
|
|
|
|
*
|
|
|
|
* @return void
|
|
|
|
*/
|
|
|
|
public function addPluginPath($path)
|
|
|
|
{
|
|
|
|
if (!file_exists($path)) {
|
|
|
|
throw new \InvalidArgumentException('Cannot find plugin file ' . $path);
|
|
|
|
}
|
|
|
|
|
|
|
|
$this->plugin_paths[] = $path;
|
|
|
|
}
|
|
|
|
|
Plugin loading (#855)
* add ability to load plugins by class names
- Plugins need to implement `__invoke(PluginFacade $psalm):void` method
- Plugins are enabled by adding `<pluginClass
class="Qualified\Class\Name"/>`
- `PluginFacade` provides a single point of contact with Psalm, so that
plugins cannot become coupled to Psalm internals
* added `psalm-plugin` cli tool to manage plugins
Available commands:
`psalm-plugin list` - lists available and enabled plugins
`psalm-plugin enable 'Plugin\Class\Name'` - enables plugin (modifies `psalm.xml`)
`psalm-plugin disable 'Plugin\Class\Name'` - disables plugin (modifies `psalm.xml`)
Plugin installation:
`composer install plugin-vendor/plugin-package-name`
Plugin authoring:
Plugins are identified by package `type` field, which should contain
`psalm-plugin` string.
`extra.pluginClass` should refer to the name of the class implementing
`__invoke(PluginFacade $psalm):void` function
Todo:
- better config file search
- better output for `psalm-plugin`
- better formatting for modified xml file
- composer skeleton project for plugins
- ability to refer to plugins by package name (cli only)
- composer plugin to (optionally) enable plugin upon installation
- documentation on plugin installation and authoring
- interfaces for plugin dependencies
- interface for plugin entry point
- migration path for legacy plugins
* documented previously undocumented plugin methods
* split legacy plugin registration into a wrapper class
also added `PluginApi` namespace and `RegistrationInterface`
* reuse psalm's config search algorithm
* enable/disable plugins by composer package name
* allow specifying alternative config file name
* whitelist PluginApi namespace
three times, but well, it works now
* interface for plugin entry points
* psalm-plugin as a symfony console app
* fixed errors found by psalm
* suppressed false positive UnusedMethods
* cs fix
* better psalm-plugin output
* don't leave empty `plugins` node to avoid old schema violation
* removed junk file that shouldn't be there
* cs fix
* fixed phpunit failure (constant redefinition)
* work around missing docblock in on symfony console
* php 7.0 compatibility
* allow `pluginClass` child elements as plugin configuration
* decouple console commands from undelying implementation
- introduce PluginListFactory
- add `PluginList::enable(string $class)` and `PluginList::disable(string $class)`
* PluginList tests
* ComposerLock test
* droppped debugging statement
* added part of console command tests
* added tests for EnableCommand
* added DisableCommand tests
* ignore unused args
* ConfigFile test
* disable travis cache in attempt to fix builds
* nah, that didn't work
* update for upstream changes
* rebase fixes
* namespaced `extra` entry for entry point
* s/PluginFacade/PluginRegistrationSocket/g
* Added $config parameter to PluginEntryPointInterface::__invoke()
* cs fixes
* entry point interface php7.0 compatibility
* cleaned up old cruft
- dropped todos I'm not going to pursues
- locked entry point to be a class implementing entry point interface
* fixed legacy plugins docs
* Added RegistrationInterface::registerHooksFromClass()
It mimics the way old plugins were registered in Psalm\Config, so
handler classes extending Psalm\Plugin should be fully compatible with
it.
Since Psalm\Plugin-style plugin registration was moved to
RegistrationSocket, LegacyPlugin now only load file-based plugins, so it
was renamed to FileBasedPluginAdapter.
* Converted EchoChecker plugin to composer-based format
- Its subfolder is registered as a local composer package in the root
composer.json, so it's directly installable with
```
composer require psalm/echo-checker-plugin
```
- Migration is trivial: drop the plugin into a separate folder, then add
simple composer.json and the entry point class.
* Updated docs
* Don't reject hook handlers that inherit handling methods
* strip void return type in stub file
2018-11-11 05:23:36 +01:00
|
|
|
/** @return void */
|
2019-02-17 15:15:37 +01:00
|
|
|
public function addPluginClass(string $class_name, SimpleXMLElement $plugin_config = null)
|
Plugin loading (#855)
* add ability to load plugins by class names
- Plugins need to implement `__invoke(PluginFacade $psalm):void` method
- Plugins are enabled by adding `<pluginClass
class="Qualified\Class\Name"/>`
- `PluginFacade` provides a single point of contact with Psalm, so that
plugins cannot become coupled to Psalm internals
* added `psalm-plugin` cli tool to manage plugins
Available commands:
`psalm-plugin list` - lists available and enabled plugins
`psalm-plugin enable 'Plugin\Class\Name'` - enables plugin (modifies `psalm.xml`)
`psalm-plugin disable 'Plugin\Class\Name'` - disables plugin (modifies `psalm.xml`)
Plugin installation:
`composer install plugin-vendor/plugin-package-name`
Plugin authoring:
Plugins are identified by package `type` field, which should contain
`psalm-plugin` string.
`extra.pluginClass` should refer to the name of the class implementing
`__invoke(PluginFacade $psalm):void` function
Todo:
- better config file search
- better output for `psalm-plugin`
- better formatting for modified xml file
- composer skeleton project for plugins
- ability to refer to plugins by package name (cli only)
- composer plugin to (optionally) enable plugin upon installation
- documentation on plugin installation and authoring
- interfaces for plugin dependencies
- interface for plugin entry point
- migration path for legacy plugins
* documented previously undocumented plugin methods
* split legacy plugin registration into a wrapper class
also added `PluginApi` namespace and `RegistrationInterface`
* reuse psalm's config search algorithm
* enable/disable plugins by composer package name
* allow specifying alternative config file name
* whitelist PluginApi namespace
three times, but well, it works now
* interface for plugin entry points
* psalm-plugin as a symfony console app
* fixed errors found by psalm
* suppressed false positive UnusedMethods
* cs fix
* better psalm-plugin output
* don't leave empty `plugins` node to avoid old schema violation
* removed junk file that shouldn't be there
* cs fix
* fixed phpunit failure (constant redefinition)
* work around missing docblock in on symfony console
* php 7.0 compatibility
* allow `pluginClass` child elements as plugin configuration
* decouple console commands from undelying implementation
- introduce PluginListFactory
- add `PluginList::enable(string $class)` and `PluginList::disable(string $class)`
* PluginList tests
* ComposerLock test
* droppped debugging statement
* added part of console command tests
* added tests for EnableCommand
* added DisableCommand tests
* ignore unused args
* ConfigFile test
* disable travis cache in attempt to fix builds
* nah, that didn't work
* update for upstream changes
* rebase fixes
* namespaced `extra` entry for entry point
* s/PluginFacade/PluginRegistrationSocket/g
* Added $config parameter to PluginEntryPointInterface::__invoke()
* cs fixes
* entry point interface php7.0 compatibility
* cleaned up old cruft
- dropped todos I'm not going to pursues
- locked entry point to be a class implementing entry point interface
* fixed legacy plugins docs
* Added RegistrationInterface::registerHooksFromClass()
It mimics the way old plugins were registered in Psalm\Config, so
handler classes extending Psalm\Plugin should be fully compatible with
it.
Since Psalm\Plugin-style plugin registration was moved to
RegistrationSocket, LegacyPlugin now only load file-based plugins, so it
was renamed to FileBasedPluginAdapter.
* Converted EchoChecker plugin to composer-based format
- Its subfolder is registered as a local composer package in the root
composer.json, so it's directly installable with
```
composer require psalm/echo-checker-plugin
```
- Migration is trivial: drop the plugin into a separate folder, then add
simple composer.json and the entry point class.
* Updated docs
* Don't reject hook handlers that inherit handling methods
* strip void return type in stub file
2018-11-11 05:23:36 +01:00
|
|
|
{
|
|
|
|
$this->plugin_classes[] = ['class' => $class_name, 'config' => $plugin_config];
|
|
|
|
}
|
|
|
|
|
|
|
|
/** @return array<array{class:string, config:?SimpleXmlElement}> */
|
|
|
|
public function getPluginClasses(): array
|
|
|
|
{
|
|
|
|
return $this->plugin_classes;
|
|
|
|
}
|
|
|
|
|
2017-01-02 21:31:18 +01:00
|
|
|
/**
|
|
|
|
* Initialises all the plugins (done once the config is fully loaded)
|
2017-05-27 02:16:18 +02:00
|
|
|
*
|
2017-01-02 21:31:18 +01:00
|
|
|
* @return void
|
|
|
|
* @psalm-suppress MixedArrayAccess
|
|
|
|
* @psalm-suppress MixedAssignment
|
|
|
|
* @psalm-suppress MixedOperand
|
2018-05-18 17:02:50 +02:00
|
|
|
* @psalm-suppress MixedArrayOffset
|
|
|
|
* @psalm-suppress MixedTypeCoercion
|
2017-01-02 21:31:18 +01:00
|
|
|
*/
|
2018-11-11 18:01:14 +01:00
|
|
|
public function initializePlugins(ProjectAnalyzer $project_analyzer)
|
2017-01-02 21:31:18 +01:00
|
|
|
{
|
2018-11-11 18:01:14 +01:00
|
|
|
$codebase = $project_analyzer->getCodebase();
|
Plugin loading (#855)
* add ability to load plugins by class names
- Plugins need to implement `__invoke(PluginFacade $psalm):void` method
- Plugins are enabled by adding `<pluginClass
class="Qualified\Class\Name"/>`
- `PluginFacade` provides a single point of contact with Psalm, so that
plugins cannot become coupled to Psalm internals
* added `psalm-plugin` cli tool to manage plugins
Available commands:
`psalm-plugin list` - lists available and enabled plugins
`psalm-plugin enable 'Plugin\Class\Name'` - enables plugin (modifies `psalm.xml`)
`psalm-plugin disable 'Plugin\Class\Name'` - disables plugin (modifies `psalm.xml`)
Plugin installation:
`composer install plugin-vendor/plugin-package-name`
Plugin authoring:
Plugins are identified by package `type` field, which should contain
`psalm-plugin` string.
`extra.pluginClass` should refer to the name of the class implementing
`__invoke(PluginFacade $psalm):void` function
Todo:
- better config file search
- better output for `psalm-plugin`
- better formatting for modified xml file
- composer skeleton project for plugins
- ability to refer to plugins by package name (cli only)
- composer plugin to (optionally) enable plugin upon installation
- documentation on plugin installation and authoring
- interfaces for plugin dependencies
- interface for plugin entry point
- migration path for legacy plugins
* documented previously undocumented plugin methods
* split legacy plugin registration into a wrapper class
also added `PluginApi` namespace and `RegistrationInterface`
* reuse psalm's config search algorithm
* enable/disable plugins by composer package name
* allow specifying alternative config file name
* whitelist PluginApi namespace
three times, but well, it works now
* interface for plugin entry points
* psalm-plugin as a symfony console app
* fixed errors found by psalm
* suppressed false positive UnusedMethods
* cs fix
* better psalm-plugin output
* don't leave empty `plugins` node to avoid old schema violation
* removed junk file that shouldn't be there
* cs fix
* fixed phpunit failure (constant redefinition)
* work around missing docblock in on symfony console
* php 7.0 compatibility
* allow `pluginClass` child elements as plugin configuration
* decouple console commands from undelying implementation
- introduce PluginListFactory
- add `PluginList::enable(string $class)` and `PluginList::disable(string $class)`
* PluginList tests
* ComposerLock test
* droppped debugging statement
* added part of console command tests
* added tests for EnableCommand
* added DisableCommand tests
* ignore unused args
* ConfigFile test
* disable travis cache in attempt to fix builds
* nah, that didn't work
* update for upstream changes
* rebase fixes
* namespaced `extra` entry for entry point
* s/PluginFacade/PluginRegistrationSocket/g
* Added $config parameter to PluginEntryPointInterface::__invoke()
* cs fixes
* entry point interface php7.0 compatibility
* cleaned up old cruft
- dropped todos I'm not going to pursues
- locked entry point to be a class implementing entry point interface
* fixed legacy plugins docs
* Added RegistrationInterface::registerHooksFromClass()
It mimics the way old plugins were registered in Psalm\Config, so
handler classes extending Psalm\Plugin should be fully compatible with
it.
Since Psalm\Plugin-style plugin registration was moved to
RegistrationSocket, LegacyPlugin now only load file-based plugins, so it
was renamed to FileBasedPluginAdapter.
* Converted EchoChecker plugin to composer-based format
- Its subfolder is registered as a local composer package in the root
composer.json, so it's directly installable with
```
composer require psalm/echo-checker-plugin
```
- Migration is trivial: drop the plugin into a separate folder, then add
simple composer.json and the entry point class.
* Updated docs
* Don't reject hook handlers that inherit handling methods
* strip void return type in stub file
2018-11-11 05:23:36 +01:00
|
|
|
|
2019-03-01 14:57:10 +01:00
|
|
|
$socket = new PluginRegistrationSocket($this, $codebase);
|
Plugin loading (#855)
* add ability to load plugins by class names
- Plugins need to implement `__invoke(PluginFacade $psalm):void` method
- Plugins are enabled by adding `<pluginClass
class="Qualified\Class\Name"/>`
- `PluginFacade` provides a single point of contact with Psalm, so that
plugins cannot become coupled to Psalm internals
* added `psalm-plugin` cli tool to manage plugins
Available commands:
`psalm-plugin list` - lists available and enabled plugins
`psalm-plugin enable 'Plugin\Class\Name'` - enables plugin (modifies `psalm.xml`)
`psalm-plugin disable 'Plugin\Class\Name'` - disables plugin (modifies `psalm.xml`)
Plugin installation:
`composer install plugin-vendor/plugin-package-name`
Plugin authoring:
Plugins are identified by package `type` field, which should contain
`psalm-plugin` string.
`extra.pluginClass` should refer to the name of the class implementing
`__invoke(PluginFacade $psalm):void` function
Todo:
- better config file search
- better output for `psalm-plugin`
- better formatting for modified xml file
- composer skeleton project for plugins
- ability to refer to plugins by package name (cli only)
- composer plugin to (optionally) enable plugin upon installation
- documentation on plugin installation and authoring
- interfaces for plugin dependencies
- interface for plugin entry point
- migration path for legacy plugins
* documented previously undocumented plugin methods
* split legacy plugin registration into a wrapper class
also added `PluginApi` namespace and `RegistrationInterface`
* reuse psalm's config search algorithm
* enable/disable plugins by composer package name
* allow specifying alternative config file name
* whitelist PluginApi namespace
three times, but well, it works now
* interface for plugin entry points
* psalm-plugin as a symfony console app
* fixed errors found by psalm
* suppressed false positive UnusedMethods
* cs fix
* better psalm-plugin output
* don't leave empty `plugins` node to avoid old schema violation
* removed junk file that shouldn't be there
* cs fix
* fixed phpunit failure (constant redefinition)
* work around missing docblock in on symfony console
* php 7.0 compatibility
* allow `pluginClass` child elements as plugin configuration
* decouple console commands from undelying implementation
- introduce PluginListFactory
- add `PluginList::enable(string $class)` and `PluginList::disable(string $class)`
* PluginList tests
* ComposerLock test
* droppped debugging statement
* added part of console command tests
* added tests for EnableCommand
* added DisableCommand tests
* ignore unused args
* ConfigFile test
* disable travis cache in attempt to fix builds
* nah, that didn't work
* update for upstream changes
* rebase fixes
* namespaced `extra` entry for entry point
* s/PluginFacade/PluginRegistrationSocket/g
* Added $config parameter to PluginEntryPointInterface::__invoke()
* cs fixes
* entry point interface php7.0 compatibility
* cleaned up old cruft
- dropped todos I'm not going to pursues
- locked entry point to be a class implementing entry point interface
* fixed legacy plugins docs
* Added RegistrationInterface::registerHooksFromClass()
It mimics the way old plugins were registered in Psalm\Config, so
handler classes extending Psalm\Plugin should be fully compatible with
it.
Since Psalm\Plugin-style plugin registration was moved to
RegistrationSocket, LegacyPlugin now only load file-based plugins, so it
was renamed to FileBasedPluginAdapter.
* Converted EchoChecker plugin to composer-based format
- Its subfolder is registered as a local composer package in the root
composer.json, so it's directly installable with
```
composer require psalm/echo-checker-plugin
```
- Migration is trivial: drop the plugin into a separate folder, then add
simple composer.json and the entry point class.
* Updated docs
* Don't reject hook handlers that inherit handling methods
* strip void return type in stub file
2018-11-11 05:23:36 +01:00
|
|
|
// initialize plugin classes earlier to let them hook into subsequent load process
|
|
|
|
foreach ($this->plugin_classes as $plugin_class_entry) {
|
|
|
|
$plugin_class_name = $plugin_class_entry['class'];
|
|
|
|
$plugin_config = $plugin_class_entry['config'];
|
|
|
|
try {
|
2018-11-25 16:41:22 +01:00
|
|
|
if ($this->composer_class_loader) {
|
|
|
|
$plugin_class_path = $this->composer_class_loader->findFile($plugin_class_name);
|
|
|
|
|
|
|
|
if (!$plugin_class_path) {
|
|
|
|
throw new \UnexpectedValueException($plugin_class_name . ' is not a known class');
|
|
|
|
}
|
|
|
|
|
|
|
|
/** @psalm-suppress UnresolvableInclude */
|
|
|
|
require_once($plugin_class_path);
|
|
|
|
} else {
|
|
|
|
if (!class_exists($plugin_class_name, true)) {
|
|
|
|
throw new \UnexpectedValueException($plugin_class_name . ' is not a known class');
|
|
|
|
}
|
2018-11-12 18:03:55 +01:00
|
|
|
}
|
|
|
|
|
2018-11-25 16:41:22 +01:00
|
|
|
/**
|
|
|
|
* @psalm-suppress InvalidStringClass
|
|
|
|
* @var Plugin\PluginEntryPointInterface $plugin_object
|
|
|
|
*/
|
Plugin loading (#855)
* add ability to load plugins by class names
- Plugins need to implement `__invoke(PluginFacade $psalm):void` method
- Plugins are enabled by adding `<pluginClass
class="Qualified\Class\Name"/>`
- `PluginFacade` provides a single point of contact with Psalm, so that
plugins cannot become coupled to Psalm internals
* added `psalm-plugin` cli tool to manage plugins
Available commands:
`psalm-plugin list` - lists available and enabled plugins
`psalm-plugin enable 'Plugin\Class\Name'` - enables plugin (modifies `psalm.xml`)
`psalm-plugin disable 'Plugin\Class\Name'` - disables plugin (modifies `psalm.xml`)
Plugin installation:
`composer install plugin-vendor/plugin-package-name`
Plugin authoring:
Plugins are identified by package `type` field, which should contain
`psalm-plugin` string.
`extra.pluginClass` should refer to the name of the class implementing
`__invoke(PluginFacade $psalm):void` function
Todo:
- better config file search
- better output for `psalm-plugin`
- better formatting for modified xml file
- composer skeleton project for plugins
- ability to refer to plugins by package name (cli only)
- composer plugin to (optionally) enable plugin upon installation
- documentation on plugin installation and authoring
- interfaces for plugin dependencies
- interface for plugin entry point
- migration path for legacy plugins
* documented previously undocumented plugin methods
* split legacy plugin registration into a wrapper class
also added `PluginApi` namespace and `RegistrationInterface`
* reuse psalm's config search algorithm
* enable/disable plugins by composer package name
* allow specifying alternative config file name
* whitelist PluginApi namespace
three times, but well, it works now
* interface for plugin entry points
* psalm-plugin as a symfony console app
* fixed errors found by psalm
* suppressed false positive UnusedMethods
* cs fix
* better psalm-plugin output
* don't leave empty `plugins` node to avoid old schema violation
* removed junk file that shouldn't be there
* cs fix
* fixed phpunit failure (constant redefinition)
* work around missing docblock in on symfony console
* php 7.0 compatibility
* allow `pluginClass` child elements as plugin configuration
* decouple console commands from undelying implementation
- introduce PluginListFactory
- add `PluginList::enable(string $class)` and `PluginList::disable(string $class)`
* PluginList tests
* ComposerLock test
* droppped debugging statement
* added part of console command tests
* added tests for EnableCommand
* added DisableCommand tests
* ignore unused args
* ConfigFile test
* disable travis cache in attempt to fix builds
* nah, that didn't work
* update for upstream changes
* rebase fixes
* namespaced `extra` entry for entry point
* s/PluginFacade/PluginRegistrationSocket/g
* Added $config parameter to PluginEntryPointInterface::__invoke()
* cs fixes
* entry point interface php7.0 compatibility
* cleaned up old cruft
- dropped todos I'm not going to pursues
- locked entry point to be a class implementing entry point interface
* fixed legacy plugins docs
* Added RegistrationInterface::registerHooksFromClass()
It mimics the way old plugins were registered in Psalm\Config, so
handler classes extending Psalm\Plugin should be fully compatible with
it.
Since Psalm\Plugin-style plugin registration was moved to
RegistrationSocket, LegacyPlugin now only load file-based plugins, so it
was renamed to FileBasedPluginAdapter.
* Converted EchoChecker plugin to composer-based format
- Its subfolder is registered as a local composer package in the root
composer.json, so it's directly installable with
```
composer require psalm/echo-checker-plugin
```
- Migration is trivial: drop the plugin into a separate folder, then add
simple composer.json and the entry point class.
* Updated docs
* Don't reject hook handlers that inherit handling methods
* strip void return type in stub file
2018-11-11 05:23:36 +01:00
|
|
|
$plugin_object = new $plugin_class_name;
|
|
|
|
$plugin_object($socket, $plugin_config);
|
|
|
|
} catch (\Throwable $e) {
|
|
|
|
throw new ConfigException('Failed to load plugin ' . $plugin_class_name, 0, $e);
|
|
|
|
}
|
|
|
|
}
|
2018-01-21 19:38:51 +01:00
|
|
|
|
2018-02-12 02:56:34 +01:00
|
|
|
foreach ($this->filetype_scanner_paths as $extension => $path) {
|
2018-11-06 03:57:36 +01:00
|
|
|
$fq_class_name = $this->getPluginClassForPath(
|
|
|
|
$codebase,
|
|
|
|
$path,
|
2019-01-02 12:58:49 +01:00
|
|
|
FileScanner::class
|
2018-11-06 03:57:36 +01:00
|
|
|
);
|
2018-01-21 19:38:51 +01:00
|
|
|
|
|
|
|
/** @psalm-suppress UnresolvableInclude */
|
|
|
|
require_once($path);
|
2018-11-12 18:03:55 +01:00
|
|
|
|
|
|
|
$this->filetype_scanners[$extension] = $fq_class_name;
|
2018-02-12 02:56:34 +01:00
|
|
|
}
|
2018-01-21 19:38:51 +01:00
|
|
|
|
2018-11-11 18:01:14 +01:00
|
|
|
foreach ($this->filetype_analyzer_paths as $extension => $path) {
|
2018-11-06 03:57:36 +01:00
|
|
|
$fq_class_name = $this->getPluginClassForPath(
|
|
|
|
$codebase,
|
|
|
|
$path,
|
2019-01-02 12:58:49 +01:00
|
|
|
FileAnalyzer::class
|
2018-11-06 03:57:36 +01:00
|
|
|
);
|
2018-02-12 02:56:34 +01:00
|
|
|
|
|
|
|
/** @psalm-suppress UnresolvableInclude */
|
|
|
|
require_once($path);
|
2018-11-12 18:03:55 +01:00
|
|
|
|
|
|
|
$this->filetype_analyzers[$extension] = $fq_class_name;
|
2018-01-21 19:38:51 +01:00
|
|
|
}
|
|
|
|
|
2018-02-12 02:56:34 +01:00
|
|
|
foreach ($this->plugin_paths as $path) {
|
Plugin loading (#855)
* add ability to load plugins by class names
- Plugins need to implement `__invoke(PluginFacade $psalm):void` method
- Plugins are enabled by adding `<pluginClass
class="Qualified\Class\Name"/>`
- `PluginFacade` provides a single point of contact with Psalm, so that
plugins cannot become coupled to Psalm internals
* added `psalm-plugin` cli tool to manage plugins
Available commands:
`psalm-plugin list` - lists available and enabled plugins
`psalm-plugin enable 'Plugin\Class\Name'` - enables plugin (modifies `psalm.xml`)
`psalm-plugin disable 'Plugin\Class\Name'` - disables plugin (modifies `psalm.xml`)
Plugin installation:
`composer install plugin-vendor/plugin-package-name`
Plugin authoring:
Plugins are identified by package `type` field, which should contain
`psalm-plugin` string.
`extra.pluginClass` should refer to the name of the class implementing
`__invoke(PluginFacade $psalm):void` function
Todo:
- better config file search
- better output for `psalm-plugin`
- better formatting for modified xml file
- composer skeleton project for plugins
- ability to refer to plugins by package name (cli only)
- composer plugin to (optionally) enable plugin upon installation
- documentation on plugin installation and authoring
- interfaces for plugin dependencies
- interface for plugin entry point
- migration path for legacy plugins
* documented previously undocumented plugin methods
* split legacy plugin registration into a wrapper class
also added `PluginApi` namespace and `RegistrationInterface`
* reuse psalm's config search algorithm
* enable/disable plugins by composer package name
* allow specifying alternative config file name
* whitelist PluginApi namespace
three times, but well, it works now
* interface for plugin entry points
* psalm-plugin as a symfony console app
* fixed errors found by psalm
* suppressed false positive UnusedMethods
* cs fix
* better psalm-plugin output
* don't leave empty `plugins` node to avoid old schema violation
* removed junk file that shouldn't be there
* cs fix
* fixed phpunit failure (constant redefinition)
* work around missing docblock in on symfony console
* php 7.0 compatibility
* allow `pluginClass` child elements as plugin configuration
* decouple console commands from undelying implementation
- introduce PluginListFactory
- add `PluginList::enable(string $class)` and `PluginList::disable(string $class)`
* PluginList tests
* ComposerLock test
* droppped debugging statement
* added part of console command tests
* added tests for EnableCommand
* added DisableCommand tests
* ignore unused args
* ConfigFile test
* disable travis cache in attempt to fix builds
* nah, that didn't work
* update for upstream changes
* rebase fixes
* namespaced `extra` entry for entry point
* s/PluginFacade/PluginRegistrationSocket/g
* Added $config parameter to PluginEntryPointInterface::__invoke()
* cs fixes
* entry point interface php7.0 compatibility
* cleaned up old cruft
- dropped todos I'm not going to pursues
- locked entry point to be a class implementing entry point interface
* fixed legacy plugins docs
* Added RegistrationInterface::registerHooksFromClass()
It mimics the way old plugins were registered in Psalm\Config, so
handler classes extending Psalm\Plugin should be fully compatible with
it.
Since Psalm\Plugin-style plugin registration was moved to
RegistrationSocket, LegacyPlugin now only load file-based plugins, so it
was renamed to FileBasedPluginAdapter.
* Converted EchoChecker plugin to composer-based format
- Its subfolder is registered as a local composer package in the root
composer.json, so it's directly installable with
```
composer require psalm/echo-checker-plugin
```
- Migration is trivial: drop the plugin into a separate folder, then add
simple composer.json and the entry point class.
* Updated docs
* Don't reject hook handlers that inherit handling methods
* strip void return type in stub file
2018-11-11 05:23:36 +01:00
|
|
|
try {
|
2018-11-06 03:57:36 +01:00
|
|
|
$plugin_object = new FileBasedPluginAdapter($path, $this, $codebase);
|
Plugin loading (#855)
* add ability to load plugins by class names
- Plugins need to implement `__invoke(PluginFacade $psalm):void` method
- Plugins are enabled by adding `<pluginClass
class="Qualified\Class\Name"/>`
- `PluginFacade` provides a single point of contact with Psalm, so that
plugins cannot become coupled to Psalm internals
* added `psalm-plugin` cli tool to manage plugins
Available commands:
`psalm-plugin list` - lists available and enabled plugins
`psalm-plugin enable 'Plugin\Class\Name'` - enables plugin (modifies `psalm.xml`)
`psalm-plugin disable 'Plugin\Class\Name'` - disables plugin (modifies `psalm.xml`)
Plugin installation:
`composer install plugin-vendor/plugin-package-name`
Plugin authoring:
Plugins are identified by package `type` field, which should contain
`psalm-plugin` string.
`extra.pluginClass` should refer to the name of the class implementing
`__invoke(PluginFacade $psalm):void` function
Todo:
- better config file search
- better output for `psalm-plugin`
- better formatting for modified xml file
- composer skeleton project for plugins
- ability to refer to plugins by package name (cli only)
- composer plugin to (optionally) enable plugin upon installation
- documentation on plugin installation and authoring
- interfaces for plugin dependencies
- interface for plugin entry point
- migration path for legacy plugins
* documented previously undocumented plugin methods
* split legacy plugin registration into a wrapper class
also added `PluginApi` namespace and `RegistrationInterface`
* reuse psalm's config search algorithm
* enable/disable plugins by composer package name
* allow specifying alternative config file name
* whitelist PluginApi namespace
three times, but well, it works now
* interface for plugin entry points
* psalm-plugin as a symfony console app
* fixed errors found by psalm
* suppressed false positive UnusedMethods
* cs fix
* better psalm-plugin output
* don't leave empty `plugins` node to avoid old schema violation
* removed junk file that shouldn't be there
* cs fix
* fixed phpunit failure (constant redefinition)
* work around missing docblock in on symfony console
* php 7.0 compatibility
* allow `pluginClass` child elements as plugin configuration
* decouple console commands from undelying implementation
- introduce PluginListFactory
- add `PluginList::enable(string $class)` and `PluginList::disable(string $class)`
* PluginList tests
* ComposerLock test
* droppped debugging statement
* added part of console command tests
* added tests for EnableCommand
* added DisableCommand tests
* ignore unused args
* ConfigFile test
* disable travis cache in attempt to fix builds
* nah, that didn't work
* update for upstream changes
* rebase fixes
* namespaced `extra` entry for entry point
* s/PluginFacade/PluginRegistrationSocket/g
* Added $config parameter to PluginEntryPointInterface::__invoke()
* cs fixes
* entry point interface php7.0 compatibility
* cleaned up old cruft
- dropped todos I'm not going to pursues
- locked entry point to be a class implementing entry point interface
* fixed legacy plugins docs
* Added RegistrationInterface::registerHooksFromClass()
It mimics the way old plugins were registered in Psalm\Config, so
handler classes extending Psalm\Plugin should be fully compatible with
it.
Since Psalm\Plugin-style plugin registration was moved to
RegistrationSocket, LegacyPlugin now only load file-based plugins, so it
was renamed to FileBasedPluginAdapter.
* Converted EchoChecker plugin to composer-based format
- Its subfolder is registered as a local composer package in the root
composer.json, so it's directly installable with
```
composer require psalm/echo-checker-plugin
```
- Migration is trivial: drop the plugin into a separate folder, then add
simple composer.json and the entry point class.
* Updated docs
* Don't reject hook handlers that inherit handling methods
* strip void return type in stub file
2018-11-11 05:23:36 +01:00
|
|
|
$plugin_object($socket);
|
|
|
|
} catch (\Throwable $e) {
|
|
|
|
throw new ConfigException('Failed to load plugin ' . $path, 0, $e);
|
2018-02-12 02:56:34 +01:00
|
|
|
}
|
2016-06-20 06:38:13 +02:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2018-02-12 02:56:34 +01:00
|
|
|
/**
|
2019-01-02 12:58:49 +01:00
|
|
|
* @template T
|
|
|
|
*
|
2018-02-12 02:56:34 +01:00
|
|
|
* @param string $path
|
2019-01-02 12:58:49 +01:00
|
|
|
* @param T::class $must_extend
|
2018-02-12 02:56:34 +01:00
|
|
|
*
|
2019-01-02 15:00:45 +01:00
|
|
|
* @return class-string<T>
|
2018-02-12 02:56:34 +01:00
|
|
|
*/
|
2018-10-07 02:11:19 +02:00
|
|
|
private function getPluginClassForPath(Codebase $codebase, $path, $must_extend)
|
2018-02-12 02:56:34 +01:00
|
|
|
{
|
|
|
|
$file_storage = $codebase->createFileStorageForPath($path);
|
2018-02-21 19:54:11 +01:00
|
|
|
$file_to_scan = new FileScanner($path, $this->shortenFileName($path), true);
|
2018-02-12 02:56:34 +01:00
|
|
|
$file_to_scan->scan(
|
|
|
|
$codebase,
|
|
|
|
$file_storage
|
|
|
|
);
|
|
|
|
|
2018-11-06 03:57:36 +01:00
|
|
|
$declared_classes = ClassLikeAnalyzer::getClassesForFile($codebase, $path);
|
2018-02-12 02:56:34 +01:00
|
|
|
|
2019-01-06 23:32:19 +01:00
|
|
|
if (!count($declared_classes)) {
|
2018-02-12 02:56:34 +01:00
|
|
|
throw new \InvalidArgumentException(
|
2019-01-06 23:32:19 +01:00
|
|
|
'Plugins must have at least one class in the file - ' . $path . ' has ' .
|
2018-02-12 02:56:34 +01:00
|
|
|
count($declared_classes)
|
|
|
|
);
|
|
|
|
}
|
|
|
|
|
2018-02-12 04:49:19 +01:00
|
|
|
$fq_class_name = reset($declared_classes);
|
|
|
|
|
2019-03-17 22:10:51 +01:00
|
|
|
if (!$codebase->classlikes->classExtends(
|
2018-02-12 04:49:19 +01:00
|
|
|
$fq_class_name,
|
2018-02-12 02:56:34 +01:00
|
|
|
$must_extend
|
|
|
|
)
|
|
|
|
) {
|
|
|
|
throw new \InvalidArgumentException(
|
|
|
|
'This plugin must extend ' . $must_extend . ' - ' . $path . ' does not'
|
|
|
|
);
|
|
|
|
}
|
|
|
|
|
2019-01-02 12:58:49 +01:00
|
|
|
/**
|
2019-01-02 15:00:45 +01:00
|
|
|
* @var class-string<T>
|
2019-01-02 12:58:49 +01:00
|
|
|
*/
|
2018-02-12 04:49:19 +01:00
|
|
|
return $fq_class_name;
|
2018-02-12 02:56:34 +01:00
|
|
|
}
|
|
|
|
|
2016-10-09 23:55:21 +02:00
|
|
|
/**
|
|
|
|
* @param string $file_name
|
2017-05-27 02:16:18 +02:00
|
|
|
*
|
2016-10-09 23:55:21 +02:00
|
|
|
* @return string
|
|
|
|
*/
|
2016-06-10 23:20:04 +02:00
|
|
|
public function shortenFileName($file_name)
|
|
|
|
{
|
2018-07-07 01:16:31 +02:00
|
|
|
return preg_replace('/^' . preg_quote($this->base_dir, '/') . '/', '', $file_name);
|
2016-06-10 23:20:04 +02:00
|
|
|
}
|
|
|
|
|
2016-11-02 07:29:00 +01:00
|
|
|
/**
|
|
|
|
* @param string $issue_type
|
2017-01-16 18:59:09 +01:00
|
|
|
* @param string $file_path
|
2017-05-27 02:16:18 +02:00
|
|
|
*
|
2016-11-02 07:29:00 +01:00
|
|
|
* @return bool
|
|
|
|
*/
|
2017-03-24 23:34:46 +01:00
|
|
|
public function reportIssueInFile($issue_type, $file_path)
|
2016-06-10 00:08:25 +02:00
|
|
|
{
|
2019-04-26 00:02:19 +02:00
|
|
|
if (!$this->totally_typed && in_array($issue_type, self::MIXED_ISSUES, true)) {
|
2017-03-24 23:34:46 +01:00
|
|
|
return false;
|
2016-12-19 01:17:39 +01:00
|
|
|
}
|
|
|
|
|
2017-03-24 23:34:46 +01:00
|
|
|
if ($this->hide_external_errors) {
|
2018-06-04 06:15:28 +02:00
|
|
|
if ($this->mustBeIgnored($file_path)) {
|
|
|
|
return false;
|
|
|
|
}
|
|
|
|
|
2019-04-27 23:38:24 +02:00
|
|
|
$project_analyzer = ProjectAnalyzer::getInstance();
|
|
|
|
|
|
|
|
$codebase = $project_analyzer->getCodebase();
|
2017-03-24 23:34:46 +01:00
|
|
|
|
2018-05-30 18:23:53 +02:00
|
|
|
$dependent_files = [strtolower($file_path) => $file_path];
|
|
|
|
|
|
|
|
try {
|
|
|
|
$file_storage = $codebase->file_storage_provider->get($file_path);
|
|
|
|
$dependent_files += $file_storage->required_by_file_paths;
|
|
|
|
} catch (\InvalidArgumentException $e) {
|
|
|
|
// do nothing
|
|
|
|
}
|
|
|
|
|
|
|
|
$any_file_path_matched = false;
|
|
|
|
|
2018-06-04 06:15:28 +02:00
|
|
|
foreach ($dependent_files as $dependent_file_path) {
|
2019-04-29 18:07:34 +02:00
|
|
|
if (($codebase->analyzer->canReportIssues($dependent_file_path)
|
|
|
|
|| $project_analyzer->canReportIssues($dependent_file_path))
|
2018-06-04 06:15:28 +02:00
|
|
|
&& !$this->mustBeIgnored($dependent_file_path)
|
|
|
|
) {
|
2018-05-30 18:23:53 +02:00
|
|
|
$any_file_path_matched = true;
|
|
|
|
break;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
if (!$any_file_path_matched) {
|
2017-03-24 23:34:46 +01:00
|
|
|
return false;
|
2016-08-05 21:11:20 +02:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2017-01-16 18:59:09 +01:00
|
|
|
if ($this->getReportingLevelForFile($issue_type, $file_path) === self::REPORT_SUPPRESS) {
|
2017-03-24 23:34:46 +01:00
|
|
|
return false;
|
2016-06-10 20:47:44 +02:00
|
|
|
}
|
2016-06-10 00:08:25 +02:00
|
|
|
|
2017-03-24 23:34:46 +01:00
|
|
|
return true;
|
2016-06-10 00:08:25 +02:00
|
|
|
}
|
|
|
|
|
2016-11-02 07:29:00 +01:00
|
|
|
/**
|
2017-01-02 21:31:18 +01:00
|
|
|
* @param string $file_path
|
2017-05-27 02:16:18 +02:00
|
|
|
*
|
2016-11-02 07:29:00 +01:00
|
|
|
* @return bool
|
|
|
|
*/
|
2017-01-02 21:31:18 +01:00
|
|
|
public function isInProjectDirs($file_path)
|
2016-09-01 05:12:35 +02:00
|
|
|
{
|
2017-01-02 21:31:18 +01:00
|
|
|
return $this->project_files && $this->project_files->allows($file_path);
|
2016-09-01 05:12:35 +02:00
|
|
|
}
|
|
|
|
|
2018-06-04 06:15:28 +02:00
|
|
|
/**
|
|
|
|
* @param string $file_path
|
|
|
|
*
|
|
|
|
* @return bool
|
|
|
|
*/
|
|
|
|
public function mustBeIgnored($file_path)
|
|
|
|
{
|
|
|
|
return $this->project_files && $this->project_files->forbids($file_path);
|
|
|
|
}
|
|
|
|
|
2019-05-03 23:12:20 +02:00
|
|
|
/**
|
|
|
|
* @var string[] $suppressed_issues
|
|
|
|
*/
|
|
|
|
public function getReportingLevelForIssue(CodeIssue $e, array $suppressed_issues = []) : string
|
|
|
|
{
|
|
|
|
$fqcn_parts = explode('\\', get_class($e));
|
|
|
|
$issue_type = array_pop($fqcn_parts);
|
|
|
|
|
|
|
|
if (in_array($issue_type, $suppressed_issues, true)) {
|
|
|
|
return self::REPORT_SUPPRESS;
|
|
|
|
}
|
|
|
|
|
|
|
|
$reporting_level = null;
|
|
|
|
|
|
|
|
if ($e instanceof ClassIssue) {
|
|
|
|
$reporting_level = $this->getReportingLevelForClass($issue_type, $e->fq_classlike_name);
|
|
|
|
} elseif ($e instanceof MethodIssue) {
|
|
|
|
$reporting_level = $this->getReportingLevelForMethod($issue_type, $e->method_id);
|
|
|
|
} elseif ($e instanceof FunctionIssue) {
|
|
|
|
$reporting_level = $this->getReportingLevelForFunction($issue_type, $e->function_id);
|
|
|
|
} elseif ($e instanceof PropertyIssue) {
|
|
|
|
$reporting_level = $this->getReportingLevelForProperty($issue_type, $e->property_id);
|
|
|
|
} elseif ($e instanceof ArgumentIssue && $e->function_id) {
|
|
|
|
$reporting_level = $this->getReportingLevelForArgument($issue_type, $e->function_id);
|
|
|
|
}
|
|
|
|
|
|
|
|
if ($reporting_level === null) {
|
|
|
|
$reporting_level = $this->getReportingLevelForFile($issue_type, $e->getFilePath());
|
|
|
|
}
|
|
|
|
|
|
|
|
$parent_issue_type = self::getParentIssueType($issue_type);
|
|
|
|
|
|
|
|
if ($parent_issue_type && in_array($parent_issue_type, $suppressed_issues, true)) {
|
|
|
|
return self::REPORT_SUPPRESS;
|
|
|
|
}
|
|
|
|
|
|
|
|
if ($parent_issue_type && $reporting_level === Config::REPORT_ERROR) {
|
|
|
|
$parent_reporting_level = $this->getReportingLevelForFile($parent_issue_type, $e->getFilePath());
|
|
|
|
|
|
|
|
if ($parent_reporting_level !== $reporting_level) {
|
|
|
|
return $parent_reporting_level;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
return $reporting_level;
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @param string $issue_type
|
|
|
|
* @return string|null
|
|
|
|
*/
|
|
|
|
private static function getParentIssueType($issue_type)
|
|
|
|
{
|
|
|
|
if (strpos($issue_type, 'Possibly') === 0) {
|
|
|
|
$stripped_issue_type = preg_replace('/^Possibly(False|Null)?/', '', $issue_type);
|
|
|
|
|
|
|
|
if (strpos($stripped_issue_type, 'Invalid') === false && strpos($stripped_issue_type, 'Un') !== 0) {
|
|
|
|
$stripped_issue_type = 'Invalid' . $stripped_issue_type;
|
|
|
|
}
|
|
|
|
|
|
|
|
return $stripped_issue_type;
|
|
|
|
}
|
|
|
|
|
|
|
|
if (preg_match('/^(False|Null)[A-Z]/', $issue_type)) {
|
|
|
|
return preg_replace('/^(False|Null)/', 'Invalid', $issue_type);
|
|
|
|
}
|
|
|
|
|
|
|
|
if ($issue_type === 'UndefinedInterfaceMethod') {
|
|
|
|
return 'UndefinedMethod';
|
|
|
|
}
|
|
|
|
|
|
|
|
if ($issue_type === 'UninitializedProperty') {
|
|
|
|
return 'PropertyNotSetInConstructor';
|
|
|
|
}
|
|
|
|
|
|
|
|
if ($issue_type === 'InvalidDocblockParamName') {
|
|
|
|
return 'InvalidDocblock';
|
|
|
|
}
|
|
|
|
|
|
|
|
if ($issue_type === 'UnusedClosureParam') {
|
|
|
|
return 'UnusedParam';
|
|
|
|
}
|
|
|
|
|
|
|
|
if ($issue_type === 'TraitMethodSignatureMismatch') {
|
|
|
|
return 'MethodSignatureMismatch';
|
|
|
|
}
|
|
|
|
|
2019-05-14 21:44:46 +02:00
|
|
|
if ($issue_type === 'ImplementedParamTypeMismatch') {
|
|
|
|
return 'MoreSpecificImplementedParamType';
|
|
|
|
}
|
|
|
|
|
2019-05-16 00:41:26 +02:00
|
|
|
if ($issue_type === 'UndefinedDocblockClass') {
|
|
|
|
return 'UndefinedClass';
|
|
|
|
}
|
|
|
|
|
2019-05-03 23:12:20 +02:00
|
|
|
if ($issue_type === 'MixedArgumentTypeCoercion'
|
|
|
|
|| $issue_type === 'MixedPropertyTypeCoercion'
|
|
|
|
|| $issue_type === 'MixedReturnTypeCoercion'
|
|
|
|
|| $issue_type === 'MixedArrayTypeCoercion'
|
|
|
|
) {
|
|
|
|
return 'MixedTypeCoercion';
|
|
|
|
}
|
|
|
|
|
|
|
|
if ($issue_type === 'ArgumentTypeCoercion'
|
|
|
|
|| $issue_type === 'PropertyTypeCoercion'
|
|
|
|
|| $issue_type === 'ReturnTypeCoercion'
|
|
|
|
) {
|
|
|
|
return 'TypeCoercion';
|
|
|
|
}
|
|
|
|
|
|
|
|
return null;
|
|
|
|
}
|
|
|
|
|
2016-11-02 07:29:00 +01:00
|
|
|
/**
|
|
|
|
* @param string $issue_type
|
2017-01-16 18:59:09 +01:00
|
|
|
* @param string $file_path
|
2017-05-27 02:16:18 +02:00
|
|
|
*
|
2016-11-02 07:29:00 +01:00
|
|
|
* @return string
|
|
|
|
*/
|
2017-01-16 18:59:09 +01:00
|
|
|
public function getReportingLevelForFile($issue_type, $file_path)
|
2016-06-21 01:30:38 +02:00
|
|
|
{
|
2016-12-30 02:07:42 +01:00
|
|
|
if (isset($this->issue_handlers[$issue_type])) {
|
2017-01-16 18:59:09 +01:00
|
|
|
return $this->issue_handlers[$issue_type]->getReportingLevelForFile($file_path);
|
2016-06-21 01:30:38 +02:00
|
|
|
}
|
|
|
|
|
|
|
|
return self::REPORT_ERROR;
|
|
|
|
}
|
|
|
|
|
2018-03-21 03:36:03 +01:00
|
|
|
/**
|
|
|
|
* @param string $issue_type
|
|
|
|
* @param string $fq_classlike_name
|
|
|
|
*
|
2019-05-03 23:12:20 +02:00
|
|
|
* @return string|null
|
2018-03-21 03:36:03 +01:00
|
|
|
*/
|
|
|
|
public function getReportingLevelForClass($issue_type, $fq_classlike_name)
|
|
|
|
{
|
|
|
|
if (isset($this->issue_handlers[$issue_type])) {
|
|
|
|
return $this->issue_handlers[$issue_type]->getReportingLevelForClass($fq_classlike_name);
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @param string $issue_type
|
|
|
|
* @param string $method_id
|
|
|
|
*
|
2019-05-03 23:12:20 +02:00
|
|
|
* @return string|null
|
2018-03-21 03:36:03 +01:00
|
|
|
*/
|
|
|
|
public function getReportingLevelForMethod($issue_type, $method_id)
|
|
|
|
{
|
|
|
|
if (isset($this->issue_handlers[$issue_type])) {
|
|
|
|
return $this->issue_handlers[$issue_type]->getReportingLevelForMethod($method_id);
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2019-05-03 23:12:20 +02:00
|
|
|
/**
|
|
|
|
* @return string|null
|
|
|
|
*/
|
|
|
|
public function getReportingLevelForFunction(string $issue_type, string $function_id)
|
2019-04-26 00:02:19 +02:00
|
|
|
{
|
|
|
|
if (isset($this->issue_handlers[$issue_type])) {
|
|
|
|
return $this->issue_handlers[$issue_type]->getReportingLevelForFunction($function_id);
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2019-05-03 23:12:20 +02:00
|
|
|
/**
|
|
|
|
* @return string|null
|
|
|
|
*/
|
|
|
|
public function getReportingLevelForArgument(string $issue_type, string $function_id)
|
2019-04-26 00:02:19 +02:00
|
|
|
{
|
|
|
|
if (isset($this->issue_handlers[$issue_type])) {
|
|
|
|
return $this->issue_handlers[$issue_type]->getReportingLevelForArgument($function_id);
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2018-05-11 06:07:41 +02:00
|
|
|
/**
|
|
|
|
* @param string $issue_type
|
|
|
|
* @param string $property_id
|
|
|
|
*
|
2019-05-03 23:12:20 +02:00
|
|
|
* @return string|null
|
2018-05-11 06:07:41 +02:00
|
|
|
*/
|
|
|
|
public function getReportingLevelForProperty($issue_type, $property_id)
|
|
|
|
{
|
|
|
|
if (isset($this->issue_handlers[$issue_type])) {
|
|
|
|
return $this->issue_handlers[$issue_type]->getReportingLevelForProperty($property_id);
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2016-10-15 06:12:57 +02:00
|
|
|
/**
|
|
|
|
* @return array<string>
|
|
|
|
*/
|
2016-12-29 16:24:10 +01:00
|
|
|
public function getProjectDirectories()
|
2016-06-10 00:08:25 +02:00
|
|
|
{
|
2016-12-29 14:42:39 +01:00
|
|
|
if (!$this->project_files) {
|
2016-08-07 02:27:13 +02:00
|
|
|
return [];
|
|
|
|
}
|
|
|
|
|
2016-12-29 16:24:10 +01:00
|
|
|
return $this->project_files->getDirectories();
|
2016-06-13 21:33:18 +02:00
|
|
|
}
|
2016-06-10 00:08:25 +02:00
|
|
|
|
2018-05-23 05:38:27 +02:00
|
|
|
/**
|
|
|
|
* @return array<string>
|
|
|
|
*/
|
|
|
|
public function getProjectFiles()
|
|
|
|
{
|
|
|
|
if (!$this->project_files) {
|
|
|
|
return [];
|
|
|
|
}
|
|
|
|
|
|
|
|
return $this->project_files->getFiles();
|
|
|
|
}
|
|
|
|
|
2018-08-24 23:46:13 +02:00
|
|
|
/**
|
|
|
|
* @param string $file_path
|
|
|
|
*
|
|
|
|
* @return bool
|
|
|
|
*/
|
|
|
|
public function reportTypeStatsForFile($file_path)
|
|
|
|
{
|
2019-03-23 14:50:47 +01:00
|
|
|
return $this->project_files
|
|
|
|
&& $this->project_files->allows($file_path)
|
|
|
|
&& $this->project_files->reportTypeStats($file_path);
|
2018-08-24 23:46:13 +02:00
|
|
|
}
|
|
|
|
|
2018-08-29 21:10:56 +02:00
|
|
|
/**
|
|
|
|
* @param string $file_path
|
|
|
|
*
|
|
|
|
* @return bool
|
|
|
|
*/
|
|
|
|
public function useStrictTypesForFile($file_path)
|
|
|
|
{
|
|
|
|
return $this->project_files && $this->project_files->useStrictTypes($file_path);
|
|
|
|
}
|
|
|
|
|
2016-10-15 06:12:57 +02:00
|
|
|
/**
|
|
|
|
* @return array<string>
|
|
|
|
*/
|
2016-06-13 21:33:18 +02:00
|
|
|
public function getFileExtensions()
|
|
|
|
{
|
|
|
|
return $this->file_extensions;
|
2016-06-10 00:08:25 +02:00
|
|
|
}
|
2016-06-10 20:47:44 +02:00
|
|
|
|
2016-11-02 07:29:00 +01:00
|
|
|
/**
|
2019-01-02 15:00:45 +01:00
|
|
|
* @return array<string, class-string<FileScanner>>
|
2016-11-02 07:29:00 +01:00
|
|
|
*/
|
2018-01-21 19:38:51 +01:00
|
|
|
public function getFiletypeScanners()
|
|
|
|
{
|
|
|
|
return $this->filetype_scanners;
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
2019-01-02 15:00:45 +01:00
|
|
|
* @return array<string, class-string<FileAnalyzer>>
|
2018-01-21 19:38:51 +01:00
|
|
|
*/
|
2018-11-06 03:57:36 +01:00
|
|
|
public function getFiletypeAnalyzers()
|
2016-06-20 06:38:13 +02:00
|
|
|
{
|
2018-11-11 18:01:14 +01:00
|
|
|
return $this->filetype_analyzers;
|
2016-06-20 06:38:13 +02:00
|
|
|
}
|
|
|
|
|
2016-10-09 23:55:21 +02:00
|
|
|
/**
|
2016-11-01 05:39:41 +01:00
|
|
|
* @return array<int, string>
|
2016-10-09 23:55:21 +02:00
|
|
|
*/
|
2016-06-10 20:47:44 +02:00
|
|
|
public function getMockClasses()
|
|
|
|
{
|
|
|
|
return $this->mock_classes;
|
|
|
|
}
|
2016-06-18 20:45:55 +02:00
|
|
|
|
2017-02-01 01:21:33 +01:00
|
|
|
/**
|
|
|
|
* @return void
|
|
|
|
*/
|
2019-05-16 23:12:31 +02:00
|
|
|
public function visitStubFiles(Codebase $codebase, Progress $progress = null)
|
2017-02-01 01:21:33 +01:00
|
|
|
{
|
2019-05-16 23:12:31 +02:00
|
|
|
if ($progress === null) {
|
|
|
|
$progress = new DefaultProgress();
|
|
|
|
}
|
|
|
|
|
2018-06-30 21:29:37 +02:00
|
|
|
$codebase->register_stub_files = true;
|
2017-02-11 00:12:59 +01:00
|
|
|
|
2018-03-08 23:56:52 +01:00
|
|
|
// note: don't realpath $generic_stubs_path, or phar version will fail
|
2018-11-06 03:57:36 +01:00
|
|
|
$generic_stubs_path = __DIR__ . '/Internal/Stubs/CoreGenericFunctions.php';
|
2017-02-11 00:12:59 +01:00
|
|
|
|
2018-03-08 23:56:52 +01:00
|
|
|
if (!file_exists($generic_stubs_path)) {
|
2017-02-11 00:12:59 +01:00
|
|
|
throw new \UnexpectedValueException('Cannot locate core generic stubs');
|
|
|
|
}
|
|
|
|
|
2018-03-08 23:56:52 +01:00
|
|
|
// note: don't realpath $generic_classes_path, or phar version will fail
|
2018-11-06 03:57:36 +01:00
|
|
|
$generic_classes_path = __DIR__ . '/Internal/Stubs/CoreGenericClasses.php';
|
2018-02-01 05:27:25 +01:00
|
|
|
|
2018-03-08 23:56:52 +01:00
|
|
|
if (!file_exists($generic_classes_path)) {
|
2018-02-01 05:27:25 +01:00
|
|
|
throw new \UnexpectedValueException('Cannot locate core generic classes');
|
|
|
|
}
|
|
|
|
|
|
|
|
$stub_files = array_merge([$generic_stubs_path, $generic_classes_path], $this->stub_files);
|
|
|
|
|
2019-02-16 17:16:52 +01:00
|
|
|
$phpstorm_meta_path = $this->base_dir . DIRECTORY_SEPARATOR . '.phpstorm.meta.php';
|
|
|
|
|
|
|
|
if (file_exists($phpstorm_meta_path)) {
|
|
|
|
$stub_files[] = $phpstorm_meta_path;
|
|
|
|
}
|
|
|
|
|
2018-06-30 21:29:37 +02:00
|
|
|
foreach ($stub_files as $file_path) {
|
|
|
|
$codebase->scanner->addFileToShallowScan($file_path);
|
|
|
|
}
|
|
|
|
|
2019-05-16 23:12:31 +02:00
|
|
|
$progress->debug('Registering stub files' . "\n");
|
2018-06-30 21:29:37 +02:00
|
|
|
|
|
|
|
$codebase->scanFiles();
|
|
|
|
|
2019-05-16 23:12:31 +02:00
|
|
|
$progress->debug('Finished registering stub files' . "\n");
|
2017-02-11 00:12:59 +01:00
|
|
|
|
2018-06-30 21:29:37 +02:00
|
|
|
$codebase->register_stub_files = false;
|
2017-02-01 01:21:33 +01:00
|
|
|
}
|
|
|
|
|
2016-11-04 22:45:12 +01:00
|
|
|
/**
|
2016-11-05 02:14:04 +01:00
|
|
|
* @return string
|
2016-11-04 22:45:12 +01:00
|
|
|
*/
|
|
|
|
public function getCacheDirectory()
|
|
|
|
{
|
|
|
|
return $this->cache_directory;
|
|
|
|
}
|
|
|
|
|
2018-10-15 17:29:57 +02:00
|
|
|
/**
|
2019-04-14 19:04:25 +02:00
|
|
|
* @return ?string
|
2018-10-15 17:29:57 +02:00
|
|
|
*/
|
|
|
|
public function getGlobalCacheDirectory()
|
|
|
|
{
|
|
|
|
return $this->global_cache_directory;
|
|
|
|
}
|
|
|
|
|
2016-11-21 05:45:10 +01:00
|
|
|
/**
|
|
|
|
* @return array<string, mixed>
|
|
|
|
*/
|
2016-11-21 03:49:06 +01:00
|
|
|
public function getPredefinedConstants()
|
|
|
|
{
|
|
|
|
return $this->predefined_constants;
|
|
|
|
}
|
|
|
|
|
2016-11-21 05:45:10 +01:00
|
|
|
/**
|
|
|
|
* @return void
|
2018-01-10 16:56:43 +01:00
|
|
|
* @psalm-suppress MixedTypeCoercion
|
2016-11-21 05:45:10 +01:00
|
|
|
*/
|
2016-11-21 03:49:06 +01:00
|
|
|
public function collectPredefinedConstants()
|
|
|
|
{
|
|
|
|
$this->predefined_constants = get_defined_constants();
|
|
|
|
}
|
2017-01-16 02:11:02 +01:00
|
|
|
|
|
|
|
/**
|
2019-04-10 00:09:57 +02:00
|
|
|
* @return array<callable-string, bool>
|
2017-01-16 02:11:02 +01:00
|
|
|
*/
|
|
|
|
public function getPredefinedFunctions()
|
|
|
|
{
|
|
|
|
return $this->predefined_functions;
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @return void
|
|
|
|
* @psalm-suppress InvalidPropertyAssignment
|
|
|
|
* @psalm-suppress MixedAssignment
|
2017-11-19 18:14:02 +01:00
|
|
|
* @psalm-suppress MixedArrayOffset
|
2017-01-16 02:11:02 +01:00
|
|
|
*/
|
|
|
|
public function collectPredefinedFunctions()
|
|
|
|
{
|
|
|
|
$defined_functions = get_defined_functions();
|
|
|
|
|
|
|
|
if (isset($defined_functions['user'])) {
|
|
|
|
foreach ($defined_functions['user'] as $function_name) {
|
|
|
|
$this->predefined_functions[$function_name] = true;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
if (isset($defined_functions['internal'])) {
|
|
|
|
foreach ($defined_functions['internal'] as $function_name) {
|
|
|
|
$this->predefined_functions[$function_name] = true;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
2017-12-28 00:56:10 +01:00
|
|
|
|
2018-01-01 17:47:03 +01:00
|
|
|
/**
|
|
|
|
* @return void
|
|
|
|
*
|
|
|
|
* @psalm-suppress MixedAssignment
|
|
|
|
* @psalm-suppress MixedArrayAccess
|
|
|
|
*/
|
2019-05-16 23:12:31 +02:00
|
|
|
public function visitComposerAutoloadFiles(ProjectAnalyzer $project_analyzer, Progress $progress = null)
|
2018-01-01 17:47:03 +01:00
|
|
|
{
|
2019-05-16 23:12:31 +02:00
|
|
|
if ($progress === null) {
|
|
|
|
$progress = new DefaultProgress();
|
|
|
|
}
|
|
|
|
|
2018-07-03 17:17:52 +02:00
|
|
|
$this->collectPredefinedConstants();
|
|
|
|
$this->collectPredefinedFunctions();
|
|
|
|
|
2018-01-01 17:47:03 +01:00
|
|
|
$composer_json_path = $this->base_dir . 'composer.json'; // this should ideally not be hardcoded
|
|
|
|
|
2018-07-03 17:17:52 +02:00
|
|
|
$autoload_files_files = [];
|
2018-01-01 17:47:03 +01:00
|
|
|
|
2018-07-03 17:17:52 +02:00
|
|
|
if ($this->autoloader) {
|
|
|
|
$autoload_files_files[] = $this->autoloader;
|
2018-01-01 17:47:03 +01:00
|
|
|
}
|
|
|
|
|
2018-07-03 17:17:52 +02:00
|
|
|
if (file_exists($composer_json_path)) {
|
|
|
|
/** @psalm-suppress PossiblyFalseArgument */
|
|
|
|
if (!$composer_json = json_decode(file_get_contents($composer_json_path), true)) {
|
|
|
|
throw new \UnexpectedValueException('Invalid composer.json at ' . $composer_json_path);
|
|
|
|
}
|
2018-01-21 19:38:51 +01:00
|
|
|
|
2018-07-03 17:17:52 +02:00
|
|
|
if (isset($composer_json['autoload']['files'])) {
|
|
|
|
/** @var string[] */
|
|
|
|
$composer_autoload_files = $composer_json['autoload']['files'];
|
2018-01-01 17:47:03 +01:00
|
|
|
|
2018-07-03 17:17:52 +02:00
|
|
|
foreach ($composer_autoload_files as $file) {
|
|
|
|
$file_path = realpath($this->base_dir . $file);
|
2018-01-01 17:47:03 +01:00
|
|
|
|
2018-07-03 17:17:52 +02:00
|
|
|
if ($file_path && file_exists($file_path)) {
|
|
|
|
$autoload_files_files[] = $file_path;
|
|
|
|
}
|
2018-01-01 17:47:03 +01:00
|
|
|
}
|
2018-03-31 02:03:56 +02:00
|
|
|
}
|
|
|
|
|
2018-07-03 17:17:52 +02:00
|
|
|
$vendor_autoload_files_path
|
|
|
|
= $this->base_dir . DIRECTORY_SEPARATOR . 'vendor'
|
|
|
|
. DIRECTORY_SEPARATOR . 'composer' . DIRECTORY_SEPARATOR . 'autoload_files.php';
|
2018-03-31 02:03:56 +02:00
|
|
|
|
2018-07-03 17:17:52 +02:00
|
|
|
if (file_exists($vendor_autoload_files_path)) {
|
|
|
|
/**
|
|
|
|
* @var string[]
|
|
|
|
* @psalm-suppress UnresolvableInclude
|
|
|
|
*/
|
|
|
|
$vendor_autoload_files = require $vendor_autoload_files_path;
|
2018-03-31 02:03:56 +02:00
|
|
|
|
2018-07-03 17:17:52 +02:00
|
|
|
$autoload_files_files = array_merge($autoload_files_files, $vendor_autoload_files);
|
|
|
|
}
|
2018-03-31 02:03:56 +02:00
|
|
|
}
|
|
|
|
|
2018-06-29 21:28:45 +02:00
|
|
|
$autoload_files_files = array_unique($autoload_files_files);
|
|
|
|
|
2018-03-31 02:03:56 +02:00
|
|
|
if ($autoload_files_files) {
|
2018-11-11 18:01:14 +01:00
|
|
|
$codebase = $project_analyzer->getCodebase();
|
2018-06-30 21:29:37 +02:00
|
|
|
$codebase->register_autoload_files = true;
|
2018-01-01 17:47:03 +01:00
|
|
|
|
2018-03-31 02:03:56 +02:00
|
|
|
foreach ($autoload_files_files as $file_path) {
|
2018-06-30 21:29:37 +02:00
|
|
|
$codebase->scanner->addFileToDeepScan($file_path);
|
|
|
|
}
|
|
|
|
|
2019-05-16 23:12:31 +02:00
|
|
|
$progress->debug('Registering autoloaded files' . "\n");
|
2018-01-01 17:47:03 +01:00
|
|
|
|
2018-06-29 21:28:45 +02:00
|
|
|
$codebase->scanner->scanFiles($codebase->classlikes);
|
|
|
|
|
2019-05-16 23:12:31 +02:00
|
|
|
$progress->debug('Finished registering autoloaded files' . "\n");
|
2018-06-30 21:29:37 +02:00
|
|
|
|
2018-11-06 03:57:36 +01:00
|
|
|
$codebase->register_autoload_files = false;
|
2018-01-21 19:38:51 +01:00
|
|
|
}
|
2018-07-03 17:17:52 +02:00
|
|
|
|
|
|
|
if ($this->autoloader) {
|
|
|
|
// do this in a separate method so scope does not leak
|
2019-01-02 17:18:22 +01:00
|
|
|
$this->requireAutoloader($this->autoloader);
|
2018-07-03 17:17:52 +02:00
|
|
|
|
|
|
|
$this->collectPredefinedConstants();
|
|
|
|
$this->collectPredefinedFunctions();
|
|
|
|
}
|
2018-01-01 17:47:03 +01:00
|
|
|
}
|
|
|
|
|
2017-12-28 00:56:10 +01:00
|
|
|
/**
|
2018-03-03 21:19:05 +01:00
|
|
|
* @param string $fq_classlike_name
|
2018-02-22 00:59:31 +01:00
|
|
|
*
|
2018-03-03 21:19:05 +01:00
|
|
|
* @return string|false
|
2017-12-28 00:56:10 +01:00
|
|
|
*/
|
2018-03-03 21:19:05 +01:00
|
|
|
public function getComposerFilePathForClassLike($fq_classlike_name)
|
2017-12-28 00:56:10 +01:00
|
|
|
{
|
2018-03-03 21:19:05 +01:00
|
|
|
if (!$this->composer_class_loader) {
|
2018-03-06 23:30:54 +01:00
|
|
|
return false;
|
2017-12-28 00:56:10 +01:00
|
|
|
}
|
|
|
|
|
2018-03-03 21:19:05 +01:00
|
|
|
return $this->composer_class_loader->findFile($fq_classlike_name);
|
2017-12-28 00:56:10 +01:00
|
|
|
}
|
2017-12-29 18:29:36 +01:00
|
|
|
|
|
|
|
/**
|
|
|
|
* @param string $dir
|
|
|
|
*
|
|
|
|
* @return void
|
|
|
|
*/
|
|
|
|
public static function removeCacheDirectory($dir)
|
|
|
|
{
|
|
|
|
if (is_dir($dir)) {
|
|
|
|
$objects = scandir($dir);
|
|
|
|
|
|
|
|
if ($objects === false) {
|
|
|
|
throw new \UnexpectedValueException('Not expecting false here');
|
|
|
|
}
|
|
|
|
|
|
|
|
foreach ($objects as $object) {
|
|
|
|
if ($object != '.' && $object != '..') {
|
|
|
|
if (filetype($dir . '/' . $object) == 'dir') {
|
|
|
|
self::removeCacheDirectory($dir . '/' . $object);
|
|
|
|
} else {
|
|
|
|
unlink($dir . '/' . $object);
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
reset($objects);
|
|
|
|
rmdir($dir);
|
|
|
|
}
|
|
|
|
}
|
2018-10-18 20:34:46 +02:00
|
|
|
|
|
|
|
/**
|
|
|
|
* @return void
|
|
|
|
*/
|
|
|
|
public function setServerMode()
|
|
|
|
{
|
|
|
|
$this->cache_directory .= '-s';
|
|
|
|
}
|
Plugin loading (#855)
* add ability to load plugins by class names
- Plugins need to implement `__invoke(PluginFacade $psalm):void` method
- Plugins are enabled by adding `<pluginClass
class="Qualified\Class\Name"/>`
- `PluginFacade` provides a single point of contact with Psalm, so that
plugins cannot become coupled to Psalm internals
* added `psalm-plugin` cli tool to manage plugins
Available commands:
`psalm-plugin list` - lists available and enabled plugins
`psalm-plugin enable 'Plugin\Class\Name'` - enables plugin (modifies `psalm.xml`)
`psalm-plugin disable 'Plugin\Class\Name'` - disables plugin (modifies `psalm.xml`)
Plugin installation:
`composer install plugin-vendor/plugin-package-name`
Plugin authoring:
Plugins are identified by package `type` field, which should contain
`psalm-plugin` string.
`extra.pluginClass` should refer to the name of the class implementing
`__invoke(PluginFacade $psalm):void` function
Todo:
- better config file search
- better output for `psalm-plugin`
- better formatting for modified xml file
- composer skeleton project for plugins
- ability to refer to plugins by package name (cli only)
- composer plugin to (optionally) enable plugin upon installation
- documentation on plugin installation and authoring
- interfaces for plugin dependencies
- interface for plugin entry point
- migration path for legacy plugins
* documented previously undocumented plugin methods
* split legacy plugin registration into a wrapper class
also added `PluginApi` namespace and `RegistrationInterface`
* reuse psalm's config search algorithm
* enable/disable plugins by composer package name
* allow specifying alternative config file name
* whitelist PluginApi namespace
three times, but well, it works now
* interface for plugin entry points
* psalm-plugin as a symfony console app
* fixed errors found by psalm
* suppressed false positive UnusedMethods
* cs fix
* better psalm-plugin output
* don't leave empty `plugins` node to avoid old schema violation
* removed junk file that shouldn't be there
* cs fix
* fixed phpunit failure (constant redefinition)
* work around missing docblock in on symfony console
* php 7.0 compatibility
* allow `pluginClass` child elements as plugin configuration
* decouple console commands from undelying implementation
- introduce PluginListFactory
- add `PluginList::enable(string $class)` and `PluginList::disable(string $class)`
* PluginList tests
* ComposerLock test
* droppped debugging statement
* added part of console command tests
* added tests for EnableCommand
* added DisableCommand tests
* ignore unused args
* ConfigFile test
* disable travis cache in attempt to fix builds
* nah, that didn't work
* update for upstream changes
* rebase fixes
* namespaced `extra` entry for entry point
* s/PluginFacade/PluginRegistrationSocket/g
* Added $config parameter to PluginEntryPointInterface::__invoke()
* cs fixes
* entry point interface php7.0 compatibility
* cleaned up old cruft
- dropped todos I'm not going to pursues
- locked entry point to be a class implementing entry point interface
* fixed legacy plugins docs
* Added RegistrationInterface::registerHooksFromClass()
It mimics the way old plugins were registered in Psalm\Config, so
handler classes extending Psalm\Plugin should be fully compatible with
it.
Since Psalm\Plugin-style plugin registration was moved to
RegistrationSocket, LegacyPlugin now only load file-based plugins, so it
was renamed to FileBasedPluginAdapter.
* Converted EchoChecker plugin to composer-based format
- Its subfolder is registered as a local composer package in the root
composer.json, so it's directly installable with
```
composer require psalm/echo-checker-plugin
```
- Migration is trivial: drop the plugin into a separate folder, then add
simple composer.json and the entry point class.
* Updated docs
* Don't reject hook handlers that inherit handling methods
* strip void return type in stub file
2018-11-11 05:23:36 +01:00
|
|
|
|
|
|
|
/** @return void */
|
|
|
|
public function addStubFile(string $stub_file)
|
|
|
|
{
|
|
|
|
$this->stub_files[] = $stub_file;
|
|
|
|
}
|
2016-06-06 07:07:50 +02:00
|
|
|
}
|