From a7713b0427c610cc5d30170354c175f37a456ac0 Mon Sep 17 00:00:00 2001 From: Paul Dingemans Date: Wed, 23 Aug 2023 20:41:59 +0200 Subject: [PATCH] Update and align Maven coordinates (#2195) - Rename property "GROUP" to "POM_GROUP_ID". - Set version to "1.0.0-SNAPSHOT" Closes #1931 --- CHANGELOG.md | 17 ++++++++++++++++ .../main/kotlin/ktlint-publication.gradle.kts | 5 +---- documentation/snapshot/docs/faq.md | 20 +++++++++++++++++++ documentation/snapshot/overrides/main.html | 6 ++++++ gradle.properties | 4 ++-- .../gradle.properties | 5 ++--- .../gradle.properties | 5 ++--- ktlint-cli-reporter-core/gradle.properties | 5 ++--- ktlint-cli-reporter-format/gradle.properties | 5 ++--- ktlint-cli-reporter-html/gradle.properties | 5 ++--- ktlint-cli-reporter-json/gradle.properties | 5 ++--- .../gradle.properties | 5 ++--- ktlint-cli-reporter-plain/gradle.properties | 5 ++--- ktlint-cli-reporter-sarif/gradle.properties | 5 ++--- ktlint-cli/gradle.properties | 6 ++---- 15 files changed, 66 insertions(+), 37 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 15f579a300..cd94d1df46 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -4,6 +4,23 @@ This project adheres to [Semantic Versioning](https://semver.org/). ## Unreleased +IMPORTANT: Maven coordinates have been changed for some module. Be sure to update them, to get latest changes! + +| Old Maven coordinates | New Maven coordinates | +|----------------------------------------------------|--------------------------------------------------------| +| com.pinterest.ktlint | com.pinterest.ktlint.ktlint-cli | +| com.pinterest.ktlint.ktlint-reporter-baseline | com.pinterest.ktlint.ktlint-cli-reporter-baseline | +| com.pinterest.ktlint.ktlint-reporter-checkstyle | com.pinterest.ktlint.ktlint-cli-reporter-checkstyle | +| com.pinterest.ktlint.ktlint-cli-reporter | com.pinterest.ktlint.ktlint-cli-reporter-core | +| com.pinterest.ktlint.ktlint-reporter-format | com.pinterest.ktlint.ktlint-cli-reporter-format | +| com.pinterest.ktlint.ktlint-reporter-html | com.pinterest.ktlint.ktlint-cli-reporter-html | +| com.pinterest.ktlint.ktlint-reporter-json | com.pinterest.ktlint.ktlint-cli-reporter-json | +| com.pinterest.ktlint.ktlint-reporter-plain | com.pinterest.ktlint.ktlint-cli-reporter-plain | +| com.pinterest.ktlint.ktlint-reporter-plain-summary | com.pinterest.ktlint.ktlint-cli-reporter-plain-summary | +| com.pinterest.ktlint.ktlint-reporter-sarif | com.pinterest.ktlint.ktlint-cli-reporter-sarif | +| com.pinterest.ktlint. | com.pinterest.ktlint. | +| com.pinterest.ktlint. | com.pinterest.ktlint. | + ### API changes * As a part of public API stabilization, data classes are no longer used in the public API. As of that, functions like `copy()` or `componentN()` (used for destructuring declarations) are not available anymore. This is a binary incompatible change, breaking backwards compatibility. ([#2133](https://github.com/pinterest/ktlint/issues/2133)) diff --git a/build-logic/src/main/kotlin/ktlint-publication.gradle.kts b/build-logic/src/main/kotlin/ktlint-publication.gradle.kts index 2c472d4e02..a296f9d2d7 100644 --- a/build-logic/src/main/kotlin/ktlint-publication.gradle.kts +++ b/build-logic/src/main/kotlin/ktlint-publication.gradle.kts @@ -15,14 +15,11 @@ project.version = } else { definedVersion } -// TODO: Remove `localGradleProperty` once https://github.com/gradle/gradle/issues/23572 or https://github.com/pinterest/ktlint/issues/1931 is fixed. -project.group = localGradleProperty("GROUP").orNull ?: providers.gradleProperty("GROUP").orNull - ?: throw GradleException("Project group property is missing") publishing { publications { create("maven") { - groupId = group.toString() + groupId = localGradleProperty("POM_GROUP_ID").get() version = version.toString() artifactId = localGradleProperty("POM_ARTIFACT_ID").get() diff --git a/documentation/snapshot/docs/faq.md b/documentation/snapshot/docs/faq.md index cecf5ca97b..e0f84053c0 100644 --- a/documentation/snapshot/docs/faq.md +++ b/documentation/snapshot/docs/faq.md @@ -8,6 +8,26 @@ By using ktlint you put the importance of code clarity and community conventions ktlint is a single binary with both linter & formatter included. All you need is to drop it in (no need to get [overwhelmed](https://en.wikipedia.org/wiki/Decision_fatigue) while choosing among [dozens of code style options](https://checkstyle.sourceforge.net/checks.html)). + +## What are the Maven coordinates in Ktlint 1.x? + +With the release of ktlint `1.0` the Maven coordinates of most modules have been changed. Now all ktlint modules are published in Maven group `com.pinterest.ktlint`. Also, the artifact id's of some modules have been changed. + +The Maven coordinates of modules below have been changed: + +| Old Maven coordinates | New Maven coordinates | +|------------------------------------------------------|----------------------------------------------------------| +| `com.pinterest.ktlint` | `com.pinterest.ktlint.ktlint-cli` | +| `com.pinterest.ktlint.ktlint-reporter-baseline` | `com.pinterest.ktlint.ktlint-cli-reporter-baseline` | +| `com.pinterest.ktlint.ktlint-reporter-checkstyle` | `com.pinterest.ktlint.ktlint-cli-reporter-checkstyle` | +| `com.pinterest.ktlint.ktlint-cli-reporter` | `com.pinterest.ktlint.ktlint-cli-reporter-core` | +| `com.pinterest.ktlint.ktlint-reporter-format` | `com.pinterest.ktlint.ktlint-cli-reporter-format` | +| `com.pinterest.ktlint.ktlint-reporter-html` | `com.pinterest.ktlint.ktlint-cli-reporter-html` | +| `com.pinterest.ktlint.ktlint-reporter-json` | `com.pinterest.ktlint.ktlint-cli-reporter-json` | +| `com.pinterest.ktlint.ktlint-reporter-plain` | `com.pinterest.ktlint.ktlint-cli-reporter-plain` | +| `com.pinterest.ktlint.ktlint-reporter-plain-summary` | `com.pinterest.ktlint.ktlint-cli-reporter-plain-summary` | +| `com.pinterest.ktlint.ktlint-reporter-sarif` | `com.pinterest.ktlint.ktlint-cli-reporter-sarif` | + ## How do I enable or disable a rule? An individual rule can be enabled or disabled with a rule property. The name of the rule property consists of the `ktlint_` prefix followed by the rule set id followed by a `_` and the rule id. Examples: diff --git a/documentation/snapshot/overrides/main.html b/documentation/snapshot/overrides/main.html index e658abc65b..ae3e915a54 100644 --- a/documentation/snapshot/overrides/main.html +++ b/documentation/snapshot/overrides/main.html @@ -10,3 +10,9 @@ RELEASE version of the documentation {% endblock %} + +The maven coordinates of `ktlint` have been changed. See + + new Maven coordinates + + diff --git a/gradle.properties b/gradle.properties index 68c44f89f1..e3bf4410d7 100644 --- a/gradle.properties +++ b/gradle.properties @@ -1,5 +1,5 @@ -VERSION_NAME=0.50.1-SNAPSHOT -GROUP=com.pinterest.ktlint +VERSION_NAME=1.0.0-SNAPSHOT +POM_GROUP_ID=com.pinterest.ktlint POM_DESCRIPTION=An anti-bikeshedding Kotlin linter with built-in formatter. diff --git a/ktlint-cli-reporter-baseline/gradle.properties b/ktlint-cli-reporter-baseline/gradle.properties index 5f38591bc3..3b1dfa4e34 100644 --- a/ktlint-cli-reporter-baseline/gradle.properties +++ b/ktlint-cli-reporter-baseline/gradle.properties @@ -1,3 +1,2 @@ -# TODO: https://github.com/pinterest/ktlint/issues/1931 Rename POM to ktlint-cli-reporter-baseline whenever releasing version 1.0 -POM_NAME=ktlint-reporter-baseline -POM_ARTIFACT_ID=ktlint-reporter-baseline +POM_NAME=ktlint-cli-reporter-baseline +POM_ARTIFACT_ID=ktlint-cli-reporter-baseline diff --git a/ktlint-cli-reporter-checkstyle/gradle.properties b/ktlint-cli-reporter-checkstyle/gradle.properties index 2a93735152..d92950251d 100644 --- a/ktlint-cli-reporter-checkstyle/gradle.properties +++ b/ktlint-cli-reporter-checkstyle/gradle.properties @@ -1,3 +1,2 @@ -# TODO: https://github.com/pinterest/ktlint/issues/1931 Rename POM to ktlint-cli-reporter-checkstyle whenever releasing version 1.0 -POM_NAME=ktlint-reporter-checkstyle -POM_ARTIFACT_ID=ktlint-reporter-checkstyle +POM_NAME=ktlint-cli-reporter-checkstyle +POM_ARTIFACT_ID=ktlint-cli-reporter-checkstyle diff --git a/ktlint-cli-reporter-core/gradle.properties b/ktlint-cli-reporter-core/gradle.properties index b2bd5cd1bc..c9e034127f 100644 --- a/ktlint-cli-reporter-core/gradle.properties +++ b/ktlint-cli-reporter-core/gradle.properties @@ -1,3 +1,2 @@ -# TODO: https://github.com/pinterest/ktlint/issues/1931 Rename POM to ktlint-cli-reporter-core whenever releasing version 1.0 -POM_NAME=ktlint-cli-reporter -POM_ARTIFACT_ID=ktlint-cli-reporter +POM_NAME=ktlint-cli-reporter-core +POM_ARTIFACT_ID=ktlint-cli-reporter-core diff --git a/ktlint-cli-reporter-format/gradle.properties b/ktlint-cli-reporter-format/gradle.properties index 4165397f0b..bd5e2e0571 100644 --- a/ktlint-cli-reporter-format/gradle.properties +++ b/ktlint-cli-reporter-format/gradle.properties @@ -1,3 +1,2 @@ -# TODO: https://github.com/pinterest/ktlint/issues/1931 Rename POM to ktlint-cli-reporter-format whenever releasing version 1.0 -POM_NAME=ktlint-reporter-format -POM_ARTIFACT_ID=ktlint-reporter-format +POM_NAME=ktlint-cli-reporter-format +POM_ARTIFACT_ID=ktlint-cli-reporter-format diff --git a/ktlint-cli-reporter-html/gradle.properties b/ktlint-cli-reporter-html/gradle.properties index 9a473d03ad..1ab1b356f9 100644 --- a/ktlint-cli-reporter-html/gradle.properties +++ b/ktlint-cli-reporter-html/gradle.properties @@ -1,3 +1,2 @@ -# TODO: https://github.com/pinterest/ktlint/issues/1931 Rename POM to ktlint-cli-reporter-html whenever releasing version 1.0 -POM_NAME=ktlint-reporter-html -POM_ARTIFACT_ID=ktlint-reporter-html +POM_NAME=ktlint-cli-reporter-html +POM_ARTIFACT_ID=ktlint-cli-reporter-html diff --git a/ktlint-cli-reporter-json/gradle.properties b/ktlint-cli-reporter-json/gradle.properties index 6c7fee30d5..fdffac21d7 100644 --- a/ktlint-cli-reporter-json/gradle.properties +++ b/ktlint-cli-reporter-json/gradle.properties @@ -1,3 +1,2 @@ -# TODO: https://github.com/pinterest/ktlint/issues/1931 Rename POM to ktlint-cli-reporter-json whenever releasing version 1.0 -POM_NAME=ktlint-reporter-json -POM_ARTIFACT_ID=ktlint-reporter-json +POM_NAME=ktlint-cli-reporter-json +POM_ARTIFACT_ID=ktlint-cli-reporter-json diff --git a/ktlint-cli-reporter-plain-summary/gradle.properties b/ktlint-cli-reporter-plain-summary/gradle.properties index e62e72b117..63d42fc74d 100644 --- a/ktlint-cli-reporter-plain-summary/gradle.properties +++ b/ktlint-cli-reporter-plain-summary/gradle.properties @@ -1,3 +1,2 @@ -# TODO: https://github.com/pinterest/ktlint/issues/1931 Rename POM to ktlint-cli-reporter-plain-summary whenever releasing version 1.0 -POM_NAME=ktlint-reporter-plain-summary -POM_ARTIFACT_ID=ktlint-reporter-plain-summary +POM_NAME=ktlint-cli-reporter-plain-summary +POM_ARTIFACT_ID=ktlint-cli-reporter-plain-summary diff --git a/ktlint-cli-reporter-plain/gradle.properties b/ktlint-cli-reporter-plain/gradle.properties index 22eb3a8bfd..cb8ef2c5a2 100644 --- a/ktlint-cli-reporter-plain/gradle.properties +++ b/ktlint-cli-reporter-plain/gradle.properties @@ -1,3 +1,2 @@ -# TODO: https://github.com/pinterest/ktlint/issues/1931 Rename POM to ktlint-cli-reporter-plain whenever releasing version 1.0 -POM_NAME=ktlint-reporter-plain -POM_ARTIFACT_ID=ktlint-reporter-plain +POM_NAME=ktlint-cli-reporter-plain +POM_ARTIFACT_ID=ktlint-cli-reporter-plain diff --git a/ktlint-cli-reporter-sarif/gradle.properties b/ktlint-cli-reporter-sarif/gradle.properties index 83410f197f..ff9a3616db 100644 --- a/ktlint-cli-reporter-sarif/gradle.properties +++ b/ktlint-cli-reporter-sarif/gradle.properties @@ -1,3 +1,2 @@ -# TODO: Rename POM to ktlint-cli-reporter-sarif whenever releasing version 1.0 -POM_NAME=ktlint-reporter-sarif -POM_ARTIFACT_ID=ktlint-reporter-sarif +POM_NAME=ktlint-cli-reporter-sarif +POM_ARTIFACT_ID=ktlint-cli-reporter-sarif diff --git a/ktlint-cli/gradle.properties b/ktlint-cli/gradle.properties index 2b0595afb4..7f1a040e7c 100644 --- a/ktlint-cli/gradle.properties +++ b/ktlint-cli/gradle.properties @@ -1,4 +1,2 @@ -# TODO: https://github.com/pinterest/ktlint/issues/1931 -GROUP=com.pinterest -POM_NAME=ktlint -POM_ARTIFACT_ID=ktlint +POM_NAME=ktlint-cli +POM_ARTIFACT_ID=ktlint-cli