Skip to content

Commit

Permalink
prepare gradle plugin publication
Browse files Browse the repository at this point in the history
  • Loading branch information
sergei-lapin committed Mar 27, 2021
1 parent 66f5611 commit 6c1d47b
Show file tree
Hide file tree
Showing 3 changed files with 55 additions and 1 deletion.
46 changes: 46 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
# NAPT

[![](https://jitpack.io/v/sergei-lapin/napt.svg)](https://jitpack.io/#sergei-lapin/napt)
[![License](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)

## What is it?

An alternative to KAPT that skips stub generation and hence runs up to 50% faster

## Usage

*JDK 9+ is required to run this particular set of tools*

## Sample

You could see an example of usage in [sample](https://github.com/sergei-lapin/napt/blob/main/sample/build.gradle)

## Download
- javac plugin is distributed through JitPack
- Gradle plugin is distributed through Gradle Plugin Portal

#### Add in the root build.gradle

``` Gradle
buildscript {
repositories {
gradlePluginPortal()
}
}
subprojects {
repositories {
maven { url("https://jitpack.io") }
}
}
```

#### Add library module:

``` Gradle
plugins {
id("com.sergei-lapin.napt") version "{latest-version}"
}
annotationProcessor("com.github.sergei-lapin:napt:{latest-version}")
```
8 changes: 8 additions & 0 deletions napt-gradle/build.gradle
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
plugins {
id("org.jetbrains.kotlin.jvm")
id("com.gradle.plugin-publish") version "0.13.0"
id("java-gradle-plugin")
}

Expand All @@ -25,4 +26,11 @@ gradlePlugin {
description = "The Gradle Plugin for enabling NAPT javac plugin"
implementationClass = "com.slapin.napt.NaptGradlePlugin"
}
}

pluginBundle {
website = "https://github.com/sergei-lapin/napt"
vcsUrl = "https://github.com/sergei-lapin/napt.git"
tags = ["kotlin", "java", "apt", "kapt", "gradle", "plugin"]
description = "Plugin that enables the work of NAPT javac plugin. Please refer to the https://github.com/sergei-lapin/napt/blob/main/README.md"
}
2 changes: 1 addition & 1 deletion napt-gradle/gradle.properties
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
lib.group=com.sergei-lapin.napt
lib.version=1.0
lib.version=1.3

0 comments on commit 6c1d47b

Please sign in to comment.