Git Product home page Git Product logo

gradle-projectconfiguration's Introduction

Project Configuration Gradle Plugin

A gradle plugin to share best-practice project configurations.

Link: plugins.gradle.org/plugin/me.philippheuer.configuration

Installation

Add the plugin to your build.gradle:

plugins {
    id 'me.philippheuer.configuration' version '+'
}

Usage

You can configure your project with a few simple parameters:

Example:

projectConfiguration {
    language.set(me.philippheuer.projectcfg.domain.ProjectLanguage.JAVA)
    type.set(me.philippheuer.projectcfg.domain.ProjectType.APP)
    framework.set(me.philippheuer.projectcfg.domain.ProjectFramework.SPRINGBOOT)
}

Note: You can apply this plugin to each of your project modules independently, if your project contains different project types.

Options:

Option Description allowed values
language the language JAVA, KOTLIN
type the project type APP, BATCH, LIBRARY
framework your framework of choice (optional) SPRINGBOOT, QUARKUS

Example Configurations

Description Link
MavenCentral Library ...
Private Library ...
SpringBoot Microservice ...
Quarkus Microservice ...

Modules

There are options to further configure each feature, these links document what a feature does by default and what customization options are available.

Type Name Docs
Type Application view
Type Library view
Policy Gradle Wrapper Version view
Framework SpringBoot view
Framework Quarkus view
Feature Lombok view
Feature Javadoc view
Feature Test Logging view
Feature Shadow view
Feature JUnit5 view
Feature Manifest view
Feature VersionUpgrade view
Check Checkstyle (Java) view
Check Detekt (Kotlin) view

Related Plugins

This plugin may include the following plugins based on your project configuration:

License

Released under the MIT License.

gradle-projectconfiguration's People

Contributors

cid-workflow[bot] avatar iprodigy avatar philippheuer avatar renovate[bot] avatar

Stargazers

 avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar

Forkers

iprodigy

gradle-projectconfiguration's Issues

Action Required: Fix Renovate Configuration

There is an error with this repository's Renovate configuration that needs to be fixed. As a precaution, Renovate will stop PRs until it is resolved.

Error type: Cannot find preset's package (github>philippheuer/renovate-config:preset/java)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.