Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.
Awesome Lists | Featured Topics | Projects
https://github.com/gregoranders/gradle-project-configuration

Gradle JAVA Project Configuration Plugin
https://github.com/gregoranders/gradle-project-configuration
gradle-plugin groovy sonarcloud
Last synced: about 1 month ago
JSON representation
Gradle JAVA Project Configuration Plugin
Host: GitHub
URL: https://github.com/gregoranders/gradle-project-configuration
Owner: gregoranders
License: mit
Created: 2022-01-11T18:32:53.000Z (almost 3 years ago)
Default Branch: main
Last Pushed: 2023-06-04T16:05:45.000Z (over 1 year ago)
Last Synced: 2023-06-04T17:21:09.252Z (over 1 year ago)
Topics: gradle-plugin, groovy, sonarcloud
Language: Groovy
Homepage: https://gregoranders.github.io/gradle-project-configuration
Size: 286 KB
Stars: 2
Watchers: 3
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project

README

        # Gradle Project Configuration Plugin

### Following the principle of *convention over configuration* this Gradle plugin provides default configurations for various plugins of a Gradle JVM project so that you do not need to copy boilerplate code throughout your projects.

#### Compiled using JAVA 17 with 1.8 as target and Gradle 8.1.1

[![Release][release-image]][release-url]

[![License][license-image]][license-url]

[![Issues][issues-image]][issues-url]

[![ReleaseMain Build][release-build-image]][release-url]

[![Main Build][main-build-image]][main-url]

[//]: # ([![Development Build][development-build-image]][development-url])

[![Bugs](https://sonarcloud.io/api/project_badges/measure?project=gregoranders_gradle-project-configuration&metric=bugs)][sonarcloud-url]

[![Code Smells](https://sonarcloud.io/api/project_badges/measure?project=gregoranders_gradle-project-configuration&metric=code_smells)][sonarcloud-url]

[![Coverage](https://sonarcloud.io/api/project_badges/measure?project=gregoranders_gradle-project-configuration&metric=coverage)][sonarcloud-url]

[![Vulnerabilities](https://sonarcloud.io/api/project_badges/measure?project=gregoranders_gradle-project-configuration&metric=vulnerabilities)][sonarcloud-url]

[![Duplicated Lines (%)](https://sonarcloud.io/api/project_badges/measure?project=gregoranders_gradle-project-configuration&metric=duplicated_lines_density)][sonarcloud-url]

[![Lines of Code](https://sonarcloud.io/api/project_badges/measure?project=gregoranders_gradle-project-configuration&metric=ncloc)][sonarcloud-url]

[![Technical Debt](https://sonarcloud.io/api/project_badges/measure?project=gregoranders_gradle-project-configuration&metric=sqale_index)][sonarcloud-url]

[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=gregoranders_gradle-project-configuration&metric=alert_status)][sonarcloud-url]

[![Maintainability Rating](https://sonarcloud.io/api/project_badges/measure?project=gregoranders_gradle-project-configuration&metric=sqale_rating)][sonarcloud-url]

[![Reliability Rating](https://sonarcloud.io/api/project_badges/measure?project=gregoranders_gradle-project-configuration&metric=reliability_rating)][sonarcloud-url]

[![Security Rating](https://sonarcloud.io/api/project_badges/measure?project=gregoranders_gradle-project-configuration&metric=security_rating)][sonarcloud-url]

[![Main Language][language-image]][code-metric-url] [![Languages][languages-image]][code-metric-url] [![Code Size][code-size-image]][code-metric-url] [![Repo-Size][repo-size-image]][code-metric-url]

## How to use

### Using the plugins DSL

```groovy

plugins {

  id "io.github.gregoranders.project-configuration" version "0.0.9"

}

```

### Using legacy plugin application

```groovy

buildscript {

  repositories {

    maven {

      url "https://plugins.gradle.org/m2/"

    }

  }

  dependencies {

    classpath "io.github.gregoranders:project-configuration:0.0.9"

  }

}

apply plugin: "io.github.gregoranders.project-configuration"

```

## Supported plugins

* [IDEA][idea-plugin-url]

* [Checkstyle][checkstyle-plugin-url]

* [PMD][pmd-plugin-url]

* [JaCoCo][jacoco-plugin-url]

* [SpotBugs][spotbugs-plugin-url]

* [OWASP Dependency Check][dependencycheck-plugin-url]

* [Maven Publish][maven-publish-plugin-url]

* [Signing][signing-plugin-url]

### IDEA

required configuration properties

* sourceCompatibility

```groovy

idea {

  project {

    vcs = 'Git'

    jdkName = "jdk-${project.sourceCompatibility}"

    languageLevel = project.targetCompatibility

  }

  module {

    downloadJavadoc = true

    downloadSources = true

  }

}

```

### Checkstyle

required configuration properties

* checkstyleVersion

```groovy

checkstyle {

  toolVersion = project.rootProject.property('checkstyleVersion')

  ignoreFailures = false

}

project.tasks.checkstyleTest.enabled = false

```

### PMD

required configuration properties

* pmdVersion

optional configuration properties

* cpdMinimumTokenCount *used for the Copy/Paste detection - default is 10*

```groovy

pmd {

  consoleOutput = true

  incrementalAnalysis = true

  toolVersion = project.rootProject.property('pmdVersion')

  ignoreFailures = false

  ruleSets = []

  ruleSetConfig = project.rootProject.resources.text.fromFile('config/pmd/pmd-rules.xml')

}

project.tasks.register('cpdMain', CPDTask)

project.tasks.pmdTest.enabled = false

project.check {

  dependsOn project.tasks.cpdMain

}

```

### JaCoCo

required configuration properties

* jacocoVersion

```groovy

jacoco {

  toolVersion = project.rootProject.property('jacocoVersion')

}

jacocoTestReport {

  dependsOn project.tasks.test

  reports {

    xml.required = true

    csv.required = true

    html.required = true

  }

}

jacocoTestCoverageVerification {

  violationRules {

    rule {

      limit {

        counter = 'INSTRUCTION'

        minimum = 1.0

      }

      limit {

        counter = 'BRANCH'

        minimum = 1.0

      }

      limit {

        counter = 'LINE'

        minimum = 1.0

      }

      limit {

        counter = 'METHOD'

        minimum = 1.0

      }

      limit {

        counter = 'CLASS'

        minimum = 1.0

      }

    }

  }

}

project.tasks.test {

  finalizedBy project.tasks.jacocoTestReport

}

project.tasks.check {

  dependsOn project.tasks.jacocoTestCoverageVerification

}

```

### SpotBugs

required configuration properties

* spotbugsVersion

```groovy

spotbugs {

  toolVersion = project.rootProject.property('spotbugsVersion')

  ignoreFailures = false

  effort = 'max'

  reportLevel = 'low'

  excludeFilter = project.rootProject.file('config/spotbugs/excludeFilter.xml')

}

spotbugsMain {

  reports {

    html {

      outputLocation = project.layout.buildDirectory.file('reports/spotbugs/main/spotbugs.html').get().asFile

      stylesheet = 'fancy-hist.xsl'

    }

    xml {

      outputLocation = project.layout.buildDirectory.file('reports/spotbugs/main/spotbugs.xml').get().asFile

    }

  }

}

project.tasks.spotbugsTest.enabled = false

```

### OWASP Dependency Check

```groovy

dependencyCheck {

  autoUpdate = true

  failBuildOnCVSS = 1

  cveValidForHours = 1

  format = 'ALL'

  outputDirectory = project.layout.buildDirectory.dir('reports/dependency-check').get().asFile

  suppressionFile = project.rootProject.file('config/dependency-check/suppressions.xml')

  analyzers {

    experimentalEnabled = true

    archiveEnabled = true

    jarEnabled = true

    centralEnabled = true

    nexusEnabled = false

    nexusUsesProxy = false

    nuspecEnabled = false

    assemblyEnabled = false

    msbuildEnabled = false

    golangDepEnabled = false

    golangModEnabled = false

    cocoapodsEnabled = false

    swiftEnabled = false

    swiftPackageResolvedEnabled = false

    bundleAuditEnabled = false

    pyDistributionEnabled = false

    pyPackageEnabled = false

    rubygemsEnabled = false

    opensslEnabled = false

    cmakeEnabled = false

    autoconfEnabled = false

    composerEnabled = false

    cpanEnabled = false

    nodeEnabled = false

  }

}

if (System.getenv('CI') == 'true') {

  check {

    dependsOn project.tasks.dependencyCheckAnalyze

  }

}

```

### Maven Publish

required configuration properties

* url

* license

* licenseUrl

* authorId

* author

* email

* scmUrl

```groovy

publishing {

  publications {

    mavenJava(MavenPublication) {

      from project.components.java

      pom {

        name = project.name

        description = project.description

        url = property('url')

        licenses {

          license {

            name = property('license')

            url = property('licenseUrl')

          }

        }

        developers {

          developer {

            id = property('authorId')

            name = property('author')

            email = property('email')

          }

        }

        scm {

          connection = "scm:git:git://${property('scmUrl')}"

          developerConnection = "scm:git:ssh://${property('scmUrl')}"

          url = property('url')

        }

      }

    }

  }

  repositories {

    maven {

      name = 'Build'

      url = project.layout.buildDirectory.dir('repos')

    }

  }

}

```

### Signing

required environment variables

* GPG_KEY_ID

* GPG_KEY

* GPG_PASSPHRASE

```groovy

if (System.getenv('GPG_KEY_ID') && System.getenv('GPG_KEY') && System.getenv('GPG_PASSPHRASE')) {

  project.signing {

    useInMemoryPgpKeys(System.getenv('GPG_KEY_ID'), System.getenv('GPG_KEY'), System.getenv('GPG_PASSPHRASE'))

    if (project.plugins.hasPlugin('maven-publish')) {

      sign project.publishing.publications

    }

  }

}

```

[project-url]: https://github.com/users/gregoranders/projects/1

[release-url]: https://github.com/gregoranders/gradle-project-configuration/releases

[main-url]: https://github.com/gregoranders/gradle-project-configuration/tree/main

[development-url]: https://github.com/gregoranders/gradle-project-configuration/tree/development

[code-metric-url]: https://github.com/gregoranders/gradle-project-configuration/search?l=JAVA

[license-url]: https://github.com/gregoranders/gradle-project-configuration/blob/main/LICENSE

[license-image]: https://img.shields.io/github/license/gregoranders/gradle-project-configuration.svg

[issues-url]: https://github.com/gregoranders/gradle-project-configuration/issues

[issues-image]: https://img.shields.io/github/issues-raw/gregoranders/gradle-project-configuration.svg

[release-image]: https://img.shields.io/github/release/gregoranders/gradle-project-configuration

[release-build-image]: https://github.com/gregoranders/gradle-project-configuration/workflows/Release%20CI/badge.svg

[main-build-image]: https://github.com/gregoranders/gradle-project-configuration/workflows/Main%20CI/badge.svg

[development-build-image]: https://github.com/gregoranders/gradle-project-configuration/workflows/Development%20CI/badge.svg

[language-image]: https://img.shields.io/github/languages/top/gregoranders/gradle-project-configuration

[languages-image]: https://img.shields.io/github/languages/count/gregoranders/gradle-project-configuration

[code-size-image]: https://img.shields.io/github/languages/code-size/gregoranders/gradle-project-configuration

[repo-size-image]: https://img.shields.io/github/repo-size/gregoranders/gradle-project-configuration

[sonarcloud-url]: https://sonarcloud.io/summary/new_code?id=gregoranders_gradle-project-configuration

[spock-url]: https://spockframework.org

[checkstyle-plugin-url]: https://docs.gradle.org/current/userguide/checkstyle_plugin.html

[pmd-plugin-url]: https://docs.gradle.org/current/userguide/pmd_plugin.html

[idea-plugin-url]: https://docs.gradle.org/current/userguide/idea_plugin.html

[jacoco-plugin-url]: https://docs.gradle.org/current/userguide/jacoco_plugin.html

[spotbugs-plugin-url]: https://github.com/spotbugs/spotbugs-gradle-plugin

[dependencycheck-plugin-url]: https://github.com/jeremylong/DependencyCheck

[maven-publish-plugin-url]: https://docs.gradle.org/current/userguide/publishing_maven.html

[signing-plugin-url]: https://docs.gradle.org/current/userguide/signing_plugin.html