{"id":46549556,"url":"https://github.com/sciencesakura/codenarc-maven-plugin","last_synced_at":"2026-03-07T03:05:22.433Z","repository":{"id":341358346,"uuid":"1169482380","full_name":"sciencesakura/codenarc-maven-plugin","owner":"sciencesakura","description":"A Maven plugin that integrates CodeNarc, a static analysis tool for Groovy code.","archived":false,"fork":false,"pushed_at":"2026-03-01T09:23:37.000Z","size":416,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2026-03-01T13:08:24.044Z","etag":null,"topics":["codenarc","maven-plugin"],"latest_commit_sha":null,"homepage":"https://www.sciencesakura.com/codenarc-maven-plugin/","language":"Groovy","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/sciencesakura.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,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2026-02-28T18:52:19.000Z","updated_at":"2026-03-01T10:24:48.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/sciencesakura/codenarc-maven-plugin","commit_stats":null,"previous_names":["sciencesakura/codenarc-maven-plugin"],"tags_count":null,"template":false,"template_full_name":null,"purl":"pkg:github/sciencesakura/codenarc-maven-plugin","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sciencesakura%2Fcodenarc-maven-plugin","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sciencesakura%2Fcodenarc-maven-plugin/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sciencesakura%2Fcodenarc-maven-plugin/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sciencesakura%2Fcodenarc-maven-plugin/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/sciencesakura","download_url":"https://codeload.github.com/sciencesakura/codenarc-maven-plugin/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sciencesakura%2Fcodenarc-maven-plugin/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29977985,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-03-01T16:35:47.903Z","status":"ssl_error","status_checked_at":"2026-03-01T16:35:44.899Z","response_time":124,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"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":["codenarc","maven-plugin"],"created_at":"2026-03-07T03:05:21.532Z","updated_at":"2026-03-07T03:05:22.417Z","avatar_url":"https://github.com/sciencesakura.png","language":"Groovy","funding_links":[],"categories":[],"sub_categories":[],"readme":"# CodeNarc Maven Plugin\n\n![](https://github.com/sciencesakura/codenarc-maven-plugin/actions/workflows/build.yaml/badge.svg) [![Maven Central](https://maven-badges.sml.io/sonatype-central/com.sciencesakura/codenarc-maven-plugin/badge.svg)](https://maven-badges.sml.io/sonatype-central/com.sciencesakura/codenarc-maven-plugin)\n\nA Maven plugin that integrates [CodeNarc](https://codenarc.org/), a static analysis tool for Groovy.\n\n## Requirements\n\n* Java 11+\n* Maven 3.6.3+\n\n## Installation and usage\n\nThe CodeNarc Maven Plugin is available on Maven Central. Add the `\u003cplugin\u003e` element to your `pom.xml` as shown below:\n\n```xml\n\u003cbuild\u003e\n  \u003cplugins\u003e\n    ...\n    \u003cplugin\u003e\n      \u003cgroupId\u003ecom.sciencesakura\u003c/groupId\u003e\n      \u003cartifactId\u003ecodenarc-maven-plugin\u003c/artifactId\u003e\n      \u003cversion\u003e1.0.0\u003c/version\u003e\n      \u003cexecutions\u003e\n        \u003cexecution\u003e\n          \u003c!-- by default, codenarc:check goal is bound to the verify phase --\u003e\n          \u003cgoals\u003e\n            \u003cgoal\u003echeck\u003c/goal\u003e\n          \u003c/goals\u003e\n        \u003c/execution\u003e\n      \u003c/executions\u003e\n    \u003c/plugin\u003e\n  \u003c/plugins\u003e\n\u003c/build\u003e\n```\n\n### Configuring rules\n\nBy default, the CodeNarc Maven Plugin looks for a ruleset file at `${project.basedir}/config/codenarc/codenarc.xml`. If the file does not exist, the plugin falls back to the built-in `rulesets/basic.xml` ruleset.\n\nYou can specify the ruleset by setting the `ruleset` parameter.\n\n```xml\n\u003cplugin\u003e\n  \u003cgroupId\u003ecom.sciencesakura\u003c/groupId\u003e\n  \u003cartifactId\u003ecodenarc-maven-plugin\u003c/artifactId\u003e\n  \u003cversion\u003e1.0.0\u003c/version\u003e\n  \u003cconfiguration\u003e\n    \u003c!-- specify the built-in rulesets --\u003e\n    \u003cruleset\u003erulesets/basic.xml,rulesets/groovyism.xml\u003c/ruleset\u003e\n    \u003c!-- or specify your own ruleset file --\u003e\n    \u003cruleset\u003e${project.basedir}/my-codenarc-ruleset.xml\u003c/ruleset\u003e\n  \u003c/configuration\u003e\n\u003c/plugin\u003e\n```\n\n### Override CodeNarc version\n\nYou can override the CodeNarc version by adding a dependency to the `\u003cplugin\u003e` element.\n\n**CAUTION**: The CodeNarc Maven Plugin is built against Groovy 4. Make sure to use a compatible CodeNarc version (e.g., `x.x.x-groovy-4.x`).\n\n```xml\n\u003cplugin\u003e\n  \u003cgroupId\u003ecom.sciencesakura\u003c/groupId\u003e\n  \u003cartifactId\u003ecodenarc-maven-plugin\u003c/artifactId\u003e\n  \u003cversion\u003e1.0.0\u003c/version\u003e\n  \u003cdependencies\u003e\n    \u003cdependency\u003e\n      \u003cgroupId\u003eorg.codenarc\u003c/groupId\u003e\n      \u003cartifactId\u003eCodeNarc\u003c/artifactId\u003e\n      \u003cversion\u003e${codenarc.version}\u003c/version\u003e\n    \u003c/dependency\u003e\n  \u003c/dependencies\u003e\n\u003c/plugin\u003e\n```\n\n### Other configurations\n\nThe following configuration parameters and their default values are available:\n\n```xml\n\u003cplugin\u003e\n  \u003cgroupId\u003ecom.sciencesakura\u003c/groupId\u003e\n  \u003cartifactId\u003ecodenarc-maven-plugin\u003c/artifactId\u003e\n  \u003cversion\u003e1.0.0\u003c/version\u003e\n  \u003cconfiguration\u003e\n    \u003csourceDirectories\u003e\u003c!-- ${project.compileSourceRoots} --\u003e\u003c/sourceDirectories\u003e\n    \u003ctestSourceDirectories\u003e\u003c!-- ${project.testCompileSourceRoots} --\u003e\u003c/testSourceDirectories\u003e\n    \u003cincludes\u003e\n      \u003cinclude\u003e**/*.groovy\u003c/include\u003e\n    \u003c/includes\u003e\n    \u003cexcludes\u003e\u003c/excludes\u003e\n    \u003cruleset\u003e${project.basedir}/config/codenarc/codenarc.xml\u003c/ruleset\u003e\n    \u003coutputFile\u003e${project.build.directory}/CodeNarcXmlReport.xml\u003c/outputFile\u003e\n    \u003cincludeTests\u003efalse\u003c/includeTests\u003e\n    \u003cconsoleOutput\u003efalse\u003c/consoleOutput\u003e\n    \u003cfailOnError\u003etrue\u003c/failOnError\u003e\n    \u003cfailOnViolation\u003etrue\u003c/failOnViolation\u003e\n  \u003c/configuration\u003e\n\u003c/plugin\u003e\n```\n\nFor more information, see the [Maven site](https://www.sciencesakura.com/codenarc-maven-plugin/plugin-info.html).\n\n## Acknowledgments\n\n* [gleclaire/codenarc-maven-plugin](https://github.com/gleclaire/codenarc-maven-plugin) - The original CodeNarc Maven Plugin.\n\n## License\n\nThis plugin is licensed under the Apache License 2.0.\n\nCopyright (c) 2026 sciencesakura.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsciencesakura%2Fcodenarc-maven-plugin","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsciencesakura%2Fcodenarc-maven-plugin","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsciencesakura%2Fcodenarc-maven-plugin/lists"}