From 8d0f949a694e2e46b95512c63e18eb34aed0161d Mon Sep 17 00:00:00 2001 From: Swordsteel Date: Wed, 30 Jul 2025 13:37:07 +0200 Subject: [PATCH] add plugin ui-service --- README.md | 94 ++++++++++++++----- gradle.properties | 2 +- ...gin.ui-service-thymeleaf-minify.gradle.kts | 41 ++++++++ ...hlaeja-common-plugin.ui-service.gradle.kts | 4 + 4 files changed, 118 insertions(+), 23 deletions(-) create mode 100644 src/main/kotlin/ltd.hlaeja.plugin.hlaeja-common-plugin.ui-service-thymeleaf-minify.gradle.kts create mode 100644 src/main/kotlin/ltd.hlaeja.plugin.hlaeja-common-plugin.ui-service.gradle.kts diff --git a/README.md b/README.md index 0a5bbc1..6a52ea3 100644 --- a/README.md +++ b/README.md @@ -2,72 +2,108 @@ Plugins for the libraries, lofty and grand, Plugins for the services, steadfast as stone, Plugins for the common, bound to their fate, Using the one plugin to rule them all, and in automation bind them, In the realm of code, where the builds take form. + +* [Hlæja Common Plugin](#hlæja-common-plugin) + * [Plugins](#plugins) + * [Common](#common) + * [Plugin Common](#plugin-common) + * [Gradle Tasks](#gradle-tasks) + * [Plugin Common Detekt](#plugin-common-detekt) + * [Plugin Common Ktlint](#plugin-common-ktlint) + * [Library](#library) + * [Plugin Library](#plugin-library) + * [Plugin Library Manifest](#plugin-library-manifest) + * [Plugin Library publish](#plugin-library-publish) + * [Service](#service) + * [Plugin Service](#plugin-service) + * [Plugin Service Container](#plugin-service-container) + * [Configuration](#configuration) + * [Gradle Tasks](#gradle-tasks-1) + * [Plugin Service Test Integration](#plugin-service-test-integration) + * [Plugin Service Process Resource](#plugin-service-process-resource) + * [Plugin Certificate](#plugin-certificate) + * [UI Service](#ui-service) + * [Plugin UI Service](#plugin-ui-service) + * [Plugin UI Service Thymeleaf Minify](#plugin-ui-service-thymeleaf-minify) + * [Releasing Plugin](#releasing-plugin) + * [Publishing plugin](#publishing-plugin) + * [Publish plugin locally](#publish-plugin-locally) + * [Publish plugin to repository](#publish-plugin-to-repository) + * [Global gradle properties](#global-gradle-properties) + + ## Plugins -### Plugin Common +### Common + +#### Plugin Common id `ltd.hlaeja.plugin.hlaeja-common-plugin.common` Set core Java and Kotlin settings and overweight project version with git version. -#### Gradle Tasks +##### Gradle Tasks * `buildInfo` display name and version, add to `build` task. * `projectInfo` display project, Gradle, and Java information -### Plugin Common Detekt +#### Plugin Common Detekt id `ltd.hlaeja.plugin.hlaeja-common-plugin.common-detekt` Detect is a code smell analysis for your Kotlin projects. -### Plugin Common Ktlint +#### Plugin Common Ktlint id `ltd.hlaeja.plugin.hlaeja-common-plugin.common-ktlint` Ktlint enforces consistent code style and formatting across Kotlin codebases. -### Plugin Library +### Library + +#### Plugin Library id `ltd.hlaeja.plugin.hlaeja-common-plugin.library` Default setting and tasks for libraries. -### Plugin Library Manifest +#### Plugin Library Manifest id `ltd.hlaeja.plugin.hlaeja-common-plugin.library-manifest` Extend manifest in library jar file. -### Plugin Library publish +#### Plugin Library publish id `ltd.hlaeja.plugin.hlaeja-common-plugin.library-publish` Configuration for publishing project artifacts to a remote Maven repository. -### Plugin Service +### Service + +#### Plugin Service id `ltd.hlaeja.plugin.hlaeja-common-plugin.service` Default setting and tasks for services. -### Plugin Service Container +#### Plugin Service Container id `ltd.hlaeja.plugin.hlaeja-common-plugin.service-container` Configuration for running project in docker locally during development. -#### Configuration +##### Configuration * properties `container.network`, environment `CONTAINER_NETWORK`, or default `develop` * properties `container.port.expose`, environment `CONTAINER_PORT_EXPOSE`, or default `8080` * properties `container.port.host`, environment `CONTAINER_PORT_HOST`, or default `8080` * properties `container.profiles`, environment `CONTAINER_PROFILES`, or default `docker` -* properties `docker.port.expose`, environment `DOCKER_PORT_EXPOSE`, or default `8080` +* properties `docker.port.expose`, environment `DOCKER_PORT_EXPOSE`, or default `8080` container and docker ports can be a single port (e.g., 8080) or multiple ports separated by commas (e.g., 8080,8443) -#### Gradle Tasks +##### Gradle Tasks * `containerCreate` create docker container with network and spring boot profile. * `containerStart` starts docker container. @@ -76,27 +112,41 @@ container and docker ports can be a single port (e.g., 8080) or multiple ports s * `containerNetworkCreate` creates network. * `containerNetworkRemove` removes network. -### Plugin Service Integration Test +#### Plugin Service Test Integration -id `ltd.hlaeja.plugin.hlaeja-common-plugin.service-integration-test` +id `ltd.hlaeja.plugin.hlaeja-common-plugin.service-test-integration` -Adding task `integrationTest` to run integration test, add to `verification` group and add to task `check`. +Adding task `testIntegration` to run integration test, add to `verification` group and add to task `check`. -Adding intellij support `src/integration-test/java`, `src/integration-test/kotlin`, and `src/integration-test/resources` as test module in intellij. +Adding intellij support `src/test-integration/java`, `src/test-integration/kotlin`, and `src/test-integration/resources` as test module in intellij. -Adding dependencies support `integrationTestImplementation()`, and `integrationTestRuntimeOnly()` as part of Gradle. +Adding dependencies support `testIntegrationImplementation()`, and `testIntegrationRuntimeOnly()` as part of Gradle. -### Plugin Service Process Resource +#### Plugin Service Process Resource id `ltd.hlaeja.plugin.hlaeja-common-plugin.service-process-resource` Assign values to `application.yml` from Gradle. -### Plugin Certificate +#### Plugin Certificate id `ltd.hlaeja.plugin.hlaeja-common-plugin.cetificat` -Copy certificate to build resources by placing one or more of `private_key.pem`, `public_key.pem`, or `keystore.p12` in `/cert` folder. +Copy certificate to build resources by placing one or more of `private_key.pem`, `public_key.pem`, or `keystore.p12` in `/cert` folder. + +### UI Service + +#### Plugin UI Service + +id `ltd.hlaeja.plugin.hlaeja-common-plugin.ui-service` + +Default setting and tasks for thymeleaf ui services. + +#### Plugin UI Service Thymeleaf Minify + +id `ltd.hlaeja.plugin.hlaeja-common-plugin.ui-service-thymeleaf.minify` + +minimize all templates files during processResources. skips html tags pre, textarea, script, style, and template ## Releasing Plugin @@ -123,8 +173,8 @@ To authenticate with Gradle to access repositories that require authentication, Here's how you can do it: 1. Open or create the `gradle.properties` file in your Gradle user home directory: - - On Unix-like systems (Linux, macOS), this directory is typically `~/.gradle/`. - - On Windows, this directory is typically `C:\Users\\.gradle\`. + - On Unix-like systems (Linux, macOS), this directory is typically `~/.gradle/`. + - On Windows, this directory is typically `C:\Users\\.gradle\`. 2. Add the following lines to the `gradle.properties` file: ```properties repository.user=your_user diff --git a/gradle.properties b/gradle.properties index 7447d9d..fbca745 100644 --- a/gradle.properties +++ b/gradle.properties @@ -1,3 +1,3 @@ kotlin.code.style=official version=0.4.0-SNAPSHOT -catalog=0.11.0 +catalog=0.12.0-SNAPSHOT diff --git a/src/main/kotlin/ltd.hlaeja.plugin.hlaeja-common-plugin.ui-service-thymeleaf-minify.gradle.kts b/src/main/kotlin/ltd.hlaeja.plugin.hlaeja-common-plugin.ui-service-thymeleaf-minify.gradle.kts new file mode 100644 index 0000000..1e243b1 --- /dev/null +++ b/src/main/kotlin/ltd.hlaeja.plugin.hlaeja-common-plugin.ui-service-thymeleaf-minify.gradle.kts @@ -0,0 +1,41 @@ +import kotlin.text.RegexOption.IGNORE_CASE + +tasks { + register("minifyTemplates") { + val srcTemplates = file("src/main/resources/templates") + val outTemplates = layout.buildDirectory.dir("resources/main/templates") + val preserveTags = listOf("pre", "textarea", "script", "style", "template") + inputs.dir(srcTemplates) + outputs.dir(outTemplates) + doLast { + fileTree(srcTemplates).matching { include("**/*.html") } + .forEach { srcFile -> + val preserve = preserveTags.joinToString("|") + val preservedBlocks = mutableListOf() + Regex("<(?:$preserve)\\b[^>]*>[\\s\\S]*?<\\/\\s*(?:$preserve)>", IGNORE_CASE) + .replace(srcFile.readText()) { + val id = preservedBlocks.size + preservedBlocks += it.value + "%%%PRESERVE_BLOCK_$id%%%" + } + .replace(Regex(""), "") + .replace(Regex("[\\r\\n]+"), "") + .replace(Regex("\\s{2,}"), " ") + .replace(Regex(">\\s+<"), "><") + .replace(Regex("\\s*%%%PRESERVE_BLOCK_(\\d+)%%%\\s*")) { + preservedBlocks[it.groupValues[1].toInt()] + } + .let { stripped -> + outTemplates.get().asFile.resolve(srcFile.relativeTo(srcTemplates)).also { file -> + file.parentFile.mkdirs() + file.writeText(stripped) + } + } + } + } + } + named("processResources") { + exclude("templates/**") + dependsOn(findByPath("minifyTemplates")) + } +} diff --git a/src/main/kotlin/ltd.hlaeja.plugin.hlaeja-common-plugin.ui-service.gradle.kts b/src/main/kotlin/ltd.hlaeja.plugin.hlaeja-common-plugin.ui-service.gradle.kts new file mode 100644 index 0000000..37e1c08 --- /dev/null +++ b/src/main/kotlin/ltd.hlaeja.plugin.hlaeja-common-plugin.ui-service.gradle.kts @@ -0,0 +1,4 @@ +plugins { + id("ltd.hlaeja.plugin.hlaeja-common-plugin.service") + id("ltd.hlaeja.plugin.hlaeja-common-plugin.ui-service-thymeleaf-minify") +}