Skip to content

Latest commit

 

History

History
44 lines (36 loc) · 2.08 KB

README.md

File metadata and controls

44 lines (36 loc) · 2.08 KB
Raw

Dagger Plugin

IntelliJ iDEA plugin to work with Java/Kotlin projects using Dagger 2 library

preview

Install

You can install the plugin from Preferences -> Plugins and search for the plugin. You can also download the plugin from the intelliJ iDEA Marketplace.

Features

  • View the dependency graph in tree format
  • Jump to source code from the graph
  • View parents and children of a node in the graph
  • View basic validation errors directly in the editor
  • Fully supported for project using both Java and Kotlin including Android

Usage

  • Build your project, and the graph will be displayed in the Dagger tool window
  • Tap on Refresh in the Dagger tool window to refresh the graph
  • The plugin itself uses Dagger 2.31 and hence validations and graph will be calculated based on this version. For optimal usage, consider updating Dagger to the latest version

Testing

All validation logic are unit tested. The test data is organised in the following structure:

src
  |_test
    |_testData
      |_component
        |_ ... (directory for each error highlight)
      |_inject
        |_ ... (directory for each error highlight)

For each error highlight multiple test cases are written. You will notice that there are no test cases under test/kotlin/com.madrapps.dagger. For each annotation there will be a KT test file annotated with GenerateTest. The test cases (classes and methods) are created at compile time by means of the annotation processor: dagger-plugin-processor. The above testData directory structure is crucial for the processor to work properly.

For more clarity, take a look at src/test/kotlin/com.madrapps.dagger.InjectTestCase.kt