Existing plugins have been updated as well (skeleton, doctrine-collections)
Also fixed path to echo-checker plugin so that it's once again directly
installable from the psalm distribution.
* 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
* upgrade phpunit, test with low and high deps
* work around possibly-anonymous test cases introduced by newer PHPUnit
* Alternative TestCase::getName() nullability workaround
Previous workaround was failing due to PHP warnings on 7.1 or 7.2
(depending on specific signature). There's just no signature that would
be working for all 4 variants of (ver / dep) matrix.
* don't disable xdebug if it's not enabled
* allowed 7.0/high to fail until PHPUnit 6.5.10 is released
see sebastianbergmann/phpunit#3209
Make `composer tests` use only phpcs
Also add `composer all-tests`, which also runs the self-check.
php-cs-fixer was removed from .travis.yml earlier.
I'm guessing that composer was overlooked?
The goal is to make it easy to create PRs passing travis checks.
* Fix path to psalm
* If a magic getter or setter is used to access a property on a class
that is not defined but a `@property` annotation for the property
exists, throw an error. If no `@property` annotation exists, it's not
an error because you're allowed to make magic getters and setters do
crazy things.
Fixes#480
* Move logic to a better place to avoid duplicate checks
* Move logic into function
* Remove some nesting
* Check psalm-seal-properties and property type correctly
* Adding a `--version` argument to the Psalm executable.
* Using ocramius/package-versions instead of hardcoding a version.
* Backporting PackageVersions to a PHP 5.6+ compatible fork.
* Add XML as possible output format + add report generation
* Add missing xml root node
* Change XML generator (previous one don't escape '<' and '>')
* Change option (only one option) + unit test
* swapping phpcs for php-cs-fixer
* workaround for php-cs-fixer treating parenthesis following echo as the function call variant
* amending rules
* blank_line_before_return
* majority of files pass with these disabled, could remove later
* combine_consecutive_unsets
* concat_space
* placeholder for if vimeo/psalm ever goes php:^7.0
* function_to_constant
* disabling include
* linebreak_after_opening_tag, lowercase_cast, magic_constant_casing
* mb_str_functions disabled
* method_separation
* native_function_casing
* native_function_invocations
* new_with_braces disabled to match usage
* no_alias_functions
* no_blank_lines_after_class_opening
* no_blank_lines_after_phpdoc
* no_blank_lines_before_namespace
* no_empty_comment
* no_empty_phpdoc
* no_empty_statement
* no_extra_consecutive_blank_lines
* no_leading_import_slash to discuss
* no_leading_namespace_whitespace
* no_mixed_echo_print
* no_multiline_whitespace_around_double_arrow
* no_multiline_whitespace_before_semicolons
* no_php4_constructor
* no_short_bool_cast
* no_short_echo_tag
* no_singleline_whitespace_before_semicolons
* no_spaces_around_offset
* no_trailing_comma_in_list_call
* no_trailing_comma_in_singleline_array
* no_unneeded_control_parentheses to discuss
* no_unreachable_default_argument_value
* no_unused_imports to discuss
* no_useless_else to discuss
* no_useless_return
* no_whitespace_before_comma_in_array
* no_whitespace_in_blank_line
* non_printable_character
* normalize_index_brace
* ordered_class_elements to discuss
* ordered_imports to discss
* php_unit_construct
* php_unit_dedicate_assert
* php_unit_fqcn_annotation
* php_unit_strict to discuss
* php_unit_test_class_requires_covers to discuss
* phpdoc_add_missing_param_annotation
* phpdoc_align to discuss
* phpdoc_annotation_without_dot to discuss
* phpdoc_indent to discuss
* phpdoc_inline_tag
* phpdoc_no_access
* phpdoc_no_alias_tag
* phpdoc_no_empty_return
* phpdoc_no_package
* phpdoc_no_useless_inheritdoc
* phpdoc_order to discuss
* phpdoc_return_self_reference
* phpdoc_scalar to discuss
* phpdoc_separation to discuss
* phpdoc_single_line_var_spacing
* phpdoc_summary to discuss
* phpdoc_to_comment to discuss
* phpdoc_trim to discuss
* phpdoc_types
* phpdoc_var_without_name
* pow_to_exponentiation
* pre_increment to discuss
* protected_to_private
* psr0 turned off
* psr4 turned on
* random_api_migration
* return_type_declaration to discuss
* self_accessor to discuss
* semicolon_after_instruction
* short_scalar_cast
* silenced_deprecation_error turned off
* simplified_null_return to discuss
* single_quote
* space_after_semicolon
* standardize_not_equals
* strict_comparison to discuss
* strict_param to discuss
* ternary_operator_spaces
* ternary_to_null_coalescing should be set to true if vimeo/psalm ever goes php:^7.0
* trailing_comma_in_multiline_array to discuss
* trim_array_spaces
* unary_operator_spaces
* whitespace_after_comma_in_array to discuss
* multi-version scrutinizer to match travis
* binary_operator_space
* not the best solution, but it works to exclude the call map from php-cs-fixer
* reducing verbosity of config where defaults were used
* dry run php-cs-fixer as part of tests
* disabling rule pending FriendsOfPHP/PHP-CS-Fixer#2739
* enabling no_unused_imports
* enabling ordered_imports
* ignoring user-defined .php_cs
* using $TRAVIS_COMMIT_RANGE to only test modified files
* enabling no_leading_import_slash
* conditionally testing everything
* filter output then perform exact match
* restoring phpcs via partial cherry pick of f65c618
Current definition of dependencies would result in **any** version being installed that is greater than the one specified. This is problematic since new major releases imply breaking changes and nothing ensures that psalm will be compatible with those updated dependencies. Using an operator that instructs Composer to ensure that this does not happen is therefore inalienable.
