Add `TemplateString` and `Placeholder` by alexander-yevsyukov · Pull Request #927 · SpineEventEngine/base-libraries

alexander-yevsyukov · 2026-05-15T17:51:55Z

This PR adds Protobuf-based TemplateString type and relevant Placeholder interface to io.spine.string package of Spine Base. Previously, these types were adopted in Validation, and we want these types be available to other purposes related to working with formatted messages. Releated general extensions to TemplateString were added too.

Other notable changes

config was updated.

Introduces `spine.string.TemplateString` Protobuf message together with the `Placeholder` interface and `TemplateString` Kotlin extensions in `io.spine.string` package. These are general-purpose string manipulation utilities adapted from the Validation library. Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>

Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>

Copilot

Pull request overview

This PR introduces a Protobuf-based TemplateString message and a companion Placeholder Kotlin interface in io.spine.string, plus extension functions (format, formatUnsafe, checkPlaceholdersHasValue, extractPlaceholders) and tests. Alongside it, the PR pulls in a sizable config refresh covering Gradle 9.5.1 wrapper, dependency version bumps (Compiler, ToolBase, Time, TestLib, Logging, CoreJvm, Validation, Base, Dokka 2.2.0, Kotest 6.1.11, Shadow 9.4.1), publishing/POM/license-report relocation under docs/dependencies/, refactored ShadowJar and SpinePublishing setup, regenerated pom.xml, and many .agents skill additions/updates.

Changes:

Add TemplateString proto + Placeholder interface and Kotlin extensions with tests.
Bump project version to 2.0.0-SNAPSHOT.388 and refresh config (dependencies, Gradle wrapper, publishing/report tooling, agent skills).
Move generated dependency reports under docs/dependencies/ and adjust LicenseReporter/PomGenerator accordingly.

Reviewed changes

Copilot reviewed 64 out of 68 changed files in this pull request and generated 6 comments.

Show a summary per file

File	Description
version.gradle.kts	Bump to SNAPSHOT.388.
gradlew, gradlew.bat, gradle/wrapper/gradle-wrapper.properties	Update wrapper to 9.5.1 with regenerated scripts.
docs/dependencies/pom.xml	New generated POM under the relocated reports directory.
buildSrc/src/test/kotlin/io/spine/gradle/report/license/DependencyReportOutputTest.kt	New tests for the relocated report outputs.
buildSrc/src/test/kotlin/io/spine/gradle/publish/SpinePublishingTest.kt	Use the new `extensionName` constant.
buildSrc/src/test/kotlin/io/spine/gradle/docs/UpdatePluginVersionTest.kt	Add `@DisplayName`, drop unused import.
buildSrc/src/main/kotlin/kmp-module.gradle.kts, jvm-module.gradle.kts	Force Jackson/Kotlin BOM in resolution strategy; drop Kotest datatest.
buildSrc/src/main/kotlin/io/spine/gradle/report/pom/PomGenerator.kt	Write `pom.xml` to `docs/dependencies`.
buildSrc/src/main/kotlin/io/spine/gradle/report/license/Paths.kt, LicenseReporter.kt	New `outputFile` helper writing reports under `docs/dependencies`.
buildSrc/src/main/kotlin/io/spine/gradle/publish/SpinePublishing.kt	Expose `extensionName`; tweak `artifactId` builder.
buildSrc/src/main/kotlin/io/spine/gradle/publish/PublicationHandler.kt	New `artifactId` derivation handling KMP suffixes; license `distribution` set to `repo`.
buildSrc/src/main/kotlin/io/spine/gradle/publish/ShadowJarExts.kt	Replace service-file enumeration with `setup()` + dedup logic.
buildSrc/src/main/kotlin/io/spine/gradle/ProjectExtensions.kt	Doc tweak.
buildSrc/src/main/kotlin/io/spine/gradle/github/pages/UpdateGitHubPages.kt	Remove TODO and dead commented block.
buildSrc/src/main/kotlin/io/spine/gradle/docs/UpdatePluginVersion.kt	Escape plugin id in regex.
buildSrc/src/main/kotlin/io/spine/dependency/test/Kotest.kt	Bump to 6.1.11; restructure deprecations; add `common`.
buildSrc/src/main/kotlin/io/spine/dependency/local/*.kt	Bump local Spine dependency versions and align artifact names.
buildSrc/src/main/kotlin/io/spine/dependency/lib/JetBrainsAnnotations.kt	Replace prior `LicenseReport` declaration with new `JetBrainsAnnotations` object.
buildSrc/src/main/kotlin/io/spine/dependency/build/Dokka.kt	Bump to 2.2.0; use `Spine.toolsGroup`.
buildSrc/build.gradle.kts	Drop license-report plugin from buildSrc; bump Dokka, Shadow, license-report; add JUnit/Kotest test versions.
base/src/test/kotlin/io/spine/string/TemplateStringExtsSpec.kt	New tests for `TemplateString` extensions.
base/src/main/proto/spine/string/template_string.proto	New `TemplateString` Protobuf type.
base/src/main/kotlin/io/spine/string/TemplateStringExts.kt	New Kotlin extensions (`format`, `formatUnsafe`, `checkPlaceholdersHasValue`, `extractPlaceholders`).
base/src/main/kotlin/io/spine/string/Placeholder.kt	New `Placeholder` interface.
.junie/, .idea/, .gitignore, .github/workflows/, .agents/*	Misc agent and CI/workflow renames; add new `.agents` skills (`bump-version`, `bump-gradle`, `move-files`, `update-copyright`, `java-to-kotlin`).

Files not reviewed (1)

.idea/inspectionProfiles/Project_Default.xml: Language not supported

Comments suppressed due to low confidence (1)

buildSrc/src/main/kotlin/io/spine/dependency/lib/JetBrainsAnnotations.kt:42

Reusing a single file (JetBrainsAnnotations.kt) to wholesale replace the previous LicenseReport declaration is confusing in history: the old object lived in package io.spine.dependency.build and the new one lives in io.spine.dependency.lib. While the old LicenseReport is no longer referenced, mixing a delete-and-rename with a package change in the same file makes the diff harder to review and breaks git-blame/log tracking. Consider deleting LicenseReport.kt and adding JetBrainsAnnotations.kt as a separate new file under io/spine/dependency/lib/.

chatgpt-codex-connector

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: a2f47a4168

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

Open a pull request for review
Mark a draft as ready
Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Copilot

Pull request overview

Copilot reviewed 65 out of 69 changed files in this pull request and generated 2 comments.

Files not reviewed (1)

.idea/inspectionProfiles/Project_Default.xml: Language not supported

Copilot

Pull request overview

Copilot reviewed 65 out of 69 changed files in this pull request and generated 3 comments.

Files not reviewed (1)

.idea/inspectionProfiles/Project_Default.xml: Language not supported

Comments suppressed due to low confidence (1)

buildSrc/src/main/kotlin/io/spine/dependency/lib/JetBrainsAnnotations.kt:42

The file declares package io.spine.dependency.lib, but it lives under io/spine/dependency/lib/JetBrainsAnnotations.kt only if it was moved. The diff header shows JetBrainsAnnotations.kt, but the previous content in the diff was for LicenseReport in io.spine.dependency.build — please verify the file path matches the new package and that the previous LicenseReport definitions have been preserved (or intentionally removed) elsewhere, since the diff is effectively replacing one type with another in the same physical file.

+//
+// Example usage:
+//     template_string = "My dog's name is ${dog.name}."
+//     placeholder_values = { "dog.name": "Fido" }


+    <version>null</version>
+    <scope>compile</scope>
+  </dependency>
+  <dependency>
+    <groupId>com.fasterxml.jackson.dataformat</groupId>
+    <artifactId>jackson-dataformat-yaml</artifactId>
+    <version>null</version>
+    <scope>compile</scope>
+  </dependency>
+  <dependency>
+    <groupId>com.fasterxml.jackson.datatype</groupId>
+    <artifactId>jackson-datatype-guava</artifactId>
+    <version>null</version>
+    <scope>compile</scope>
+  </dependency>
+  <dependency>
+    <groupId>com.fasterxml.jackson.datatype</groupId>
+    <artifactId>jackson-datatype-jdk8</artifactId>
+    <version>null</version>
+    <scope>compile</scope>
+  </dependency>
+  <dependency>
+    <groupId>com.fasterxml.jackson.datatype</groupId>
+    <artifactId>jackson-datatype-jsr310</artifactId>
+    <version>null</version>
+    <scope>compile</scope>
+  </dependency>
+  <dependency>
+    <groupId>com.google.guava</groupId>
+    <artifactId>guava</artifactId>
+    <version>33.5.0-jre</version>
+    <scope>compile</scope>
+  </dependency>
+  <dependency>
+    <groupId>com.google.protobuf</groupId>
+    <artifactId>protobuf-java</artifactId>
+    <version>4.34.1</version>
+    <scope>compile</scope>
+  </dependency>
+  <dependency>
+    <groupId>com.google.protobuf</groupId>
+    <artifactId>protobuf-java-util</artifactId>
+    <version>4.34.1</version>
+    <scope>compile</scope>
+  </dependency>
+  <dependency>
+    <groupId>com.google.protobuf</groupId>
+    <artifactId>protobuf-kotlin</artifactId>
+    <version>4.34.1</version>
+    <scope>compile</scope>
+  </dependency>
+  <dependency>
+    <groupId>io.spine</groupId>
+    <artifactId>spine-logging</artifactId>
+    <version>2.0.0-SNAPSHOT.417</version>
+    <scope>compile</scope>
+  </dependency>
+  <dependency>
+    <groupId>io.spine</groupId>
+    <artifactId>spine-reflect</artifactId>
+    <version>2.0.0-SNAPSHOT.200</version>
+    <scope>compile</scope>
+  </dependency>
+  <dependency>
+    <groupId>org.jetbrains.kotlin</groupId>
+    <artifactId>kotlin-bom</artifactId>
+    <version>2.3.20</version>
+    <scope>compile</scope>
+  </dependency>
+  <dependency>
+    <groupId>org.jetbrains.kotlin</groupId>
+    <artifactId>kotlin-reflect</artifactId>
+    <version>2.3.20</version>
+    <scope>compile</scope>
+  </dependency>
+  <dependency>
+    <groupId>org.jetbrains.kotlin</groupId>
+    <artifactId>kotlin-stdlib</artifactId>
+    <version>2.3.20</version>
+    <scope>compile</scope>
+  </dependency>
+  <dependency>
+    <groupId>org.jetbrains.kotlinx</groupId>
+    <artifactId>kotlinx-coroutines-bom</artifactId>
+    <version>1.10.2</version>
+    <scope>compile</scope>
+  </dependency>
+  <dependency>
+    <groupId>org.jspecify</groupId>
+    <artifactId>jspecify</artifactId>
+    <version>1.0.0</version>
+    <scope>compile</scope>
+  </dependency>
+  <dependency>
+    <groupId>com.fasterxml.jackson.module</groupId>
+    <artifactId>jackson-module-kotlin</artifactId>
+    <version>null</version>
+    <scope>runtime</scope>



    /**
-     * The Compiler belongs to the `tools` group.
+     * The Compiler belongs the `tools` group.


alexander-yevsyukov and others added 4 commits May 13, 2026 19:34

Update config

8d554f5

Bump version -> 2.0.0-SNAPSHOT.388

bc11800

Update dependency reports

a2f47a4

Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>

alexander-yevsyukov self-assigned this May 15, 2026

alexander-yevsyukov requested review from armiol and Copilot and removed request for armiol May 15, 2026 17:52

Copilot started reviewing on behalf of alexander-yevsyukov May 15, 2026 17:52 View session

armiol approved these changes May 15, 2026

View reviewed changes

alexander-yevsyukov mentioned this pull request May 15, 2026

Restore ErrorPlaceholder in the tools package SpineEventEngine/validation#302

Merged

Copilot AI reviewed May 15, 2026

View reviewed changes

chatgpt-codex-connector Bot reviewed May 15, 2026

View reviewed changes

Comment thread base/src/main/kotlin/io/spine/string/TemplateStringExts.kt Outdated

alexander-yevsyukov enabled auto-merge May 15, 2026 18:04

alexander-yevsyukov mentioned this pull request May 15, 2026

Migrate to TemplateString from Spine Base SpineEventEngine/validation#303

Merged

alexander-yevsyukov added 11 commits May 15, 2026 19:17

Remove redundant "to" in KDoc

0fbf59c

Improve property name

d8ab640

Update build time

c0e508d

Support resolution of placeholders referenced from values

dcdd0fd

Add tests for longer cycles

c764e58

Make Placeholder data class

39fad4b

Improve encapsulation

01171ef

Fix Kotest version for builds

ba77233

Suppress ReturnCount

7bffb38

Update build time

32d8fd6

Improve workflow name

03eeab0

alexander-yevsyukov requested a review from Copilot May 15, 2026 20:31

Copilot started reviewing on behalf of alexander-yevsyukov May 15, 2026 20:31 View session

Copilot AI reviewed May 15, 2026

View reviewed changes

Comment thread buildSrc/src/main/kotlin/io/spine/dependency/local/CoreJvmCompiler.kt

Comment thread docs/dependencies/pom.xml

alexander-yevsyukov requested review from armiol and Copilot May 15, 2026 20:49

Copilot started reviewing on behalf of alexander-yevsyukov May 15, 2026 20:51 View session

alexander-yevsyukov merged commit 13f7d8f into master May 15, 2026
8 checks passed

alexander-yevsyukov deleted the template-string branch May 15, 2026 20:53

Copilot AI reviewed May 15, 2026

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add `TemplateString` and `Placeholder`#927

Add `TemplateString` and `Placeholder`#927
alexander-yevsyukov merged 15 commits into
masterfrom
template-string

alexander-yevsyukov commented May 15, 2026

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

chatgpt-codex-connector Bot left a comment

Uh oh!

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Conversation

alexander-yevsyukov commented May 15, 2026

Other notable changes

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

chatgpt-codex-connector Bot left a comment

Choose a reason for hiding this comment

💡 Codex Review

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants