Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dipien/bye-bye-dead-code
Gradle Plugin to automatically detect unused code on your Kotlin or Android project
https://github.com/dipien/bye-bye-dead-code
android deadcode gradle gradle-plugin
Last synced: 3 days ago
JSON representation
Gradle Plugin to automatically detect unused code on your Kotlin or Android project
- Host: GitHub
- URL: https://github.com/dipien/bye-bye-dead-code
- Owner: dipien
- License: apache-2.0
- Created: 2020-07-24T20:46:37.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2022-11-04T12:34:49.000Z (about 2 years ago)
- Last Synced: 2024-11-07T15:44:17.960Z (about 2 months ago)
- Topics: android, deadcode, gradle, gradle-plugin
- Language: Kotlin
- Homepage:
- Size: 361 KB
- Stars: 8
- Watchers: 2
- Forks: 0
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
Awesome Lists containing this project
- awesome-list - dipien/bye-bye-dead-code - Gradle Plugin to automatically detect unused code on your Kotlin or Android project (Kotlin)
README
[](http://www.dipien.com)
# Bye Bye Dead Code
Gradle Plugin to automatically detect unused code on your Kotlin or Android project
## Features
// TODO
## Setup
Add the following configuration to your root `build.gradle`, replacing X.Y.Z with the [latest version](https://github.com/dipien/bye-bye-dead-code/releases/latest)
```groovy
buildscript {
repositories {
mavenCentral()
}
dependencies {
classpath("com.dipien:bye-bye-dead-code:X.Y.Z")
}
}
apply plugin: "com.dipien.bye-bye-dead-code"
```
## Usage
// TODO
### Tasks
#### Generate unused code report
This task depends on R8 which detects unused code when you build your project. So you must enable `minifyEnabled` in the `build.gradle` of your app module. [See how to configure R8](https://developer.android.com/studio/build/shrink-code)
```
./gradlew app:bundleRelease generateDeadCodeReport
```
The report `app/build/outputs/dead_code/usage.txt` will be generated.
##### Extension properties
The extension is configured by default to work using the release build type, but you can change this if you want. Using the extension `byeByeDeadCode` you can modify the following properties:
Name | Type | Description
--- | --- | ---
ignoredClasses | List | *Optional.* List of ignored classes. Supports regex.
ignoredMembers | List | *Optional.* List of ignored class members. Supports regex.
generatedClassesDirs | List | *Required.* Directories that are used by different tools (e.g. kapt) to store generated source code.
Default:
["build/generated/source/kapt/release",
"build/generated/source/navigation-args/release"]
compiledKotlinClassesDir | String | *Required.* Directory where compiled kotlin classes are stored.
Default: "build/tmp/kotlin-classes/release"
compiledJavaClassesDir | String | *Required.* Directory where compiled Java classes are stored.
Default: "build/intermediates/javac/release"
r8UsageFilePath | String | *Required.* File path of usage.txt generated by R8.
Default: "app/build/outputs/mapping/release/usage.txt"
reportFilePath | String | *Required.* File path to store the report.
Default: "app/build/outputs/dead_code/usage.txt"
#### Remove unused Android resources
Remove unused Android resources
```
./gradlew removeUnusedAndroidResources
```
## Copyright
Part of the source code of this project is based on [Unused Resources Remover for Android](https://github.com/konifar/gradle-unused-resources-remover-plugin)
## Versioning
This project uses the [Semantic Versioning guidelines](http://semver.org/) for transparency into our release cycle.
## Sponsor this project
Sponsor this open source project to help us get the funding we need to continue working on it.
* [Donate with Bitcoin Lightning](https://getalby.com/p/dipien) ⚡️ [[email protected]](https://getalby.com/p/dipien)
* [Donate cryptocurrency](http://coinbase.dipien.com/)
* [Donate with PayPal](http://paypal.dipien.com/)
* [Donate on Patreon](http://patreon.dipien.com/)
* [Become a member of Medium](https://maxirosson.medium.com/membership) [We will receive a portion of your membership fee]
## Follow us
* [Twitter](http://twitter.dipien.com)
* [Medium](http://medium.dipien.com)
* [Instagram](http://instagram.dipien.com)
* [Pinterest](http://pinterest.dipien.com)
* [GitHub](http://github.dipien.com)