Switch to Kotlin

Author: Igor Stepin

.editorconfig

@@ -10,15 +10,13 @@ insert_final_newline = true
 trim_trailing_whitespace = true
 charset = utf-8
 
-# 4 space indentation
-[*.{py,java,r,R}]
-indent_style = space
-indent_size = 4
+[{*.kt,*.kts}]
+ij_kotlin_code_style_defaults = KOTLIN_OFFICIAL
 
-# 2 space indentation
-[*.{js,json,y{a,}ml,html,cwl}]
-indent_style = space
-indent_size = 2
+#  Disable wildcard imports entirely
+ij_kotlin_name_count_to_use_star_import = 2147483647
+ij_kotlin_name_count_to_use_star_import_for_members = 2147483647
+ij_kotlin_packages_to_use_import_on_demand = unset
 
 [*.{md,Rmd,rst}]
 trim_trailing_whitespace = false

.github/workflows/main.yml

@@ -1,18 +1,3 @@
-*.py[cod]
-*.egg-info
-*.eggs
-
-dist
-.cache
-
-htmlcov
-.coverage
-coverage.xml
-.pytest_cache
-
-docs/_build
-docs/apidocs
-
 # ide
 .idea
 .eclipse
@@ -21,12 +6,6 @@ docs/apidocs
 # Mac
 .DS_Store
 
-# virtual environments
-env
-env3
-venv
-venv3
-
 /tests/repo
 /tests/repo2
 /tests/repo3

.gitignore

@@ -1,15 +1,13 @@
-#NOTE: jc requires gcc and there is no package for alpine, that's why it's not alpine base image
-FROM python:3
+FROM stepin/kotlin-scripting
 
-RUN pip3 install jc \
-&& apt-get update \
-&& apt-get install -y jq \
-&& rm -rf /var/lib/apt/lists/* \
-&& mkdir /app
+RUN apt-get update \
+&& apt-get -y install jc git \
+&& rm -rf /var/lib/apt/lists/*
 
-WORKDIR /app
-ENV PATH="${PATH}:/app"
+COPY git-parse-commits.main.kts ./
 
-COPY git-parse-commits ./
+# Cache dependencies and compilation result for better start-up speed
+ENV KOTLIN_MAIN_KTS_COMPILED_SCRIPTS_CACHE_DIR /app
+RUN /app/git-parse-commits.main.kts version
 
-ENTRYPOINT ["/app/git-parse-commits"]
+ENTRYPOINT ["/app/git-parse-commits.main.kts"]

Dockerfile

@@ -9,8 +9,8 @@ Docker image: [stepin/git-parse-commits:latest](https://hub.docker.com/r/stepin/
 Example how to use with Docker:
 
 ```shell
-docker run --rm -it -v "$(PWD):/git" -w /git --user "$(id -u)" stepin/git-parse-commits:1.0.2 releaseVersion
-docker run --rm -it -v "$(PWD):/git" -w /git --user "$(id -u)" stepin/git-parse-commits:1.0.2 releaseNotes
+docker run --rm -it -v "$(PWD):/git" -w /git --user "$(id -u)" stepin/git-parse-commits:2.0.0 releaseVersion
+docker run --rm -it -v "$(PWD):/git" -w /git --user "$(id -u)" stepin/git-parse-commits:2.0.0 releaseNotes
 ```
 
 Example usage for Gitlab:
@@ -19,7 +19,7 @@ Example usage for Gitlab:
 create_changelog:
   stage: "build"
   image:
-      name: "stepin/git-parse-commits:1.0.2"
+      name: "stepin/git-parse-commits:2.0.0"
       entrypoint: [""]
   variables:
       GIT_DEPTH: "0"
@@ -75,31 +75,25 @@ release:
 ```
 docker run --rm -it stepin/git-parse-commits --help
 
-usage: git-parse-commits [-h] [-j] [-t [TAG_PREFIX]] [-s [SCOPE]] [-i [INITIAL_REVISION]] [-l [LAST_REVISION]] [--tag]
-                         {version,currentVersion,lastReleaseVersion,releaseVersion,releaseNotes} ...
-
-Provides next release version and release notes from git commit messages.
-
-positional arguments:
-  {version,currentVersion,lastReleaseVersion,releaseVersion,releaseNotes}
-    version             Prints version of this tool
-    currentVersion      Prints current version (useful for non-release builds)
-    lastReleaseVersion  Prints version of last release
-    releaseVersion      Prints version of next release from git commit messages
-    releaseNotes        Prints release notes from git commit messages
-
-options:
-  -h, --help            show this help message and exit
-  -j, --json            Output in json format
-  -t [TAG_PREFIX], --tag-prefix [TAG_PREFIX]
-                        prefix for tags (optional)
-  -s [SCOPE], --scope [SCOPE]
-                        scope to filter release note items
-  -i [INITIAL_REVISION], --initial-revision [INITIAL_REVISION]
-                        start range from next revision
-  -l [LAST_REVISION], --last-revision [LAST_REVISION]
-                        stop on this revision
-  --tag                 add tag prefix to version (only if tag prefix is defined)
+Usage: git-parse-commits [<options>] <command> [<args>]...
+
+  Provides next release version and release notes from git commit messages.
+
+Options:
+  -j, --json                     output in json format
+  -t, --tag-prefix=<text>        prefix for tags (optional)
+  --tag                          add tag prefix to versions (only if tag prefix is defined)
+  -s, --scope=<text>             scope to filter release note items
+  -i, --initial-revision=<text>  start range from next revision
+  -l, --last-revision=<text>     stop on this revision
+  -h, --help                     Show this message and exit
+
+Commands:
+  version             Prints version of this tool
+  currentVersion      Prints current version (useful for non-release builds)
+  lastReleaseVersion  Prints version of last release
+  releaseVersion      Prints version of next release from git commit messages
+  releaseNotes        Prints release notes from git commit messages
 ```
 
 
@@ -240,13 +234,17 @@ Feel free to send MRs/patches.
 
 Following components should be installed locally (or in Docker):
 
-- Python 3
+- Kotlin
 - git
 - bash
 - jq https://jqlang.github.io/jq/
 - jc https://github.com/kellyjonbrazil/jc
 
 ```bash
-brew install jq jc
-poetry install
+brew install jq jc kotlin
 ```
+
+Currently, it's not possible to split single script to several files. So, it will be when it will
+be possible (like around Kotlin 2.0.20).
+
+Also, it's not clear how to write unit tests for this script. Ping me if you know some example / article.

README.md

@@ -0,0 +1,11 @@
+#!/usr/bin/env bash
+set -eEuo pipefail
+cd "$(dirname "$0")"
+
+cd ..
+
+VERSION=$(git describe --tags --always)
+IMAGE_LATEST="stepin/git-parse-commits"
+IMAGE="$IMAGE_LATEST:$VERSION"
+
+docker build . -t "$IMAGE" -t "$IMAGE_LATEST"

bin/build

@@ -0,0 +1,7 @@
+#!/usr/bin/env bash
+set -eEuo pipefail
+cd "$(dirname "$0")"
+
+cd ..
+
+ktlint --format git-parse-commits.main.kts

bin/klint

@@ -8,8 +8,8 @@ VERSION=$(git describe --tags --always)
 IMAGE_LATEST="stepin/git-parse-commits"
 IMAGE="$IMAGE_LATEST:$VERSION"
 
-cp git-parse-commits git-parse-commits.orig
-sed "s/SNAPSHOT/$VERSION/g" git-parse-commits.orig > git-parse-commits
+cp git-parse-commits.main.kts git-parse-commits.main.kts.orig
+sed "s/SNAPSHOT/$VERSION/g" git-parse-commits.main.kts.orig > git-parse-commits.main.kts
 
 docker buildx create --use
 docker buildx build --push --platform linux/amd64,linux/arm64 . -t "$IMAGE" -t "$IMAGE_LATEST"