https://github.com/greybax/cordova-plugin-proguard

:white_square_button: Cordova Plugin for ProGuard
https://github.com/greybax/cordova-plugin-proguard

android android-development androidutils apk-size bytecode cordova cordova-android cordova-android-plugin cordova-plugin gradle gradle-plugin hybrid-apps java minifier obfuscator optimization-tools optimizer proguard proguard-rules shrink

Last synced: 7 days ago
JSON representation

:white_square_button: Cordova Plugin for ProGuard

• Host: GitHub
• URL: https://github.com/greybax/cordova-plugin-proguard
• Owner: greybax
• License: mit
• Created: 2017-05-30T23:35:33.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2023-04-27T17:25:09.000Z (over 1 year ago)
• Last Synced: 2024-04-14T07:41:23.011Z (10 months ago)
• Topics: android, android-development, androidutils, apk-size, bytecode, cordova, cordova-android, cordova-android-plugin, cordova-plugin, gradle, gradle-plugin, hybrid-apps, java, minifier, obfuscator, optimization-tools, optimizer, proguard, proguard-rules, shrink
• Language: Shell
• Homepage:
• Size: 50.8 KB
• Stars: 51
• Watchers: 5
• Forks: 258
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
# cordova-plugin-proguard

[![NPM version][npm-image]][npm-url]

[![npm](https://img.shields.io/npm/dm/cordova-plugin-proguard.svg)](https://www.npmjs.com/package/cordova-plugin-proguard)

> Cordova plugin which activates ProGuard and minification for debug and release builds in your cordova mobile application.

## What is ProGuard?

> ProGuard is the open source optimizer for Java bytecode

You can read more about it on [ProGuard official website](https://www.guardsquare.com/en/proguard) and on [android developer portal](https://developer.android.com/studio/build/shrink-code.html)

## How to use

- If you already have installed [Android Studio](https://developer.android.com/studio/index.html) then seems you already have installed ProGuard on your machine. If no, then  you should download and install it manually from [ProGuard official website](https://www.guardsquare.com/en/proguard).

- ```cordova plugin add cordova-plugin-proguard``` - this command will configure your `build.gradle` file and copy `proguard-custom.txt` to `${androidPlatformDirectory}/assets/www/proguard-custom.txt`

## Customization

`proguard-custom.txt` file contains some basic rules for your cordova mobile app. Feel free to [fork this repo](https://github.com/greybax/cordova-plugin-proguard/fork) and modify it as you want. 

You can also to check out some [Android ProGuard snippets](https://github.com/krschultz/android-proguard-snippets)

If you want to add rules to this `proguard-custom.txt`, please create your own `proguard-custom.txt` and add this to your projectroot folder. 

Upon installing the proguard-plugin, the rules will be added to your project.

Example rules for various situations will be in the commented section in the plugin `proguard-custom.txt`.

```

ionic cordova platform rm android

ionic cordova platform add android

```

## History

 - v1.0.0 - supports Cordova version <7

 - v2.0.0 - supports Cordova version 7+ (thanks to @SujitSingh)

## Why I've done this plugin?

https://alfilatov.com/posts/how-to-setup-proguard-in-cordova-application/

## License

MIT © [Aleksandr Filatov](https://alfilatov.com)

[npm-url]: https://npmjs.org/package/cordova-plugin-proguard

[npm-image]: https://img.shields.io/npm/v/cordova-plugin-proguard.svg