https://github.com/xuwei-k/sbt-proguard
fork from https://github.com/sbt/sbt-proguard
https://github.com/xuwei-k/sbt-proguard
proguard sbt sbt-plugin
Last synced: over 1 year ago
JSON representation
fork from https://github.com/sbt/sbt-proguard
- Host: GitHub
- URL: https://github.com/xuwei-k/sbt-proguard
- Owner: xuwei-k
- License: apache-2.0
- Created: 2019-07-07T07:02:57.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2025-03-24T21:08:14.000Z (over 1 year ago)
- Last Synced: 2025-04-23T04:16:29.949Z (over 1 year ago)
- Topics: proguard, sbt, sbt-plugin
- Language: Scala
- Homepage:
- Size: 157 KB
- Stars: 5
- Watchers: 3
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
sbt-proguard
============
[sbt] plugin for running [ProGuard]. This plugin requires sbt 1.4.x or later.
Add plugin
----------
Add plugin to `project/plugins.sbt`. For example:
```scala
addSbtPlugin("com.github.xuwei-k" % "sbt-proguard" % "{version}")
```
See [released versions][releases].
Note: earlier versions of sbt-proguard used the `"com.lightbend.sbt"` organization.
Example
-------
A simple `build.sbt` with settings to configure sbt-proguard:
```scala
enablePlugins(SbtProguard)
Proguard / proguardOptions ++= Seq("-dontnote", "-dontwarn", "-ignorewarnings")
Proguard / proguardOptions += ProguardOptions.keepMain("some.MainClass")
```
Run proguard at the sbt shell with:
```shell
proguard:proguard
```
Filters
-------
Proguard supports file filtering for inputs, libraries, and outputs. In
sbt-proguard there are `File => Option[String]` settings for adding filters to
files.
For example, to add a `!META-INF/**` filter to just the scala-library jar:
```scala
Proguard / proguardInputFilter := { file =>
file.name match {
case "scala-library.jar" => Some("!META-INF/**")
case _ => None
}
}
```
which will create the following proguard configuration:
```
-injars "/path/to/scala-library.jar"(!META-INF/**)
```
There are corresponding settings for libraries and outputs: `proguardLibraryFilter` and
`proguardOutputFilter`.
For more advanced usage the `proguardFilteredInputs`, `proguardFilteredLibraries`, and
`proguardFilteredOutputs` settings can be set directly.
Merging
-------
If the same path exists in multiple inputs then proguard will throw an error.
The conflicting paths can be resolved using file filters, as described above,
but this is not always the most useful approach. For example, `reference.conf`
files for the Typesafe Config library need to be retained and not discarded.
The sbt-proguard plugin supports pre-merging inputs, similar to creating an
assembly jar first. To enable this merging use:
```scala
Proguard / proguardMerge := true
```
Conflicting paths that are not identical will now fail at the merge stage. These
conflicting paths can have merge strategies applied, similar to the [sbt-assembly]
plugin.
Helper methods for creating common merges are available. These are:
- `discard` -- discard all matching entries
- `first` -- only keep the first entry
- `last` -- only keep the last entry
- `rename` -- rename entries adding the name of the source
- `append` -- append entries together into one file
The paths matched against in these helpers are normalised to be separated by `/`
regardless of platform. Paths can be matched exactly with a string or with a
regular expression.
The default strategy is to only discard `META-INF/MANIFEST.MF`. This same
strategy could be added with:
```scala
Proguard / proguardMergeStrategies += ProguardMerge.discard("META-INF/MANIFEST.MF")
```
Or all `META-INF` contents could be discarded with a regular expression:
```scala
Proguard / proguardMergeStrategies += ProguardMerge.discard("META-INF/.*".r)
```
To concatenate all `reference.conf` files together use:
```scala
Proguard / proguardMergeStrategies += ProguardMerge.append("reference.conf")
```
To discard all `.html` and `.txt` files you may use two strategies together:
```scala
Proguard / proguardMergeStrategies ++= Seq(
ProguardMerge.discard("\\.html$".r),
ProguardMerge.discard("\\.txt$".r)
)
```
Completely custom merge strategies can also be created. See the plugin source
code for how this could be done.
Sample projects
---------------
There are some [runnable sample projects][samples] included as sbt scripted tests.
License
-------
[ProGuard] is licensed under the [GNU General Public License][gpl]. sbt and sbt scripts
are included in a [special exception][except] to the GPL licensing.
The code for this sbt plugin is licensed under the [Apache 2.0 License][apache].
[sbt]: https://github.com/sbt/sbt
[ProGuard]: https://www.guardsquare.com/en/proguard
[releases]: https://github.com/xuwei-k/sbt-proguard/releases
[sbt-assembly]: https://github.com/sbt/sbt-assembly
[samples]: https://github.com/xuwei-k/sbt-proguard/tree/master/src/sbt-test/proguard
[gpl]: http://www.gnu.org/licenses/gpl.html
[except]: http://proguard.sourceforge.net/GPL_exception.html
[apache]: http://www.apache.org/licenses/LICENSE-2.0.html