{"id":20837337,"url":"https://github.com/matthewstyler/checkstyle-suppression-generator","last_synced_at":"2026-05-01T20:31:31.706Z","repository":{"id":213455683,"uuid":"734170642","full_name":"matthewstyler/checkstyle-suppression-generator","owner":"matthewstyler","description":"Generate a Java checkstyle suppressions.xml file from a checkstyle:check output.","archived":false,"fork":false,"pushed_at":"2024-04-08T22:55:01.000Z","size":32,"stargazers_count":1,"open_issues_count":2,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-12-13T01:33:16.448Z","etag":null,"topics":["checkstyle","checkstyle-checks","checkstyle-files","checkstyle-maven","checkstyle-plugin","checkstyle-reports","checkstyle-rules","checkstyle-sonar-plugin","checkstyle-xml-report","checkstyles","java","maven","static-analysis"],"latest_commit_sha":null,"homepage":"https://rubygems.org/gems/checkstyle-suppression-generator","language":"Ruby","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/matthewstyler.png","metadata":{"files":{"readme":"README.md","changelog":null,"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":"2023-12-21T03:27:29.000Z","updated_at":"2024-08-31T10:45:35.000Z","dependencies_parsed_at":null,"dependency_job_id":"80b7c7e2-84aa-46f6-a8a0-3908dea56286","html_url":"https://github.com/matthewstyler/checkstyle-suppression-generator","commit_stats":null,"previous_names":["matthewstyler/checkstyle-suppression-generator"],"tags_count":2,"template":false,"template_full_name":null,"purl":"pkg:github/matthewstyler/checkstyle-suppression-generator","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/matthewstyler%2Fcheckstyle-suppression-generator","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/matthewstyler%2Fcheckstyle-suppression-generator/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/matthewstyler%2Fcheckstyle-suppression-generator/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/matthewstyler%2Fcheckstyle-suppression-generator/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/matthewstyler","download_url":"https://codeload.github.com/matthewstyler/checkstyle-suppression-generator/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/matthewstyler%2Fcheckstyle-suppression-generator/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":32512662,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-30T13:12:12.517Z","status":"online","status_checked_at":"2026-05-01T02:00:05.856Z","response_time":64,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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","checkstyle-checks","checkstyle-files","checkstyle-maven","checkstyle-plugin","checkstyle-reports","checkstyle-rules","checkstyle-sonar-plugin","checkstyle-xml-report","checkstyles","java","maven","static-analysis"],"created_at":"2024-11-18T01:07:05.574Z","updated_at":"2026-05-01T20:31:31.657Z","avatar_url":"https://github.com/matthewstyler.png","language":"Ruby","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Checkstyle Suppression Generator\n[![Gem Version](https://badge.fury.io/rb/checkstyle-suppression-generator.svg)](https://badge.fury.io/rb/checkstyle-suppression-generator)\n![CI Status](https://github.com/matthewstyler/ruby-perlin-2D-map-generator/actions/workflows/main.yml/badge.svg)\n![CodeQL](https://github.com/matthewstyler/checkstyle-suppression-generator/workflows/CodeQL/badge.svg)\n\u003ca href=\"https://codeclimate.com/github/matthewstyler/checkstyle-suppression-generator/test_coverage\"\u003e\u003cimg src=\"https://api.codeclimate.com/v1/badges/b63e2b943acbfd970fae/test_coverage\" /\u003e\u003c/a\u003e\n\u003ca href=\"https://codeclimate.com/github/matthewstyler/checkstyle-suppression-generator/maintainability\"\u003e\u003cimg src=\"https://api.codeclimate.com/v1/badges/b63e2b943acbfd970fae/maintainability\" /\u003e\u003c/a\u003e\n\nA gem that takes as input the output of a maven checkstyle plugin checkstyle:check goal and generates a suppressions.xml file.\n\n# Installation\n\n### Bundler\n\n```ruby\ngem 'checkstyle-suppression-generator'\n```\n\n### Manual\n\n```sh\ngem install checkstyle-suppression-generator\n```\n\n## Usage\n\nExample Input:\n```sh\n[INFO] Scanning for projects...\n[INFO] ------------------------------------------------------------------------\n[INFO] Reactor Build Order:\n[INFO] \n[INFO] my-project                                                         [jar]\n[INFO]  ------------------\u003c com.my-project:my-project \u003e------------------\n[INFO] Building my-project 0.0.1-SNAPSHOT                          [1/1]\n[INFO]   from my-project/pom.xml\n[INFO] --------------------------------[ jar ]---------------------------------\n[INFO] \n[INFO] --- checkstyle:3.3.0:check (default-cli) @ my-project ---\n[WARNING] src/main/java/com/test/DEF.java:[147,4] (coding) OverloadMethodsDeclarationOrder: All overloaded methods should be placed next to each other. Placing non-overloaded methods in between overloaded methods with the same type is a violation. Previous overloaded method located at line '119'.\n[WARNING] src/main/java/com/test/ABC.java:[26,11] (sizes) ParameterNumber: More than 7 parameters (found 9).\n[WARNING] src/main/java/com/test/ABC.java:[103,4] (coding) ReturnCount: Return count is 6 (max allowed for non-void methods/lambdas is 4).\n[WARNING] src/main/java/com/test/ABC.java:[103,4] (metrics) NPathComplexity: NPath Complexity is 720 (max allowed is 200).\n[INFO] ------------------------------------------------------------------------\n[INFO] Reactor Summary for my-project 0.0.1-SNAPSHOT:\n[INFO] \n[INFO] my-project .................................. FAILURE [  1.957 s]\n[INFO] ------------------------------------------------------------------------\n[INFO] BUILD FAILURE\n[INFO] ------------------------------------------------------------------------\n[INFO] Total time:  2.841 s\n[INFO] Finished at: 2023-12-20T16:31:35-05:00\n[INFO] ------------------------------------------------------------------------\n[ERROR] Failed to execute goal org.apache.maven.plugins:maven-checkstyle-plugin:3.3.0:check (default-cli) on project my-project: You have 4 Checkstyle violations. -\u003e [Help 1]\n[ERROR] \n[ERROR] To see the full stack trace of the errors, re-run Maven with the -e switch.\n[ERROR] Re-run Maven using the -X switch to enable full debug logging.\n[ERROR] \n[ERROR] For more information about the errors and possible solutions, please read the following articles:\n[ERROR] [Help 1] http://cwiki.apache.org/confluence/display/MAVEN/MojoFailureException\n[ERROR] \n[ERROR] After correcting the problems, you can resume the build with the command\n[ERROR]   mvn \u003cargs\u003e -rf :my-project\n\n```\n\nOutput:\n\n```xml\n\u003c?xml version=\"1.0\"?\u003e\n\u003c!DOCTYPE suppressions PUBLIC \"-//Checkstyle//DTD SuppressionFilter Configuration 1.2//EN\"\n      \"https://checkstyle.org/dtds/suppressions_1_2.dtd\"\u003e\n\n\u003csuppressions\u003e\n\n\t\u003csuppress checks=\"OverloadMethodsDeclarationOrder\" files=\"src/main/java/com/test/DEF.java\"/\u003e\n\t\u003csuppress checks=\"ParameterNumber\" files=\"src/main/java/com/test/ABC.java\"/\u003e\n\t\u003csuppress checks=\"ReturnCount\" files=\"src/main/java/com/test/ABC.java\"/\u003e\n\t\u003csuppress checks=\"NPathComplexity\" files=\"src/main/java/com/test/ABC.java\"/\u003e\n\n\u003c/suppressions\u003e\n\n```\n\n\n## Command Line Usage\n```sh\nUsage: checkstyle-suppression-generator command [OPTIONS]\n       CHECKSTYLE_OUTPUT_FILE(STRING) [O=O]\n\nGenerate a Java checkstyle suppressions.xml file from a checkstyle:check output.\n\n\nArguments:\n  CHECKSTYLE_OUTPUT_FILE(STRING)  Output from checkstyle:check goal\n\nKeywords:\n  O=O  Name of the suppressions file to be generated (default\n       \"suppressions.xml\")\n\nOptions:\n  -h, --help  Print usage\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmatthewstyler%2Fcheckstyle-suppression-generator","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmatthewstyler%2Fcheckstyle-suppression-generator","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmatthewstyler%2Fcheckstyle-suppression-generator/lists"}