Skip to content

afaucogney/flipper-ktp

Repository files navigation

WIP

Download

Android Ktp (Kotlin Toothpick) driver for Flipper.

Download

  • Configure Flipper
  • Top level gradle:
allprojects {
    repositories {
        ...
    	maven { url 'https://jitpack.io' }
		}
	}

}
  • Dependency:

Toothpick >= 3.1.0:

implementation 'com.github.afaucogney:flipper-ktp:master-SNAPSHOT'
  • Instantiate and add plugin to the FlipperClient.
val client: FlipperClient = AndroidFlipperClient.getInstance(this)
with(client) {
    addPlugin(InspectorFlipperPlugin(this@BackpackApplication, DescriptorMapping.withDefaults()))
    addPlugin(KtpFlipperPlugin())
    start()
}

Usage

Open Flipper app and enable Ktp plugin

Features

  • Displaying runtime scope tree
  • Displaying scope names
  • Displaying bindings by scope

Currently the plugin doesn't refresh in case of KTP scope tree change. You have to update it manually going to another plugin and coming back.

Credits

  • Toothpick - As target for this plugin but also for the repo structure.
  • LeakCanary - For its great documentation structure and process, that I almost copy.
  • Flipper - For supporting mobile devs by offering a great mobile app analysis tool.
  • Flipper-Realm-Android - For the idea to build a simple plugin.

Background

This seems to maybe an overkill repo for just a the KtpFlipperPlugin class, but it has been for me the chance to build my first android library with a state-of-the-art documentation.

Blagounette

License

Copyright 2020 Anthony Faucogney

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

   http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

Releases

No releases published

Packages

No packages published