{"id":18414915,"url":"https://github.com/xerial/sbt-jcheckstyle","last_synced_at":"2025-04-07T11:33:02.832Z","repository":{"id":33889811,"uuid":"37602564","full_name":"xerial/sbt-jcheckstyle","owner":"xerial","description":"A sbt plugin for checking Java code styles","archived":false,"fork":false,"pushed_at":"2017-12-04T05:49:36.000Z","size":54,"stargazers_count":6,"open_issues_count":1,"forks_count":5,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-04-02T04:56:54.764Z","etag":null,"topics":["checkstyle","java","sbt-plugin","scala"],"latest_commit_sha":null,"homepage":null,"language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":"cloudflare/complainer","license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/xerial.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2015-06-17T15:12:30.000Z","updated_at":"2021-10-31T18:24:07.000Z","dependencies_parsed_at":"2022-08-17T20:15:22.679Z","dependency_job_id":null,"html_url":"https://github.com/xerial/sbt-jcheckstyle","commit_stats":null,"previous_names":[],"tags_count":7,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/xerial%2Fsbt-jcheckstyle","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/xerial%2Fsbt-jcheckstyle/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/xerial%2Fsbt-jcheckstyle/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/xerial%2Fsbt-jcheckstyle/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/xerial","download_url":"https://codeload.github.com/xerial/sbt-jcheckstyle/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247645244,"owners_count":20972434,"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","java","sbt-plugin","scala"],"created_at":"2024-11-06T03:52:40.631Z","updated_at":"2025-04-07T11:33:01.722Z","avatar_url":"https://github.com/xerial.png","language":"Shell","funding_links":[],"categories":[],"sub_categories":[],"readme":"# sbt-jcheckstyle\nA sbt plugin for checking Java code styles with [checkstyle](http://checkstyle.sourceforge.net/).\n\n## Usage\n [![Maven Central](https://maven-badges.herokuapp.com/maven-central/org.xerial.sbt/sbt-jcheckstyle/badge.svg)](https://maven-badges.herokuapp.com/maven-central/org.xerial.sbt/sbt-jcheckstyle)\n\nAdd sbt-jcheckstyle plugin to your `project/plugins.sbt`, then run `jcheckStyle` task:\n**project/plugins.sbt**\n```\n// For sbt-0.13.x and 1.0.x\naddSbtPlugin(\"org.xerial.sbt\" % \"sbt-jcheckstyle\" % \"(version)\")\n```\n\n```\n# Check code style of java codes\n$ sbt jcheckStyle\n\n# Check code style of java test codes\n$ sbt test:jcheckStyle\n```\n\n### Run style check before compilation\n\nAdd the following sbt settings:\n```\ncompile in Compile \u003c\u003c= (compile in Compile) dependsOn (jcheckStyle in Compile)\ncompile in Test \u003c\u003c= (compile in Test) dependsOn (jcheckStyle in Test)\n```\n\n## Style configuration\n\nTo configure Java code style, edit `jcheckStyleConfig` setting. In default, it uses Google's Java style:\n\n```\njcheckStyleConfig := \"google\" // or \"facebook\", \"sun\" or path to your checkstyle.xml\n```\n\nHere is the list of the available styles:\n\n* `google`:  [Google's Java Style](https://google.github.io/styleguide/javaguide.html). [checkstyle.xml](https://github.com/checkstyle/checkstyle/blob/master/src/main/resources/google_checks.xml)\n  * [IntelliJ setting file](https://github.com/google/styleguide/blob/gh-pages/intellij-java-google-style.xml)\n* `facebook` : [Code style used in Facebook Presto](https://github.com/facebook/presto/blob/master/src/checkstyle/checks.xml)\n  * [IntelliJ setting file](https://raw.githubusercontent.com/airlift/codestyle/master/IntelliJIdea13/Airlift.xml)\n* `sun`: [Code Conventions for the Java TM Programming Language](http://www.oracle.com/technetwork/java/codeconvtoc-136057.html).\n[checkstyle.xml](https://github.com/checkstyle/checkstyle/blob/master/src/main/resources/sun_checks.xml)\n\nOr you can specify your own configuration:\n```\njcheckStyleConfig := \"checkstyle.xml\"\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fxerial%2Fsbt-jcheckstyle","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fxerial%2Fsbt-jcheckstyle","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fxerial%2Fsbt-jcheckstyle/lists"}