Skip to content

Latest commit

 

History

History
67 lines (53 loc) · 2.49 KB

README.md

File metadata and controls

67 lines (53 loc) · 2.49 KB
Raw

Lowlighting

Jetbrains Plugin Downloads Rating

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.

    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.

    com.playground.analytics.Lowlight

  3. Annotate a function with the annotation.

    @Lowlight
fun logEvent(
    firebaseEventName: String? = null,
    firebaseParameterName: String? = null,
    firebaseParameterValue: String? = null,
    firebaseParameterMap: Map<String, String?>? = 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
  1. Install plugin
  • Conveniently from within IDE:
    • Plugins > Marketplace > Search for "Lowlighting" > Install
  • Or download the latest release and install it manually using:
    • Plugins > ⚙️ > Install plugin from disk...

License

Apache License 2.0