{"id":13608205,"url":"https://github.com/xvik/gradle-quality-plugin","last_synced_at":"2025-04-05T06:08:18.496Z","repository":{"id":38375544,"uuid":"46465020","full_name":"xvik/gradle-quality-plugin","owner":"xvik","description":"Gradle quality plugin for Java and Groovy","archived":false,"fork":false,"pushed_at":"2025-01-31T04:29:21.000Z","size":4245,"stargazers_count":133,"open_issues_count":3,"forks_count":11,"subscribers_count":7,"default_branch":"master","last_synced_at":"2025-03-29T05:06:27.489Z","etag":null,"topics":["checkstyle","codenarc","findbugs","gradle","gradle-plugin","pmd","quality","spotbugs"],"latest_commit_sha":null,"homepage":"http://xvik.github.io/gradle-quality-plugin","language":"Groovy","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/xvik.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2015-11-19T03:29:44.000Z","updated_at":"2025-03-15T20:52:06.000Z","dependencies_parsed_at":"2023-11-18T06:25:03.692Z","dependency_job_id":"e8f60a02-f12f-4a88-a217-0afa9728d080","html_url":"https://github.com/xvik/gradle-quality-plugin","commit_stats":{"total_commits":562,"total_committers":2,"mean_commits":281.0,"dds":0.09430604982206403,"last_synced_commit":"1774617d055331b82525165a7e59b2fe47fe8c2f"},"previous_names":[],"tags_count":32,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/xvik%2Fgradle-quality-plugin","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/xvik%2Fgradle-quality-plugin/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/xvik%2Fgradle-quality-plugin/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/xvik%2Fgradle-quality-plugin/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/xvik","download_url":"https://codeload.github.com/xvik/gradle-quality-plugin/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247294539,"owners_count":20915340,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["checkstyle","codenarc","findbugs","gradle","gradle-plugin","pmd","quality","spotbugs"],"created_at":"2024-08-01T19:01:25.172Z","updated_at":"2025-04-05T06:08:18.479Z","avatar_url":"https://github.com/xvik.png","language":"Groovy","funding_links":[],"categories":["Groovy"],"sub_categories":[],"readme":"# Gradle quality plugin\n[![License](https://img.shields.io/badge/license-MIT-blue.svg?style=flat)](http://www.opensource.org/licenses/MIT)\n[![CI](https://github.com/xvik/gradle-quality-plugin/actions/workflows/CI.yml/badge.svg)](https://github.com/xvik/gradle-quality-plugin/actions/workflows/CI.yml)\n[![Appveyor build status](https://ci.appveyor.com/api/projects/status/github/xvik/gradle-quality-plugin?svg=true)](https://ci.appveyor.com/project/xvik/gradle-quality-plugin)\n[![codecov](https://codecov.io/gh/xvik/gradle-quality-plugin/branch/master/graph/badge.svg)](https://codecov.io/gh/xvik/gradle-quality-plugin)\n\n**DOCUMENTATION** http://xvik.github.io/gradle-quality-plugin\n\n### About\n\nStatic code analysis for Java and Groovy projects using [Checkstyle](https://checkstyle.sourceforge.io/), \n[PMD](https://pmd.github.io/), [CPD](https://pmd.github.io/), [SpotBugs](https://spotbugs.github.io/) \nand [CodeNarc](https://codenarc.org/).\nPlugin implements unified console output for all quality plugins, which greatly simplifies developer workflow: \nonly console required for working with violations and makes it feel the same as java compiler errors.\n\nFor example, in IntelliJ Idea it would look like: \n![](img/in-action.gif)\n\nFeatures:\n* Zero configuration by default: provided opinionated configs applied to all quality plugins\n    - Default configuration files may be customized\n* Adds extra javac lint options to see more warnings\n* Complete console output for all quality plugins\n* Html and xml reports for all plugins (custom xsl used for findbugs html report because it can't generate both xml and html reports)\n* Grouping tasks to run registered quality plugins for exact source set (e.g. checkQualityMain)\n\nNOTE: the plugin is **not compatible** with the gradle [configuration cache](https://docs.gradle.org/current/userguide/configuration_cache.html)\n\n##### Summary\n\n* Configuration: `quality`\n* Tasks:\n    - `initQualityConfig` - copy default configs for customization \n    - `checkQuality[Main]` - run quality tasks for main (or any other) source set       \n* Enable plugins: [Checkstyle](https://docs.gradle.org/current/userguide/checkstyle_plugin.html),\n[PMD](https://docs.gradle.org/current/userguide/pmd_plugin.html),\n[SpotBugs](http://spotbugs.readthedocs.io/en/latest/gradle.html),\n[CodeNarc](https://docs.gradle.org/current/userguide/codenarc_plugin.html)\n\n\n### Setup\n\nNOTE: when updating plugin version in your project don't forget to call `clean` task to remove cached configs from previous plugin version\n\n[![Maven Central](https://img.shields.io/maven-central/v/ru.vyarus/gradle-quality-plugin.svg)](https://maven-badges.herokuapp.com/maven-central/ru.vyarus/gradle-quality-plugin)\n[![Gradle Plugin Portal](https://img.shields.io/maven-metadata/v/https/plugins.gradle.org/m2/ru/vyarus/quality/ru.vyarus.quality.gradle.plugin/maven-metadata.xml.svg?colorB=007ec6\u0026label=plugins%20portal)](https://plugins.gradle.org/plugin/ru.vyarus.quality)\n\n```groovy\nplugins {\n    id 'ru.vyarus.quality' version '5.0.0'\n}\n```\n\nOR\n\n```groovy\nbuildscript {\n    repositories {\n        mavenCentral()\n        gradlePluginPortal()\n    }\n    dependencies {\n        classpath 'ru.vyarus:gradle-quality-plugin:5.0.0'\n    }\n}\napply plugin: 'ru.vyarus.quality'\n```\n\nMinimal requirements: java 8, gradle 7\n\n#### Compatibility\n\nPlugin compiled for java 8, compatible with java 11 (and above)\n\nGradle | Version\n--------|-------\n7-8     | 5.0.0\n5.6-6   | [4.9.0](https://xvik.github.io/gradle-quality-plugin/4.9.0/)\n5.1     | [4.2.2](http://xvik.github.io/gradle-quality-plugin/4.2.2)\n4.1     | [3.4.0](http://xvik.github.io/gradle-quality-plugin/3.4.0)\nolder   | [2.4.0](http://xvik.github.io/gradle-quality-plugin/2.4.0)\n\nJava tools require `sourceCompatibility=1.8` (or above).\n \nVersion [3.3.0](http://xvik.github.io/gradle-quality-plugin/3.3.0) is the latest supporting `sourceCompatibility=1.6`  \n\n#### Snapshots\n\n\u003cdetails\u003e\n      \u003csummary\u003eSnapshots may be used through JitPack\u003c/summary\u003e\n\n* Go to [JitPack project page](https://jitpack.io/#ru.vyarus/gradle-quality-plugin)\n* Select `Commits` section and click `Get it` on commit you want to use (you may need to wait while version builds if no one requested it before)\n    or use `master-SNAPSHOT` to use the most recent snapshot\n\n* Add to `settings.gradle` (top most!) (exact commit hash might be used as version):\n\n  ```groovy\n  pluginManagement {\n      resolutionStrategy {\n          eachPlugin {\n              if (requested.id.id == 'ru.vyarus.quality') {\n                  useModule('ru.vyarus:gradle-quality-plugin:master-SNAPSHOT')\n              }\n          }\n      }\n      repositories {                        \n          gradlePluginPortal()\n          maven { url 'https://jitpack.io' }                    \n      }\n  }    \n  ``` \n* Use plugin without declaring version: \n\n  ```groovy\n  plugins {\n      id 'ru.vyarus.quality'\n  }\n  ```  \n\n\u003c/details\u003e  \n\n### Usage\n\nRead [documentation](http://xvik.github.io/gradle-quality-plugin)\n\n### Might also like\n\n* [mkdocs-plugin](https://github.com/xvik/gradle-mkdocs-plugin) - beautiful project documentation generation\n* [python-plugin](https://github.com/xvik/gradle-use-python-plugin) - use python modules in build\n* [pom-plugin](https://github.com/xvik/gradle-pom-plugin) - improves pom generation\n* [java-lib-plugin](https://github.com/xvik/gradle-java-lib-plugin) - avoid boilerplate for java or groovy library project\n* [github-info-plugin](https://github.com/xvik/gradle-github-info-plugin) - pre-configure common plugins with github related info\n* [animalsniffer-plugin](https://github.com/xvik/gradle-animalsniffer-plugin) - java compatibility checks\n* [java-library generator](https://github.com/xvik/generator-lib-java) - java library project generator\n\n---\n[![gradle plugin generator](http://img.shields.io/badge/Powered%20by-%20Gradle%20plugin%20generator-green.svg?style=flat-square)](https://github.com/xvik/generator-gradle-plugin)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fxvik%2Fgradle-quality-plugin","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fxvik%2Fgradle-quality-plugin","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fxvik%2Fgradle-quality-plugin/lists"}