https://github.com/klesun/deep-assoc-completion
A phpstorm plugin for associative array key typing and completion
https://github.com/klesun/deep-assoc-completion
associative-map autocompletion php phpstorm-plugin
Last synced: 7 days ago
JSON representation
A phpstorm plugin for associative array key typing and completion
- Host: GitHub
- URL: https://github.com/klesun/deep-assoc-completion
- Owner: klesun
- License: other
- Created: 2017-02-19T23:06:59.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2022-08-03T18:56:25.000Z (over 3 years ago)
- Last Synced: 2024-05-01T13:47:10.096Z (almost 2 years ago)
- Topics: associative-map, autocompletion, php, phpstorm-plugin
- Language: Java
- Homepage:
- Size: 1.85 MB
- Stars: 267
- Watchers: 13
- Forks: 17
- Open Issues: 37
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
PRs are welcome, will gladly help with any questions you may have, but pls try to avoid unnecessary refactoring and features that may cause considerable performance degradation, as such PRs won't be accepted. If in doubt, create an issue to discuss whether feature will be acceptable before starting investing into the solution.
If you need help with building the project or understanding the code, feel free to drop at https://t.me/klesun_productions, we can chat there ;)
____________________________
Autocomplete keys of associative arrays defined in other functions.
Jetbrains Repository: [9927-deep-assoc-completion](https://plugins.jetbrains.com/plugin/9927-deep-assoc-completion)
## Features description
(a bit more relaxed usage guide can be found [here](https://github.com/klesun/phpstorm-deep-keys/blob/master/docs/deep-keys-overview.md))
- ### Completion from expression
When you are going to type an associative key of a variable, like in `$user['']`, put caret between quotes and press `ctrl` + `space`. The plugin will analyze your code, determine what keys does `$user` have and suggest completion.
- ### Go To Definition
To go to the key definition, hover on it and press `ctrl` + `click` or put carret on it and press `ctrl` + `b`.
- ### Completion from phpdoc
[See formats description](https://github.com/klesun/deep-assoc-completion/issues/63)
You can specify function argument type using `@param SomeType $varName = Some::phpExpression()`, like `@param $anime = ['genre' => 'shounen', 'studio' => 'Shaft']`. `=` is mandatory and expression must be a valid php expression. Class methods can be specified either with complete namespace like `\Very\Long\Namespace\ClassName::funcName()`, or with just `ClassName::funcName()`.
You can specify `@return` array keys as well:
```cpp
/**
* @return array [
* 'success' => true,
* 'formObject' => new Form,
* 'errors' => [],
* ]
*/
public static function processForm($arr);
```
- ### Object type info in an associative array
Phpstorm does not give you method name completion when object is located in an associative array? Don't be sad, this plugin is exactly what you need!
- ### To N-th Test
Did you ever want an ability to find out which exactly test case does phpunit mean by the `with data set "17"` without manually counting them? You can find this feature in _Tools -> deep-assoc-completion -> To N-th Test_. It moves your caret to the test case with the order you specify in the popup. If there are multiple `@dataProvider` functions in the file, the function caret is currently in will be used. This action will work correctly only on more or less straightforward `@dataProvider`-s.
- ### String value completion
- ### Transpile to JS code (not related to completion anyhow, but whatever)
## Completion sources
- ### Argument type resolution based on what was passed to the function
Extremely useful for small private helper functions - you don't need to document args in each of them to get completion.
- ### Keys from PDOStatement::fetch() if your Database is connected to IDEA
- ### All built-in array functions I could find are supported
## Steps to compile plugin into a `.jar` follow:
- Start creating a new project in _[Intelliji Idea](https://www.jetbrains.com/idea/)_.
- Select `Intelliji Platform Plugin`.
- Select a _phpstorm_ or _IDEA Ultimate_ installation directory as `Project SDK` (java version is 8).
- Select `deep-assoc-completion` project folder as `Project location`.
- In `Project Structure -> Libraries` add `php/lib/php.jar`, `php/lib/php-openapi.jar` and `twig/lib/twig.jar` from `YourPhpStormDirectory/plugins/[php|twig]` (in case of _IDEA Ultimate_, the `php` and `twig` plugins should be installed, and the location is `HomeOrMyDocumentsDir/.IntellijIdea20XX.X/config/plugins/[php|twig]/lib`).
- In `Project Structure -> Modules -> Dependencies` set `Scope` of `php`, `php-openapi` and `twig` to `Provided`.
To build a jar use `Build -> Prepare Plugin ... For Deployment`. To debug use `Run -> Debug`. Since phpstorm project takes about a minute to start, you must find `Run -> Reload Changed Classes` very useful for micro changes.
To use compiled `.jar` in your phpstorm go to `Settings -> Plugins -> Install plugin from disk` and select the `.jar` we compiled earlier.
_________________________________________________________
Shutout my thanks to the [JetBrains](https://jb.gg/OpenSource) for continuously supplying me an open source IDE license for this plugin development.