https://github.com/antimonit/lowlighting
JetBrains IntelliJ IDEA / Android Studio plugin
https://github.com/antimonit/lowlighting
Last synced: 7 months ago
JSON representation
JetBrains IntelliJ IDEA / Android Studio plugin
- Host: GitHub
- URL: https://github.com/antimonit/lowlighting
- Owner: Antimonit
- License: apache-2.0
- Created: 2020-10-14T14:53:54.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2024-11-20T17:53:12.000Z (8 months ago)
- Last Synced: 2024-11-20T18:44:43.902Z (8 months ago)
- Language: Kotlin
- Size: 2.24 MB
- Stars: 5
- Watchers: 1
- Forks: 1
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Lowlighting
[](https://plugins.jetbrains.com/plugin/15206-lowlighting)
[](https://plugins.jetbrains.com/plugin/15206-lowlighting)
[](https://plugins.jetbrains.com/plugin/15206-lowlighting)
A plugin for IntelliJ IDEA and Android Studio.
Lowlights all calls to functions annotated with a custom annotation and allows
folding of all such calls at once.
| Without lowlighting | With lowlighting | Lowlighting collapsed |
|--------------------------------------------------------|-----------------------------------------------------|----------------------------------------------------------|
| 
| 
| 
|
## Usage
1) Declare an annotation. Can be declared either in Java or Kotlin.
```kotlin
package com.playground.analytics
@Retention(value = AnnotationRetention.SOURCE)
annotation class Lowlight
```
2) Create a `.lowlighting` file in the root directory and add the fully qualified name of the annotation.
```text
com.playground.analytics.Lowlight
```
3) Annotate a function with the annotation.
```kotlin
@Lowlight
fun logEvent(
firebaseEventName: String? = null,
firebaseParameterName: String? = null,
firebaseParameterValue: String? = null,
firebaseParameterMap: Map? = null,
)
```
4) All invocations of the annotated function will be lowlighted.
## Installation
1) Access the Plugins page in IDE settings
* On Windows:
- `File` >
`Settings` (Ctrl+Alt+S) >
`Plugins`
* On MacOs:
- `Preferences` (⌘ ,) >
`Plugins`
2) Install plugin
- Conveniently from within IDE:
- `Plugins` >
`Marketplace` >
`Search for "Lowlighting"` >
`Install`
- Or download the [latest release](https://plugins.jetbrains.com/plugin/15206-lowlighting) and install it manually using:
- `Plugins` >
`⚙️` >
`Install plugin from disk...`
## License
[Apache License 2.0](https://choosealicense.com/licenses/apache-2.0/)