https://github.com/whosnickdoglio/convention-plugins
A collection of Gradle convention plugins for JVM/Android based projects
https://github.com/whosnickdoglio/convention-plugins
gradle gradle-convention-plugins gradle-plugin kotlin
Last synced: 7 days ago
JSON representation
A collection of Gradle convention plugins for JVM/Android based projects
- Host: GitHub
- URL: https://github.com/whosnickdoglio/convention-plugins
- Owner: WhosNickDoglio
- License: mit
- Created: 2025-01-25T23:53:21.000Z (4 months ago)
- Default Branch: main
- Last Pushed: 2025-02-15T20:05:08.000Z (3 months ago)
- Last Synced: 2025-02-15T20:29:25.245Z (3 months ago)
- Topics: gradle, gradle-convention-plugins, gradle-plugin, kotlin
- Language: Kotlin
- Homepage:
- Size: 117 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Gradle Convention Plugins
[](https://github.com/WhosNickDoglio/convention-plugins/actions/workflows/ci.yml)
[](https://central.sonatype.com/artifact/dev.whosnickdoglio/convention-plugins/overview)
[](.github/CODE_OF_CONDUCT.md)
[](https://codecov.io/github/WhosNickDoglio/convention-plugins)
[](https://codeclimate.com/github/WhosNickDoglio/convention-plugins/maintainability)
[](https://opensource.org/licenses/MIT)
A handful of JVM and Android specific Gradle convention plugins to simplify some project setup
## Usage
```kotlin
plugins {
id("dev.whosnickdoglio.convention.kotlin") version "LATEST_VERSION"
id("dev.whosnickdoglio.convention.gradle") version "LATEST_VERSION"
}
```
Snapshots are also published to Maven Central Portal and can be consumed by adding the following repository to your build.gradle file
```kotlin
maven(url = "https://central.sonatype.com/repository/maven-snapshots/")
```
## Plugins
### `dev.whosnickdoglio.convention.kotlin`
Used where you would normally use `org.jetbrains.kotlin.jvm` (But if you're creating a Gradle plugin
you'll want `dev.whosnickdoglio.convention.gradle` instead)
Plugins that are applied and expected to be on the classpath:
- `org.jetbrains.kotlin.jvm`
- `io.gitlab.arturbosch.detekt`
- `com.autonomousapps.dependency-analysis`
- `com.squareup.sort-dependencies`
- `com.android.lint`
- `com.diffplug.spotless` (Configured to use `ktfmt` KotlinLang code style)
Also configures JDK toolchains and the java target version
### `dev.whosnickdoglio.convention.gradle`
Used where you'd normally use `java-gradle-plugin`
Plugins that are applied and expected to be on the classpath:
- `java-gradle-plugin`
- `org.jetbrains.kotlin.jvm`
- `io.gitlab.arturbosch.detekt`
- `com.autonomousapps.dependency-analysis`
- `com.squareup.sort-dependencies`
- `com.android.lint`
- `com.diffplug.spotless` (Configured to use `ktfmt` KotlinLang code style)
- `com.autonomousapps.plugin-best-practices-plugin`
- `com.autonomousapps.testkit` (For functional tests fo your plugin)
Also configures JDK toolchains & the java target version and sets `validatePlugins` to strict
# License
MIT License
Copyright (c) 2025 Nicholas Doglio
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.