Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/lppedd/idea-return-highlighter
Highlight return keywords.
https://github.com/lppedd/idea-return-highlighter
hacktoberfest highlighting idea-plugin intellij intellij-idea intellij-plugin
Last synced: about 1 month ago
JSON representation
Highlight return keywords.
- Host: GitHub
- URL: https://github.com/lppedd/idea-return-highlighter
- Owner: lppedd
- License: mit
- Created: 2019-11-08T21:32:51.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2023-03-18T14:40:14.000Z (over 1 year ago)
- Last Synced: 2024-09-27T05:20:20.474Z (about 2 months ago)
- Topics: hacktoberfest, highlighting, idea-plugin, intellij, intellij-idea, intellij-plugin
- Language: Kotlin
- Homepage: https://plugins.jetbrains.com/plugin/13303-return-highlighter
- Size: 380 KB
- Stars: 29
- Watchers: 3
- Forks: 3
- Open Issues: 25
-
Metadata Files:
- Readme: README.md
- Changelog: change-notes/0_1_1.html
- License: LICENSE
Awesome Lists containing this project
README
:bell: Localization needed! PRs are welcomed (look [here][4] for bundles) :sunglasses:
# Return Highlighter
### Available @ [JetBrains Plugins Repository][1]
Looking for the latest **plugin binaries**? Get them [here][3] as `.zip`
Supported IDE versions: `201.6668` to `*`
#### Supported languages
- Java
- JavaScript and TypeScript
- Python
- PHP
- Need another language? [Open an issue][2]
-----
The aim of this plugin is to highlight `return` keywords in source code.
Sometimes it happens we find difficult to read source files; take for example this piece of code
```typescript
1 private toggleRowCheck(rowId: string, doCheck: boolean): boolean {
2 if (doCheck) {
3 if (this.checkedRows.size >= (this.selectionOpt.limit || Infinity)) return false;
4 this.checkedRows.add(rowId);
5 } else {
6 this.checkedRows.delete(rowId);
7 }
8 return true;
9 }
```
It is not immediately apparent a `return` statement is present at line `3`.
This is why the plugin does
- Show a gutter icon next to the `return`ing lines (clicking on it will take you to the return statement!)
- Highlight the `return` keyword, so that it stands out more
#### Example
-----
The plugin offers some degree of customization.
### Choose for which languages to show the gutter icon
You can customize which languages will have the gutter icon via
**Settings > Editor > General > Gutter Icons**
You'll find a _Return Highlighter_ section, with all available languages listed.
### Disable/Customize the return keyword color highlighting
You can disable or customize how the return keyword is highlighted, to stand out more, via
**Settings > Editor > Color Scheme > Return Highlighter**
To reset values to the default ones, check **Inherit values from**.
### Limit the scope of the plugin
- #### Top-level returns only
Certain languages offer features like _lambda expressions_ (Java) or _function expressions_ (JavaScript).
This means potentially you can have nested functions, and thus nested `return` statements.
To highlight only top-level `return` keywords, depending on the language, look under
**Settings > Return Highlighter > *[language]***
and check **Only top-level return keywords**.
- #### Skip simple getters
Highlighting `return` statements in simple functions/methods can be annoying.
Thus it is possible to disable it for such elements.
To skip `return` keywords inside simple getters, look under
**Settings > Return Highlighter > *[language]***
and check **Skip simple getters**.
A _tooltip_ is there to show examples of simple getters, per language, but for the sake of README completeness
here is one too in TypeScript
```
isEnabled(): boolean {
return true;
}
```
-----
## Author
- Edoardo Luppi ()
[1]: https://plugins.jetbrains.com/plugin/13303-return-highlighter
[2]: https://github.com/lppedd/idea-return-highlighter/issues/new?assignees=lppedd&labels=enhancement%2C+language&template=language-support.md&title=Language+support%3A+%5BLANGUAGE%5D
[3]: https://github.com/lppedd/idea-return-highlighter/releases
[4]: https://github.com/lppedd/idea-return-highlighter/tree/master/src/main/resources/messages