{"id":21513244,"url":"https://github.com/patrickfav/checkstyle-config","last_synced_at":"2025-04-09T18:52:57.051Z","repository":{"id":57714979,"uuid":"181350695","full_name":"patrickfav/checkstyle-config","owner":"patrickfav","description":"Global checkstyle config to be reused in different projects. These include my own personal rules so your milage may vary.","archived":false,"fork":false,"pushed_at":"2023-02-12T21:47:53.000Z","size":324,"stargazers_count":5,"open_issues_count":0,"forks_count":1,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-03-23T20:51:18.515Z","etag":null,"topics":["checkstyle","checkstyle-plugin","configuration","java","maven"],"latest_commit_sha":null,"homepage":"https://favr.dev/opensource/checkstyle-config","language":null,"has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/patrickfav.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2019-04-14T18:19:48.000Z","updated_at":"2024-12-09T19:53:51.000Z","dependencies_parsed_at":"2022-09-02T22:01:13.758Z","dependency_job_id":null,"html_url":"https://github.com/patrickfav/checkstyle-config","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/patrickfav%2Fcheckstyle-config","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/patrickfav%2Fcheckstyle-config/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/patrickfav%2Fcheckstyle-config/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/patrickfav%2Fcheckstyle-config/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/patrickfav","download_url":"https://codeload.github.com/patrickfav/checkstyle-config/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248093273,"owners_count":21046661,"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","checkstyle-plugin","configuration","java","maven"],"created_at":"2024-11-23T22:55:08.087Z","updated_at":"2025-04-09T18:52:57.015Z","avatar_url":"https://github.com/patrickfav.png","language":null,"funding_links":[],"categories":[],"sub_categories":[],"readme":"# Common Checkstyle Config\n\n\u003cimg src=\"https://github.com/patrickfav/checkstyle-config/blob/master/misc/icon_sm.png?raw=true\" align=\"right\"\n     alt=\"Logo\" width=\"128\" height=\"128\"\u003e\n\nExternalized checkstyle configuration which can be used in other Maven projects.\n\n[![Maven Central](https://img.shields.io/maven-central/v/at.favre.lib/checkstyle-config)](https://mvnrepository.com/artifact/at.favre.lib/checkstyle-config)\n[![Build Status](https://travis-ci.com/patrickfav/checkstyle-config.svg?branch=master)](https://travis-ci.com/patrickfav/checkstyle-config)\n\n## Description\n\nThis is a hand-picked, incrementally improved checkstyle configuration. It is more on the liberal side as I believe tools should work for the user not the other way around. Code style is subjective and this one might not be for you.\n\n## Usage\n\nAdd this maven project as dependency to load the external checkstyle configuration. The name of the config xml is `checkstyle.xml`.\n\n```xml\n    \u003cbuild\u003e\n        \u003cplugins\u003e\n            \u003c!-- checkstyle --\u003e\n            \u003cplugin\u003e\n                \u003cgroupId\u003eorg.apache.maven.plugins\u003c/groupId\u003e\n                \u003cartifactId\u003emaven-checkstyle-plugin\u003c/artifactId\u003e\n                ...\n                \u003cdependencies\u003e\n                    ...\n                    \u003c!-- add this lib as dependency to load external checkstyle config --\u003e\n                    \u003cdependency\u003e\n                        \u003cgroupId\u003eat.favre.lib\u003c/groupId\u003e\n                        \u003cartifactId\u003echeckstyle-config\u003c/artifactId\u003e\n                        \u003cversion\u003e{latest_version}\u003c/version\u003e\n                    \u003c/dependency\u003e\n                \u003c/dependencies\u003e\n                \u003cconfiguration\u003e\n                    \u003cconfigLocation\u003echeckstyle.xml\u003c/configLocation\u003e\n                \u003c/configuration\u003e\n            \u003c/plugin\u003e\n            ...\n```\n\nSee this [stackoverflow.com post](https://stackoverflow.com/a/19690484/774398) for more info.\n\n### IDE Integration\n\n#### IntelliJ\n\nIf you are using the [checkstyle plugin](https://plugins.jetbrains.com/plugin/1065-checkstyle-idea) for [IntelliJ](https://www.jetbrains.com/idea/) (which you should). You will find a copy of the configuration in the `/target` folder called `checkstyle-checker.xml`. \n\n# License\n\nCopyright 2019 Patrick Favre-Bulle\n\nLicensed under the Apache License, Version 2.0 (the \"License\");\nyou may not use this file except in compliance with the License.\nYou may obtain a copy of the License at\n\n    http://www.apache.org/licenses/LICENSE-2.0\n\nUnless required by applicable law or agreed to in writing, software\ndistributed under the License is distributed on an \"AS IS\" BASIS,\nWITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\nSee the License for the specific language governing permissions and\nlimitations under the License.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpatrickfav%2Fcheckstyle-config","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpatrickfav%2Fcheckstyle-config","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpatrickfav%2Fcheckstyle-config/lists"}