{"id":21414432,"url":"https://github.com/valery1707/kaitai-maven-plugin","last_synced_at":"2025-07-14T03:32:10.079Z","repository":{"id":41070564,"uuid":"127448742","full_name":"valery1707/kaitai-maven-plugin","owner":"valery1707","description":"Maven plugin for Kaitai: declarative language to generate binary data parsers","archived":false,"fork":false,"pushed_at":"2024-01-05T18:42:29.000Z","size":499,"stargazers_count":12,"open_issues_count":20,"forks_count":8,"subscribers_count":5,"default_branch":"master","last_synced_at":"2024-01-05T19:44:06.798Z","etag":null,"topics":["java","kaitai","kaitai-struct","maven-plugin"],"latest_commit_sha":null,"homepage":"https://kaitai.io/","language":"Java","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/valery1707.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":".github/FUNDING.yml","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},"funding":{"issuehunt":"valery1707","ko_fi":"valery1707","liberapay":"valery1707"}},"created_at":"2018-03-30T16:21:06.000Z","updated_at":"2023-08-07T01:47:19.000Z","dependencies_parsed_at":"2023-12-01T15:44:02.782Z","dependency_job_id":null,"html_url":"https://github.com/valery1707/kaitai-maven-plugin","commit_stats":null,"previous_names":[],"tags_count":8,"template":null,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/valery1707%2Fkaitai-maven-plugin","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/valery1707%2Fkaitai-maven-plugin/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/valery1707%2Fkaitai-maven-plugin/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/valery1707%2Fkaitai-maven-plugin/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/valery1707","download_url":"https://codeload.github.com/valery1707/kaitai-maven-plugin/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":225945086,"owners_count":17549502,"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":["java","kaitai","kaitai-struct","maven-plugin"],"created_at":"2024-11-22T18:29:32.317Z","updated_at":"2024-11-22T18:29:32.893Z","avatar_url":"https://github.com/valery1707.png","language":"Java","funding_links":["https://issuehunt.io/r/valery1707","https://ko-fi.com/valery1707","https://liberapay.com/valery1707"],"categories":[],"sub_categories":[],"readme":"[![Maven Central](https://maven-badges.herokuapp.com/maven-central/name.valery1707.kaitai/kaitai-maven-plugin/badge.svg)](https://maven-badges.herokuapp.com/maven-central/name.valery1707.kaitai/kaitai-maven-plugin)\n[![License](https://img.shields.io/github/license/valery1707/kaitai-maven-plugin.svg)](http://opensource.org/licenses/MIT)\n\n[![Build Status](https://travis-ci.org/valery1707/kaitai-maven-plugin.svg?branch=master)](https://travis-ci.org/valery1707/kaitai-maven-plugin)\n[![Build status](https://ci.appveyor.com/api/projects/status/bbvjf5q9faru09xp/branch/master?svg=true)](https://ci.appveyor.com/project/valery1707/kaitai-maven-plugin/branch/master)\n[![CircleCI](https://circleci.com/gh/valery1707/kaitai-maven-plugin/tree/master.svg?style=svg)](https://circleci.com/gh/valery1707/kaitai-maven-plugin/tree/master)\n[![GitHub Actions CI Status](https://github.com/valery1707/kaitai-maven-plugin/actions/workflows/check.yml/badge.svg)](https://github.com/valery1707/kaitai-maven-plugin/actions/workflows/check.yml)\n\n[![LGTM total alerts](https://img.shields.io/lgtm/alerts/g/valery1707/kaitai-maven-plugin.svg?logo=lgtm\u0026logoWidth=18)](https://lgtm.com/projects/g/valery1707/kaitai-maven-plugin/alerts/)\n[![LGTM language grade: Java](https://img.shields.io/lgtm/grade/java/g/valery1707/kaitai-maven-plugin.svg?logo=lgtm\u0026logoWidth=18)](https://lgtm.com/projects/g/valery1707/kaitai-maven-plugin/context:java)\n\n[![Scc Count Badge](https://sloc.xyz/github/valery1707/kaitai-maven-plugin/?category=code)](https://github.com/valery1707/kaitai-maven-plugin/)\n[![Scc Count Badge](https://sloc.xyz/github/valery1707/kaitai-maven-plugin/?category=blanks)](https://github.com/valery1707/kaitai-maven-plugin/)\n[![Scc Count Badge](https://sloc.xyz/github/valery1707/kaitai-maven-plugin/?category=lines)](https://github.com/valery1707/kaitai-maven-plugin/)\n[![Scc Count Badge](https://sloc.xyz/github/valery1707/kaitai-maven-plugin/?category=comments)](https://github.com/valery1707/kaitai-maven-plugin/)\n[![Scc Count Badge](https://sloc.xyz/github/valery1707/kaitai-maven-plugin/?category=cocomo)](https://github.com/valery1707/kaitai-maven-plugin/)\n\n[![DevOps By Rultor.com](http://www.rultor.com/b/valery1707/kaitai-maven-plugin)](http://www.rultor.com/p/valery1707/kaitai-maven-plugin)\n\nMaven plugin for [Kaitai](http://kaitai.io/): declarative language to generate binary data parsers.\n\nThis plugin has the following goals:\n* `kaitai:generate`: generate java-sources for kaitai-templates\n\n## Usage flow\n\n1. Add last version of [kaitai-maven-plugin](https://maven-badges.herokuapp.com/maven-central/name.valery1707.kaitai/kaitai-maven-plugin) into plugins section\n1. Configure plugin execution with `\u003cexecutions\u003e\u003cexecution\u003e\u003cid\u003egenerate\u003c/id\u003e\u003cgoals\u003e\u003cgoal\u003egenerate\u003c/goal\u003e\u003c/goals\u003e\u003c/execution\u003e\u003c/executions\u003e`\n1. Add last version of [kaitai-struct-runtime](https://maven-badges.herokuapp.com/maven-central/io.kaitai/kaitai-struct-runtime) into compile dependencies\n1. Add some [kaitai templates](http://formats.kaitai.io/) into `src/main/resources/kaitai`\n1. *(Optionally)* Modify [plugin configuration](#plugin-parameters)\n1. Build project with goal `package` or manually generate sources with goal `kaitai:generate`\n\n## Working examples\n\nSee [kaitai-java-demo](https://github.com/valery1707/kaitai-java-demo).\n\n## Plugin parameters\n\n| Name            | Type         | Since | Description                                                                                                             |\n|-----------------|--------------|-------|-------------------------------------------------------------------------------------------------------------------------|\n| skip            | boolean      | 0.1.0 | Skip plugin execution (don't read/validate any files, don't generate any java types).\u003cbr\u003e\u003cbr\u003e**Default**: `false`       |\n| url             | java.net.URL | 0.1.0 | Direct link onto [KaiTai universal zip archive](http://kaitai.io/#download).\u003cbr\u003e\u003cbr\u003e**Default**: Detected from version  |\n| version         | String       | 0.1.0 | Version of [KaiTai](http://kaitai.io/#download) library.\u003cbr\u003e\u003cbr\u003e**Default**: `0.8`                                      |\n| cacheDir        | java.io.File | 0.1.0 | Cache directory for download KaiTai library.\u003cbr\u003e\u003cbr\u003e**Default**: `build/tmp/kaitai-cache`                               |\n| sourceDirectory | java.io.File | 0.1.0 | Source directory with [Kaitai Struct language](http://formats.kaitai.io/) files.\u003cbr\u003e\u003cbr\u003e**Default**: src/main/resources/kaitai |\n| includes        | String[]     | 0.1.0 | Include wildcard pattern list.\u003cbr\u003e\u003cbr\u003e**Default**: [\"*.ksy\"]                                                            |\n| excludes        | String[]     | 0.1.0 | Exclude wildcard pattern list.\u003cbr\u003e\u003cbr\u003e**Default**: []                                                                   |\n| output          | java.io.File | 0.1.0 | Target directory for generated Java source files.\u003cbr\u003e\u003cbr\u003e**Default**: `build/generated/kaitai`                          |\n| exactOutput     | Boolean      | 0.1.5 | Move root of packages directory structure exact inside configured output path and remove `src` item.\u003cbr\u003e\u003cbr\u003e**Default**: `false`|\n| packageName     | String       | 0.1.0 | Target package for generated Java source files.\u003cbr\u003e\u003cbr\u003e**Default**: Trying to get project's group or `kaitai` otherwise |\n| executionTimeout| Long         | 0.1.3 | Timeout for execution operations.\u003cbr\u003e\u003cbr\u003e**Default**: `5000` |\n| fromFileClass   | String       | 0.1.3 | Classname with custom KaitaiStream implementations for static builder `fromFile(...)`|\n| opaqueTypes     | Boolean      | 0.1.3 | Allow use opaque (external) types in ksy. See more in [documentation](http://doc.kaitai.io/user_guide.html#opaque-types).|\n| noVersionCheck  | Boolean      | 0.1.6 | Allow to disable Java version check. For non-Windows only.\u003cbr\u003e\u003cbr\u003e**Default**: `false`       |\n| noAutoRead      | Boolean      | 0.1.7 | Allow to disable auto-running `_read` in constructor \u003cbr\u003e\u003cbr\u003e**Default**: `false`       |\n\n### Useful commands\n\n* Execute integration test: `./mvnw clean verify -P run-its`\n* Execute checkstyle (report will be stored in `target/site/checkstyle.html`): `./mvnw checkstyle:checkstyle`\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvalery1707%2Fkaitai-maven-plugin","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fvalery1707%2Fkaitai-maven-plugin","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvalery1707%2Fkaitai-maven-plugin/lists"}