Skip to content

Latest commit

 

History

History
87 lines (68 loc) · 3.58 KB

README.md

File metadata and controls

87 lines (68 loc) · 3.58 KB
Raw

Slim Jar

Runtime Dependency Management

What is SlimJar?

SlimJar allows you to download and load up dependencies at runtime as an alternative to shading your dependencies. This helps you reduce build output size and share downloaded dependencies between projects at client side. It is built mainly with the gradle eco-system in mind and is easily configurable being an almost a drop-in replacement/add-on to gradle projects.

Why use SlimJar?

SlimJar makes the process of switching out jars easier by providing jars that are much lesser in size, all "slimmed" dependencies are already available and do not need to be explicitly moved back to your working directory during an update or change. This can be extremely useful for users who have lower bandwidth connections to push large updates to production or testing environments. It also provides vital features such as package relocation, module isolation, auto configuration generation...etc with the simplicity of minor tweaks in your build file.

Usage Example

Note: Use the shadowJar task to compile your project



// this needs to be ran before you reference your dependencies
ApplicationBuilder.appending("MyApplicationName").build()

(NOTE: If you have specified relocations and are running in a IDE or any environment that does not use the shadowjar-ed build file, use the ignoreRelocation flag while running by using -DignoreRelocation in your runner arguments) build.gradle.kts

plugins {
  id("com.github.johnrengelman.shadow") version "7.1.2"
  id("dev.racci.slimjar") version "1.3.2"
}
dependencies {
  implementation slimjar("1.2.9")
  slim("group.id:artifact.id:version")
}

slimJar {
  relocate("a.b.c", "m.n.o")
}

(For Kotlin DSL, to use the slimjar extension in dependencies block, you will need the following import - import io.github.slimjar.func.slimjar)



Development setup

git clone https://github.com/DaRacci/slimjar.git
# or via
gh repo clone DaRacci/slimjar

cd slimjar && ./gradlew test


Releases

Distributed under the MIT licence. See LICENSE for more information.



Contributing

  1. Fork it (https://github.com/DaRacci/slimjar/fork)
  2. Create your feature branch (git checkout -b feature/abcd)
  3. Commit your changes (git commit -am 'Added some feature abcd')
  4. Push to the branch (git push origin feature/fooBar)
  5. Create a new Pull Request