mirror of
https://github.com/danog/psalm.git
synced 2024-11-29 20:28:59 +01:00
052d4f6217
* 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
177 lines
6.4 KiB
XML
177 lines
6.4 KiB
XML
<?xml version="1.0"?>
|
|
<psalm
|
|
name="Psalm for Psalm"
|
|
useDocblockTypes="true"
|
|
totallyTyped="true"
|
|
strictBinaryOperands="false"
|
|
rememberPropertyAssignmentsAfterCall="true"
|
|
checkForThrowsDocblock="false"
|
|
throwExceptionOnError="0"
|
|
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
|
|
xmlns="https://getpsalm.org/schema/config"
|
|
xsi:schemaLocation="https://getpsalm.org/schema/config config.xsd"
|
|
>
|
|
<projectFiles>
|
|
<directory name="src" />
|
|
<directory name="tests" />
|
|
<directory name="examples" />
|
|
<ignoreFiles>
|
|
<file name="src/Psalm/CallMap.php" />
|
|
<directory name="src/Psalm/Stubs" />
|
|
<directory name="tests/stubs" />
|
|
<directory name="tests/DummyProject" />
|
|
<file name="vendor/phpunit/phpunit/src/Framework/TestCase.php" />
|
|
<file name="src/Psalm/Traverser/CustomTraverser.php" />
|
|
<directory name="tests/performance/a.test" />
|
|
<directory name="tests/performance/b.test" />
|
|
<file name="tests/ErrorBaselineTest.php" />
|
|
</ignoreFiles>
|
|
</projectFiles>
|
|
|
|
<ignoreExceptions>
|
|
<class name="UnexpectedValueException" />
|
|
<class name="InvalidArgumentException" />
|
|
<class name="LogicException" />
|
|
</ignoreExceptions>
|
|
|
|
<issueHandlers>
|
|
<MisplacedRequiredParam errorLevel="suppress" />
|
|
<PossiblyNullOperand errorLevel="suppress" />
|
|
<MissingConstructor>
|
|
<errorLevel type="suppress">
|
|
<file name="src/Psalm/Scanner/FunctionDocblockComment.php" />
|
|
<file name="src/Psalm/Storage/FunctionLikeStorage.php" />
|
|
<file name="src/Psalm/Storage/MethodStorage.php" />
|
|
<file name="src/Psalm/Storage/PropertyStorage.php" />
|
|
<file name="src/Psalm/Scanner/VarDocblockComment.php" />
|
|
<file name="src/Psalm/Scope/SwitchScope.php" />
|
|
</errorLevel>
|
|
</MissingConstructor>
|
|
<DeprecatedProperty errorLevel="suppress" />
|
|
|
|
<LessSpecificReturnType>
|
|
<errorLevel type="suppress">
|
|
<file name="src/Psalm/Plugin.php" />
|
|
</errorLevel>
|
|
</LessSpecificReturnType>
|
|
|
|
<UnusedParam>
|
|
<errorLevel type="suppress">
|
|
<file name="src/Psalm/Plugin.php" />
|
|
<directory name="examples" />
|
|
</errorLevel>
|
|
</UnusedParam>
|
|
|
|
<PossiblyUnusedParam>
|
|
<errorLevel type="suppress">
|
|
<file name="src/Psalm/Plugin.php" />
|
|
<directory name="examples" />
|
|
</errorLevel>
|
|
</PossiblyUnusedParam>
|
|
|
|
<UnusedClass>
|
|
<errorLevel type="suppress">
|
|
<directory name="examples" />
|
|
<directory name="tests" />
|
|
</errorLevel>
|
|
</UnusedClass>
|
|
|
|
<UnusedProperty>
|
|
<errorLevel type="info">
|
|
<file name="src/Psalm/FileManipulation/FunctionDocblockManipulator.php" />
|
|
</errorLevel>
|
|
</UnusedProperty>
|
|
|
|
<PossiblyUnusedProperty>
|
|
<errorLevel type="info">
|
|
<file name="src/Psalm/LanguageServer/LanguageClient.php" />
|
|
<file name="src/Psalm/Storage/FunctionLikeStorage.php" />
|
|
<file name="src/Psalm/Type/Atomic/TNonEmptyArray.php" />
|
|
</errorLevel>
|
|
</PossiblyUnusedProperty>
|
|
|
|
<MissingThrowsDocblock errorLevel="info" />
|
|
|
|
<PossiblyUnusedMethod>
|
|
<errorLevel type="suppress">
|
|
<directory name="tests" />
|
|
<directory name="src/Psalm/PluginApi" />
|
|
<file name="src/Psalm/Plugin.php" />
|
|
<file name="src/Psalm/LanguageServer/Client/TextDocument.php" />
|
|
<file name="src/Psalm/LanguageServer/Server/TextDocument.php" />
|
|
<referencedMethod name="Psalm\Codebase::getParentInterfaces" />
|
|
<referencedMethod name="Psalm\Codebase::getMethodParams" />
|
|
<referencedMethod name="Psalm\Codebase::getMethodReturnType" />
|
|
<referencedMethod name="Psalm\Codebase::getMethodReturnTypeLocation" />
|
|
<referencedMethod name="Psalm\Codebase::getDeclaringMethodId" />
|
|
<referencedMethod name="Psalm\Codebase::getAppearingMethodId" />
|
|
<referencedMethod name="Psalm\Codebase::getOverriddenMethodIds" />
|
|
<referencedMethod name="Psalm\Codebase::getCasedMethodId" />
|
|
<referencedMethod name="Psalm\Codebase::isVariadic" />
|
|
<referencedMethod name="Psalm\Codebase::getMethodReturnsByRef" />
|
|
</errorLevel>
|
|
</PossiblyUnusedMethod>
|
|
|
|
<PropertyNotSetInConstructor>
|
|
<errorLevel type="suppress">
|
|
<directory name="tests" />
|
|
<file name="src/Psalm/Config.php" />
|
|
</errorLevel>
|
|
</PropertyNotSetInConstructor>
|
|
|
|
<MixedArgument>
|
|
<errorLevel type="suppress">
|
|
<directory name="tests" />
|
|
</errorLevel>
|
|
</MixedArgument>
|
|
|
|
<MixedOperand>
|
|
<errorLevel type="suppress">
|
|
<directory name="tests" />
|
|
</errorLevel>
|
|
</MixedOperand>
|
|
|
|
<MixedPropertyFetch>
|
|
<errorLevel type="suppress">
|
|
<directory name="tests" />
|
|
</errorLevel>
|
|
</MixedPropertyFetch>
|
|
|
|
<NoInterfaceProperties>
|
|
<errorLevel type="suppress">
|
|
<directory name="tests" />
|
|
</errorLevel>
|
|
</NoInterfaceProperties>
|
|
|
|
<NullArrayAccess>
|
|
<errorLevel type="suppress">
|
|
<directory name="tests" />
|
|
</errorLevel>
|
|
</NullArrayAccess>
|
|
|
|
<NullPropertyFetch>
|
|
<errorLevel type="suppress">
|
|
<directory name="tests" />
|
|
</errorLevel>
|
|
</NullPropertyFetch>
|
|
|
|
<NullArgument>
|
|
<errorLevel type="suppress">
|
|
<directory name="tests" />
|
|
</errorLevel>
|
|
</NullArgument>
|
|
|
|
<PossiblyFalseArgument>
|
|
<errorLevel type="suppress">
|
|
<directory name="tests" />
|
|
</errorLevel>
|
|
</PossiblyFalseArgument>
|
|
|
|
<TypeCoercion>
|
|
<errorLevel type="suppress">
|
|
<directory name="tests" />
|
|
</errorLevel>
|
|
</TypeCoercion>
|
|
</issueHandlers>
|
|
</psalm>
|