Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/schlan/java-censor
Gradle plugin for censoring Java source files
https://github.com/schlan/java-censor
android android-library android-studio gradle gradle-plugin hacktoberfest intellij java kotlin
Last synced: about 23 hours ago
JSON representation
Gradle plugin for censoring Java source files
- Host: GitHub
- URL: https://github.com/schlan/java-censor
- Owner: schlan
- License: apache-2.0
- Created: 2018-02-18T13:27:37.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2020-10-31T17:30:14.000Z (almost 4 years ago)
- Last Synced: 2024-09-22T08:32:56.708Z (5 days ago)
- Topics: android, android-library, android-studio, gradle, gradle-plugin, hacktoberfest, intellij, java, kotlin
- Language: Kotlin
- Homepage:
- Size: 97.7 KB
- Stars: 52
- Watchers: 3
- Forks: 5
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
Java Censor is a Gradle plugin that enables developers to publish sources of closed source projects to a Maven repository. It does this by removing implemented code only leaving the signatures of public interfaces, classes, methods and fields behind.
## Purpose
Java Censor is built for closed source java libraries, in particular, closed source Android libraries. When working on closed source libraries, it is usually not possible to ship a source artefact when deploying a release.
That brings one big downside* for the integrators of your library. Even if you ship a Javadoc artefact, IDEs like Android Studio or IntelliJ don't use that artefact for showing documentation. Instead, they rely solely on the source artefact for showing inline documentation.
That is where Java Censor can help. Java Censor makes it possible to release a source artefact of a closed source library without exposing secret code but still allows IDEs to show inline documentation. It does that when running before the release, by removing any implemented code, only keeping public signatures (interfaces, classes, methods, constructors, fields) and Javadoc.
## Usage
For using Java Censor in a Gradle project, it needs to be added to the project first. That is done by adding it as a classpath dependency to the `buildscript` block and applying the plugin to a module.
Applying the plugin to a module introduces a new task type called `CensorCopyTask`. The `CensorCopyTask` behaves like the built-in `Copy` task and has two mandatory configuration options.
- from = [set of input directories/files]
- Takes a set of files as input.
- into = [output directory]
- The output directory. (File)
Example:
```gradle
// Add classpath dependency
buildscript {
dependencies {
classpath group: 'com.sebchlan.javacensor', name: 'java-censor', version: '1.2.1'
}
}
// Apply the plugin
apply plugin: 'com.sebchlan.javacensor'
// Add a new task
tasks.register("censorSource", com.sebchlan.javacensor.CensorCopyTask) { task ->
inputs.files(sourceSets.main.java.srcDirs)
destinationDir = file("$buildDir/censored_source")
}
```
### Android
Java Censor is also applicable to Android projects. The installation steps are very similar to the ones above.
This is how a configuration can look like:
```gradle
buildscript {
repositories {
jcenter()
}
dependencies {
classpath group: 'com.sebchlan.javacensor', name: 'java-censor', version: '1.2.1'
}
}
apply plugin: 'com.sebchlan.javacensor'
afterEvaluate { project ->
uploadArchives {
repositories {
mavenDeployer {
// ....
}
}
task censorSource(type: com.sebchlan.javacensor.CensorCopyTask) {
inputs.files(android.sourceSets.main.java.srcDirs)
destinationDir = file("$buildDir/generated-src")
}
task androidSourcesJar(type: Jar) {
classifier = 'sources'
from "$buildDir/generated-src/"
dependsOn censorSource
}
artifacts {
archives androidSourcesJar
}
}
}
```
## Contribution
Feel free to submit a PR or file an issue. Please make sure, when filing a bug, to provide sufficient reproduction steps or even a failing test.