Redex Plugin

A Gradle plugin that allows you to use Facebook's Redex tool as part of your build process

Usage

Add the following to your build.gradle:

buildscript {
    repositories {
        jcenter()
    }
    dependencies {
        classpath 'com.android.tools.build:gradle:2.0.0'
        classpath 'au.com.timmutton:redex:1.5.0'
    }
}

apply plugin: 'com.android.application'
apply plugin: 'redex'

// Optional: configure redex arguments
// These are example arguments, fill them with your specific arguments
redex {
    // see github.com/facebook/redex/blob/stable/config/default.config
    configFile = new File('redex.config')

    // 'latest' downloads the most recent release of redex (recommended)
    // `null` does not download redex at all. Assumes `redex` is in PATH
    // Any other version string will download that specific version of redex
    // from github.com/facebook/redex/releases/tag/<version>
    version = 'latest'

    // `passes` is shorthand for a pass list instead of a config file
    // passes = ['ReBindRefsPass', ..., 'ShortenSrcStringsPass']

    proguardConfigFiles = [new File('common_proguard.pro'),
                           new File('my_app_proguard.pro')]
    proguardMapFile = new File('proguard_map.txt')
    keepFile = new File('keep.txt')

    jarFiles = [new File('lib1.jar'), new File('lib2.jar')]
    otherArgs = '' // any other command line options to `redex`

    // see `redex --help` for details on these arguments
}

If you do not set the passes or the config file, the default set of passes will be run. Sometimes you may not want to run all optimisation passes, for example some appear to break when optimising kotlin code.

If you specified a signing configuration for the given build type, this plugin will use that configuration to re-sign the application (Redex normally un-signs the apk).

License

The MIT License (MIT)

Copyright (c) 2016 Tim Mutton

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.