Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/konifar/gradle-unused-resources-remover-plugin

Gradle Plugin that removes unused resources in Android projects.
https://github.com/konifar/gradle-unused-resources-remover-plugin

android gradle gradle-plugin unused-resources

Last synced: 7 days ago
JSON representation

Gradle Plugin that removes unused resources in Android projects.

Host: GitHub
URL: https://github.com/konifar/gradle-unused-resources-remover-plugin
Owner: konifar
License: apache-2.0
Created: 2018-04-28T03:35:10.000Z (almost 7 years ago)
Default Branch: master
Last Pushed: 2018-06-20T07:18:50.000Z (over 6 years ago)
Last Synced: 2025-01-15T18:05:06.026Z (15 days ago)
Topics: android, gradle, gradle-plugin, unused-resources
Language: Groovy
Homepage: https://plugins.gradle.org/plugin/com.github.konifar.gradle.unused-resources-remover
Size: 418 KB
Stars: 377
Watchers: 5
Forks: 30
Open Issues: 19
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

# Unused Resources Remover for Android

[![CircleCI](https://circleci.com/gh/konifar/gradle-unused-resources-remover-plugin.svg?style=svg)](https://circleci.com/gh/konifar/gradle-unused-resources-remover-plugin)

Gradle Plugin that removes unused resources in Android projects.

![](art/shell.png)

# Features
- Easy to remove unused resources by simple gradle command
- Customize extra/exclude files configuration
- Support DataBinding & Multi module project

# Simple usage

### build.gradle

```gradle
buildscript {
repositories {
maven { url "https://plugins.gradle.org/m2/" }
}

dependencies {
classpath "gradle.plugin.com.github.konifar.gradle:plugin:0.3.3"
}
}
```

NOTE: If your gradle version is 2.1 and later, you can use new snippet for plugins DSL.
If you want to know more details, see [plugin](https://plugins.gradle.org/plugin/com.github.konifar.gradle.unused-resources-remover) page.

### app/build.gradle

```gradle
apply plugin: "com.github.konifar.gradle.unused-resources-remover"
```

### Run

```shell
$ ./gradlew removeUnusedResources
```

## Hook to Clean Project(Optional)
If you want to hook to `Clean Project`, add following code at the end.

### app/build.gradle
```gradle
clean.dependsOn(removeUnusedResources)
```

# Advanced usage

This plugin checks some basic resource files below.

If you want to check other files, you can add custom remover settings in `app/build.gradle`.

Here is two example.

- `fonts.xml` (actually same format with strings.xml)
- `text_appearance.xml` (actually same format with styles.xml)

```gradle
unusedResourcesRemover {
extraRemovers = [
createXmlValueRemover("fonts", "string", "string"), // fonts.xml
createXmlValueRemover("text_appearance", "style", "style", "style") // text_appearance.xml
]
...
}
```

There are other optional configuration below

```gradle
unusedResourcesRemover {
...
// Write file or directory names
excludeNames = [
"strings.xml", // strings.xml is never checked
"res/drawable" // drawable* dirs are never checked
]

// When dryRun option is true, unused files are not removed.
dryRun = true // default false
}
```

To know more, See [UnusedResourcesRemoverExtension](https://github.com/konifar/gradle-unused-resources-remover-plugin/blob/master/plugin/src/main/groovy/com/github/konifar/gradle/remover/UnusedResourcesRemoverExtension.groovy)

# Contributing
This project is under development.

I'm always welcome your contribution! Feel free to report Issue or send Pull Request!

### Project structure
```
plugin/ - The main module of Gradle plugin
example/ - An example android project that uses this plugin
example-module/ - An example module that are used in example
```

### Download repository
```shell
$ git clone [email protected]:konifar/gradle-unused-resources-remover-plugin.git
$ cd gradle-unused-resources-remover-plugin
```

### Edit build.gradle
```diff
dependencies {
classpath 'com.android.tools.build:gradle:3.1.2'
classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:$kotlin_version"

+// classpath "gradle.plugin.com.github.konifar.gradle:plugin:0.3.3"
- classpath "gradle.plugin.com.github.konifar.gradle:plugin:0.3.3"
// For mavenLocal
+ classpath 'com.github.konifar.gradle:unused-resources-remover:0.3.3'
-// classpath 'com.github.konifar.gradle:unused-resources-remover:0.3.3'
}
```

### Install to local maven
```shell
$ cd plugin
$ ./../gradlew assemble install
```

### Run example
```shell
$ cd example
$ ./../gradlew removeUnusedResources
...
$ > Task :example:removeUnusedResources
$ extraRemovers:
$ fileType: font, resourceName: string, type: DEFAULT
$ fileType: text_appearance, resourceName: style, type: STYLE
$ excludeNames:
$ fonts.xml
$ dryRun: false
$ [layout] ======== Start layout checking ========
$ [layout] example
$ [layout] Remove unused_layout.xml
$ [layout] Complete to remove files.
$ [layout] example-module
$ [layout] No unused layout files.
$ [layout] plugin
...
```

# Donation
If this plugin helps you, I would be so happy.

I'm welcome your tip by [Kyash](https://kyash.co/)! My account name is `konifar`.

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.
```