1
0
mirror of https://github.com/danog/psalm.git synced 2024-11-26 20:34:47 +01:00
psalm/scoper.inc.php
Bruce Weirdan 052d4f6217 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-10 23:23:36 -05:00

131 lines
4.2 KiB
PHP

<?php
return [
'patchers' => [
function ($filePath, $prefix, $contents) {
//
// PHP-Parser patch
//
if ($filePath === 'vendor/nikic/php-parser/lib/PhpParser/NodeAbstract.php') {
$length = 15 + strlen($prefix) + 1;
return preg_replace(
'%strpos\((.+?)\) \+ 15%',
sprintf('strpos($1) + %d', $length),
$contents
);
}
return $contents;
},
function ($filePath, $prefix, $contents) {
return str_replace(
'\\'.$prefix.'\Composer\Autoload\ClassLoader',
'\Composer\Autoload\ClassLoader',
$contents
);
},
function ($filePath, $prefix, $contents) {
if ($filePath === 'src/Psalm/Config.php') {
return str_replace(
$prefix . '\Composer\Autoload\ClassLoader',
'Composer\Autoload\ClassLoader',
$contents
);
}
return $contents;
},
function ($filePath, $prefix, $contents) {
if (strpos($filePath, 'src/Psalm') === 0) {
return str_replace(
[' \\Psalm\\', ' \\PhpParser\\'],
[' \\' . $prefix . '\\Psalm\\', ' \\' . $prefix . '\\PhpParser\\'],
$contents
);
}
return $contents;
},
function ($filePath, $prefix, $contents) {
if (strpos($filePath, 'vendor/openlss') === 0) {
return str_replace(
$prefix . '\\DomDocument',
'DomDocument',
$contents
);
}
return $contents;
},
function ($filePath, $prefix, $contents) {
if ($filePath === 'src/Psalm/PropertyMap.php'
|| $filePath === 'src/Psalm/CallMap.php'
|| $filePath === 'src/Psalm/Stubs/CoreGenericFunctions.php'
|| $filePath === 'src/Psalm/Stubs/CoreGenericClasses.php'
) {
$contents = str_replace(
['namespace ' . $prefix . ';', $prefix . '\\\\', $prefix . '\\'],
'',
$contents
);
$contents = str_replace(
['\'phpparser\\\\', 'PhpParser\\\\'],
['\'' . strtolower($prefix) . '\\\\phpparser\\\\', $prefix . '\\\\PhpParser\\\\'],
$contents
);
return str_replace('Psalm\\\\', $prefix . '\\\\Psalm\\\\', $contents);
}
return $contents;
},
function ($filePath, $prefix, $contents) {
if ($filePath === 'src/Psalm/Checker/Statements/Expression/Call/MethodCallChecker.php') {
return str_replace(
'case \'Psalm\\\\',
'case \'' . $prefix . '\\\\Psalm\\\\',
$contents
);
}
return $contents;
},
function ($filePath, $prefix, $contents) {
if ($filePath === 'src/Psalm/Type.php') {
return str_replace(
'get_class($type) === \'Psalm\\\\',
'get_class($type) === \'' . $prefix . '\\\\Psalm\\\\',
$contents
);
}
return $contents;
},
function ($filePath, $prefix, $contents) {
if ($filePath === 'src/psalm.php') {
return str_replace(
'\\' . $prefix . '\\PSALM_VERSION',
'PSALM_VERSION',
$contents
);
}
return $contents;
},
function ($filePath, $prefix, $contents) {
$ret = str_replace(
$prefix . '\Psalm\PluginApi',
'Psalm\PluginApi',
$contents
);
return $ret;
},
],
'whitelist' => [
\Composer\Autoload\ClassLoader::class,
'Psalm\PluginApi\*',
]
];