{"id":21414434,"url":"https://github.com/valery1707/kaitai-gradle-plugin","last_synced_at":"2025-07-14T03:32:10.105Z","repository":{"id":57736879,"uuid":"163518368","full_name":"valery1707/kaitai-gradle-plugin","owner":"valery1707","description":"Gradle plugin for Kaitai: declarative language to generate binary data parsers","archived":false,"fork":false,"pushed_at":"2022-09-27T11:50:48.000Z","size":295,"stargazers_count":6,"open_issues_count":3,"forks_count":4,"subscribers_count":3,"default_branch":"master","last_synced_at":"2023-07-05T04:15:12.567Z","etag":null,"topics":["gradle-plugin","java","kaitai","kaitai-struct"],"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":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2018-12-29T14:44:32.000Z","updated_at":"2023-02-16T13:39:34.000Z","dependencies_parsed_at":"2022-08-24T02:51:06.381Z","dependency_job_id":null,"html_url":"https://github.com/valery1707/kaitai-gradle-plugin","commit_stats":null,"previous_names":[],"tags_count":0,"template":null,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/valery1707%2Fkaitai-gradle-plugin","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/valery1707%2Fkaitai-gradle-plugin/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/valery1707%2Fkaitai-gradle-plugin/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/valery1707%2Fkaitai-gradle-plugin/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/valery1707","download_url":"https://codeload.github.com/valery1707/kaitai-gradle-plugin/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":225945093,"owners_count":17549503,"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":["gradle-plugin","java","kaitai","kaitai-struct"],"created_at":"2024-11-22T18:29:33.022Z","updated_at":"2024-11-22T18:29:33.784Z","avatar_url":"https://github.com/valery1707.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"readme":"[![Maven Central](https://maven-badges.herokuapp.com/maven-central/name.valery1707.kaitai/kaitai-gradle-plugin/badge.svg)](https://maven-badges.herokuapp.com/maven-central/name.valery1707.kaitai/kaitai-gradle-plugin)\n[![Gradle Plugin Portal](https://img.shields.io/maven-metadata/v/https/plugins.gradle.org/m2/name/valery1707/kaitai/name.valery1707.kaitai.gradle.plugin/maven-metadata.xml.svg?colorB=007ec6\u0026label=gradle-plugin)](https://plugins.gradle.org/plugin/name.valery1707.kaitai)\n[![License](https://img.shields.io/github/license/valery1707/kaitai-gradle-plugin.svg)](https://opensource.org/licenses/MIT)\n\n[![Build Status](https://travis-ci.org/valery1707/kaitai-gradle-plugin.svg?branch=master)](https://travis-ci.org/valery1707/kaitai-gradle-plugin)\n[![CircleCI](https://circleci.com/gh/valery1707/kaitai-gradle-plugin/tree/master.svg?style=svg)](https://circleci.com/gh/valery1707/kaitai-gradle-plugin/tree/master)\n\nGradle plugin for http://kaitai.io/\n\n# Usage\n\n## Minimum configuration\n\n* Add plugin dependency\n```groovy\nbuildscript {\n    repositories {\n        jcenter()\n    }\n    dependencies {\n        classpath(\"name.valery1707.kaitai:kaitai-gradle-plugin:0.1.2\")\n    }\n}\n```\n* Apply plugin\n```groovy\napply plugin: 'name.valery1707.kaitai'\n```\n* Add Kaitai compile dependencies\n```groovy\nrepositories {\n    jcenter()\n}\ndependencies {\n    implementation(\"io.kaitai:kaitai-struct-runtime:0.8\")\n}\n```\n* Configure plugin (all params are optional)\n```groovy\nkaitai {\n    packageName = 'preferred.package.name'\n}\n```\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| 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.1 | Timeout for execution operations.\u003cbr\u003e\u003cbr\u003e**Default**: `5000` |\n| fromFileClass   | String       | 0.1.1 | Classname with custom KaitaiStream implementations for static builder `fromFile(...)`|\n| opaqueTypes     | Boolean      | 0.1.1 | Allow use opaque (external) types in ksy. See more in [documentation](http://doc.kaitai.io/user_guide.html#opaque-types).|\n\n# Developments\nFor debug on integration tests you must previously call some gradle tasks: `jar assemble pluginUnderTestMetadata`\n\nDeploy new version manually:\n1. Update `version` inside this files:\n    * `build.gradle.kts`: from `0.1.3-SNAPSHOT` into `0.1.3`\n    * `README.md`: from `0.1.2` into `0.1.3`\n    * `CHANGELOG.md`: create new block for `0.1.3`\n1. Commit with `Prepare release 0.1.3`\n1. Prepare `gradle.properties` from `gradle-template.properties`\n1. Run `./gradlew clean build uploadArchives`\n1. Open [Staging Repository](https://oss.sonatype.org/#stagingRepositories)\n1. Search for `namevalery1707` and select founded\n1. Check content on tab `Content`\n1. Press `Close` with comment `Release version 0.1.3`\n1. Wait for operation:\n1. On failure: \n    * Check reason on tab `Activity`\n    * Press `Drop` with some comment\n1. Press `Release` with comment `Release version 0.1.3`\n1. Check exists for [Gradle API keys](https://plugins.gradle.org/u/valery1707) in local configuration\n1. Run `./gradlew publishPlugins`\n1. Update `version` into `0.1.4-SNAPSHOT` and commit with `Prepare for next development iteration`\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvalery1707%2Fkaitai-gradle-plugin","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fvalery1707%2Fkaitai-gradle-plugin","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvalery1707%2Fkaitai-gradle-plugin/lists"}