1
0
mirror of https://github.com/danog/psalm.git synced 2024-11-26 20:34:47 +01:00
Commit Graph

3186 Commits

Author SHA1 Message Date
Bruce Weirdan
a338e76ef6 Plugin interface segregation (#1076)
* Split Plugin into PluginApi\Hook\* interfaces

* dropped Psalm\Plugin

* updated docs

* s/PluginApi/Plugin/g
2018-11-12 11:20:59 -05:00
Matthew Brown
8b0f2579a5 Update plugin docs 2018-11-12 11:20:59 -05:00
Matthew Brown
c276ad2bb8 Fix scoper paths 2018-11-12 11:20:59 -05:00
Matthew Brown
6ed8bb871d Fix codecoverage refs 2018-11-12 11:20:59 -05:00
Matthew Brown
9709263b8d Make many PropertyAnalyzer properties private 2018-11-12 11:20:59 -05:00
Matthew Brown
4d79b61e93 Change _checker to _analyzer 2018-11-12 11:20:59 -05:00
Matthew Brown
4688b25fd9 Move internal classes to own namespace 2018-11-12 11:20:59 -05:00
Matthew Brown
c7016d9232 Unset new var if it doesn’t appear in break vars 2018-11-11 22:03:08 -05:00
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
Matthew Brown
a3dde47374 Fix issues with build 2018-11-10 20:56:52 -05:00
Matthew Brown
fe25530cad Fix #1073 - relax constraints around missing reflected methods and PHP Parser version 2018-11-10 20:56:31 -05:00
Matthew Brown
e36d7c7d5e Fix $key overwriting 2018-11-10 20:40:34 -05:00
Matthew Brown
12e3ab11ad Improve handling of breaks in switch statements 2018-11-10 20:34:53 -05:00
Matthew Brown
9056353b7f Fix #1065 - allow interface methods to be used in abstract classes 2018-11-10 19:05:51 -05:00
Matthew Brown
2ea58e2c0f Better assertions about non-empty known numbers 2018-11-10 17:56:22 -05:00
Matthew Brown
c136974f4d Allow loop breaks to take precedence over case breaks 2018-11-10 17:29:59 -05:00
Matthew Brown
aa426aca03 Add better support for non-empty arrays when scanning constants 2018-11-10 17:15:37 -05:00
Matthew Brown
1d64f299e9 Make sure only immediate case breaks are detected 2018-11-10 16:29:40 -05:00
Matthew Brown
3664b0975c Make sure switch breaks don’t count as loop breaks 2018-11-10 16:26:03 -05:00
Matthew Brown
9f2fe748e8 Improve handling of vars set in always-entered for/foreach/while loops 2018-11-10 16:10:59 -05:00
Matthew Brown
03ea94e087 Improve handling of do blocks 2018-11-10 14:06:31 -05:00
Matthew Brown
461a9667b5 Split up LoopScopeTest into block-specific tests 2018-11-09 19:54:10 -05:00
Brown
ead7d62d48 Continue checking after method deprecation warning 2018-11-09 14:18:46 -05:00
Brown
71800770b1 Fix delimiter 2018-11-09 12:59:17 -05:00
Brown
ea62387cae Strip out leading slashes before reflecting 2018-11-09 12:34:52 -05:00
Brown
ecf9d8afd7 Fix calculation when sample has a newline 2018-11-09 11:38:40 -05:00
Brown
b7099aaf3f Make sure array changes are noticed 2018-11-09 11:19:44 -05:00
Brown
15b412b10e Add checks for non-empty arrays 2018-11-09 10:56:27 -05:00
Brown
f2c013e45f Improve API for setting temporary file contents 2018-11-09 10:42:55 -05:00
Brown
c9d7d63001 Exit earlier if not checking content at all 2018-11-09 10:42:55 -05:00
Matthew Brown
10a5271012
Remove blank line 2018-11-09 08:53:03 -05:00
Matthew Brown
e5c628f7df Fix 7.0-incompatible code 2018-11-09 08:43:17 -05:00
Matthew Brown
1e32354386 Improve accuracy of MissingPropertyType 2018-11-09 00:59:13 -05:00
Matthew Brown
f2f8edef20 Fix #1062 - improve handling of baseline messaging 2018-11-09 00:47:43 -05:00
Matthew Brown
10a0f19870 Delay loading stubs until after first scan; 2018-11-09 00:47:23 -05:00
Matthew Brown
2065e0129e Fix #1069 - module arithmetic always returns ints 2018-11-07 08:45:26 -05:00
Matthew Brown
6cf6d2cfda Add null check 2018-11-06 09:18:39 -05:00
Matthew Brown
8354b6e055 Fix #1063 with removal of unnecessary code 2018-11-06 08:53:22 -05:00
Vasily Kartashov
a3007266d0 add nullable bool result to mysql_stmt::fetch 2018-11-06 08:14:59 -05:00
Brown
1725bd466d Fix #1059 by reducing file path further 2018-11-05 18:22:18 -05:00
Erik Booij
f05d10ebe4 Automatically add reference to baseline to config file 2018-11-04 19:28:12 -05:00
Gabriel Caruso
abfceca3a9 Use dedicated assertContainsOnlyInstancesOf assertion 2018-11-04 19:27:21 -05:00
Gabriel Caruso
62a1d0d12a Simplify return statment 2018-11-04 19:26:37 -05:00
Matthew Brown
98a5503260 Remove unused var 2018-11-04 19:26:17 -05:00
Brown
3fc67782a9 Fix #1055 - improve reconciliation of class-strings 2018-11-02 17:38:20 -04:00
Brown
07934b8333 Fix isString check for class strings 2018-11-02 17:03:49 -04:00
Brown
f7a37d05b9 Improve handling of generic params in intersection types
Ref #1053
2018-11-02 13:09:04 -04:00
Matthew Brown
f592e54a4e Add hover info for extends and implements 2018-11-01 23:40:36 -04:00
Matthew Brown
ccf5de0418 Improve array coercion checks 2018-11-01 23:31:40 -04:00
Matthew Brown
1152aa953f Fix #1026 - warn about bad docblock in @property annotation 2018-11-01 23:04:00 -04:00