diff --git a/.editorconfig b/.editorconfig index cdc2ca9..941c8be 100644 --- a/.editorconfig +++ b/.editorconfig @@ -1,6 +1,7 @@ root = true -[*] +[*.{kt,kts}] indent_size = 2 continuation_indent_size = 4 ij_kotlin_name_count_to_use_star_import = unset +disabled_rules = no-wildcard-imports diff --git a/.github/workflows/check.yml b/.github/workflows/check.yml index da3272e..61ea86d 100644 --- a/.github/workflows/check.yml +++ b/.github/workflows/check.yml @@ -15,7 +15,7 @@ env: jobs: check: name: Check on ${{ matrix.os.runner }} - runs-on: ${{ matrix.os }} + runs-on: ${{ matrix.os.runner }} defaults: run: shell: ${{ matrix.os.shell }} @@ -23,7 +23,7 @@ jobs: fail-fast: false matrix: os: - - runner: macos-latest + - runner: macos-11 shell: bash - runner: ubuntu-latest shell: bash diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index feecd84..4b83f08 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -36,7 +36,7 @@ jobs: fail-fast: false matrix: os: - - runner: macos-latest + - runner: macos-11 shell: bash - runner: windows-latest shell: msys2 {0} @@ -146,7 +146,7 @@ jobs: tasks: publishToSonatype closeSonatypeStagingRepository enabled: ${{ github.event.inputs.skipMavenCentral != 'y' }} os: - - runner: macos-latest + - runner: macos-11 shell: bash - runner: windows-latest shell: msys2 {0} diff --git a/.github/workflows/sandbox.yml b/.github/workflows/sandbox.yml index e5757e0..5204c86 100644 --- a/.github/workflows/sandbox.yml +++ b/.github/workflows/sandbox.yml @@ -34,7 +34,7 @@ jobs: fail-fast: false matrix: os: - - runner: macos-latest + - runner: macos-11 shell: bash - runner: windows-latest shell: msys2 {0} diff --git a/.sdkmanrc b/.sdkmanrc new file mode 100644 index 0000000..50cabbe --- /dev/null +++ b/.sdkmanrc @@ -0,0 +1,3 @@ +# Enable auto-env through the sdkman_auto_env config +# Add key=value pairs of SDKs to use below +java=11.0.2-open diff --git a/CHANGELOG.md b/CHANGELOG.md index 8c5b155..2cc263a 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,4 +1,15 @@ -# v1.1.3 +# 1.1.4 + +## Changes + +* Back to spotless + ktlint +* Fixed GH actions issues with runners +* `local.properties` support +* Custom refreshVersions rules setup +* `.sdkmanrc` for easier local env setup +* Version bumps (kotlin@1.6.10, gradle@7.3.3) + +# 1.1.3 ## Changes @@ -6,7 +17,7 @@ * Disabling git hooks on CI * Added android support -# v1.1.2 +# 1.1.2 ## Changes @@ -20,7 +31,7 @@ * watchosSimulatorArm64() target added * tvosSimulatorArm64() target added -# v1.1.1 +# 1.1.1 ## Changes diff --git a/README.md b/README.md index bc88280..8856c7d 100644 --- a/README.md +++ b/README.md @@ -13,7 +13,7 @@ except deprecated wasm32. * Native target grouping and shared sourceSets * Wrapper library module that declares dependencies on all lib modules -* Uniform configuration via conventional plugins `convention.common`, `convention.library` & `convention.publishing` +* Uniform configuration via conventional plugins `plugin.common`, `plugin.library-mpp` & `plugin.publishing-mpp` * Local `test` module for shared test utilities (a helper function to run coroutine tests in common sourceSet included) * Local `sandbox` module for easy library consumer side checks * Publication control to avoid multiple publications for targets that can be built on multiple hosts @@ -26,6 +26,7 @@ except deprecated wasm32. * GH check action for platform dependant tests on PRs * Maven Central publishing setup * GH Packages publishing setup +* `SDKMAN` support for local env (`sdk man env install` to get the required JDM and `sdkman env` to switch to it) ## Setup @@ -37,7 +38,7 @@ This README contains some useful badges for your project. To tailor them to your to be made: * `Dokka docs` - change the link as `(http://$GH_USERNAME.github.io/$GH_PROJECT_NAME)` -* `Version maven-central - change all occurrences of `dev.petuska` to your own group and `template-kmp-library` to your +* `Version maven-central` - change all occurrences of `dev.petuska` to your own group and `template-kmp-library` to your root library name ### gradle.properties @@ -54,22 +55,22 @@ Have a look at `gradle.properties` file and change these properties as needed ### Modules -All the library modules should go to `/lib/` directory and be included in `/settings.gradle.kts`. There are already two -sample modules to illustrate how simple the setup is (`/lib/template-kmp-library-core` & `template-kmp-library-dsl`). -They both contain some sample code and tests that make use of local `/test` module with testing utilities. +All the library modules should go to [./lib] directory and be included in [./settings.gradle.kts]. There are already two +sample modules to illustrate how simple the setup is ([./lib/template-kmp-library-core] & [./lib/template-kmp-library-dsl]). +They both contain some sample code and tests that make use of local [./test] module with testing utilities. ### Kotlin Targets The template comes packed with all kotlin targets preconfigured, however if you want to remove some of them or tweak the -config, you only need to make changes as needed in `/buildSrc/src/main/kotlin/convention.library.gradle.kts`. Removing +config, you only need to make changes as needed in [./buildSrc/src/main/kotlin/plugin.library-mpp.gradle.kts]. Removing targets from this file will not break any publications as they're configured on top of pre-registered targets. ### GitHub Actions The template also comes with GH actions to check builds on PRs and publish artefacts when creating a GH release. By -default, it'll publish to GH packages and Maven Central. However to fully unlock Maven Central publishing, you'll need +default, it'll publish to GH packages and Maven Central. However, to fully unlock Maven Central publishing, you'll need to add these secrets to your GH repository. If you want to quickly disable Maven Central publishing, you can toggle it -at `.github/workflows/release.yml#L80` +at [./.github/workflows/release.yml#L80]` * `SIGNING_KEY` - GPG signing key * `SIGNING_KEY_ID` - GPG signing key ID diff --git a/buildSrc/settings.gradle.kts b/buildSrc/settings.gradle.kts index dd6d63e..6c235d2 100644 --- a/buildSrc/settings.gradle.kts +++ b/buildSrc/settings.gradle.kts @@ -1,6 +1,6 @@ pluginManagement { plugins { - id("de.fayard.refreshVersions") version "0.23.0" + id("de.fayard.refreshVersions") version "0.30.2" } } diff --git a/buildSrc/src/main/kotlin/plugin.common.gradle.kts b/buildSrc/src/main/kotlin/plugin.common.gradle.kts index 39175c0..4c020b6 100644 --- a/buildSrc/src/main/kotlin/plugin.common.gradle.kts +++ b/buildSrc/src/main/kotlin/plugin.common.gradle.kts @@ -1,11 +1,21 @@ +import de.fayard.refreshVersions.core.versionFor import org.jetbrains.kotlin.gradle.tasks.AbstractKotlinCompile import org.jetbrains.kotlin.gradle.tasks.KotlinTest +import java.util.Properties plugins { id("com.diffplug.spotless") idea } +rootDir.resolve("local.properties").takeIf(File::exists)?.let { + Properties().apply { + it.inputStream().use(::load) + }.mapKeys { (k, _) -> k.toString() } +}?.toList()?.forEach { (k, v) -> + project.extra[k] = v +} + repositories { mavenCentral() google() @@ -19,8 +29,19 @@ idea { } spotless { - kotlin { ktfmt() } - kotlinGradle { ktfmt() } + val ktlintSettings = mapOf( + "indent_size" to "2", + "continuation_indent_size" to "4", + "disabled_rules" to "no-wildcard-imports" + ) + kotlin { + target("src/**/*.kt") + ktlint(versionFor("version.ktlint")).userData(ktlintSettings) + } + kotlinGradle { + target("*.kts") + ktlint(versionFor("version.ktlint")).userData(ktlintSettings) + } } tasks { diff --git a/gradle/wrapper/gradle-wrapper.properties b/gradle/wrapper/gradle-wrapper.properties index ffed3a2..2e6e589 100644 --- a/gradle/wrapper/gradle-wrapper.properties +++ b/gradle/wrapper/gradle-wrapper.properties @@ -1,5 +1,5 @@ distributionBase=GRADLE_USER_HOME distributionPath=wrapper/dists -distributionUrl=https\://services.gradle.org/distributions/gradle-7.2-bin.zip +distributionUrl=https\://services.gradle.org/distributions/gradle-7.3.3-bin.zip zipStoreBase=GRADLE_USER_HOME zipStorePath=wrapper/dists diff --git a/gradlew b/gradlew index 744e882..1b6c787 100755 --- a/gradlew +++ b/gradlew @@ -1,7 +1,7 @@ -#!/usr/bin/env sh +#!/bin/sh # -# Copyright 2015 the original author or authors. +# Copyright © 2015-2021 the original authors. # # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. @@ -17,67 +17,101 @@ # ############################################################################## -## -## Gradle start up script for UN*X -## +# +# Gradle start up script for POSIX generated by Gradle. +# +# Important for running: +# +# (1) You need a POSIX-compliant shell to run this script. If your /bin/sh is +# noncompliant, but you have some other compliant shell such as ksh or +# bash, then to run this script, type that shell name before the whole +# command line, like: +# +# ksh Gradle +# +# Busybox and similar reduced shells will NOT work, because this script +# requires all of these POSIX shell features: +# * functions; +# * expansions «$var», «${var}», «${var:-default}», «${var+SET}», +# «${var#prefix}», «${var%suffix}», and «$( cmd )»; +# * compound commands having a testable exit status, especially «case»; +# * various built-in commands including «command», «set», and «ulimit». +# +# Important for patching: +# +# (2) This script targets any POSIX shell, so it avoids extensions provided +# by Bash, Ksh, etc; in particular arrays are avoided. +# +# The "traditional" practice of packing multiple parameters into a +# space-separated string is a well documented source of bugs and security +# problems, so this is (mostly) avoided, by progressively accumulating +# options in "$@", and eventually passing that to Java. +# +# Where the inherited environment variables (DEFAULT_JVM_OPTS, JAVA_OPTS, +# and GRADLE_OPTS) rely on word-splitting, this is performed explicitly; +# see the in-line comments for details. +# +# There are tweaks for specific operating systems such as AIX, CygWin, +# Darwin, MinGW, and NonStop. +# +# (3) This script is generated from the Groovy template +# https://github.com/gradle/gradle/blob/master/subprojects/plugins/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt +# within the Gradle project. +# +# You can find Gradle at https://github.com/gradle/gradle/. +# ############################################################################## # Attempt to set APP_HOME + # Resolve links: $0 may be a link -PRG="$0" -# Need this for relative symlinks. -while [ -h "$PRG" ] ; do - ls=`ls -ld "$PRG"` - link=`expr "$ls" : '.*-> \(.*\)$'` - if expr "$link" : '/.*' > /dev/null; then - PRG="$link" - else - PRG=`dirname "$PRG"`"/$link" - fi +app_path=$0 + +# Need this for daisy-chained symlinks. +while + APP_HOME=${app_path%"${app_path##*/}"} # leaves a trailing /; empty if no leading path + [ -h "$app_path" ] +do + ls=$( ls -ld "$app_path" ) + link=${ls#*' -> '} + case $link in #( + /*) app_path=$link ;; #( + *) app_path=$APP_HOME$link ;; + esac done -SAVED="`pwd`" -cd "`dirname \"$PRG\"`/" >/dev/null -APP_HOME="`pwd -P`" -cd "$SAVED" >/dev/null + +APP_HOME=$( cd "${APP_HOME:-./}" && pwd -P ) || exit APP_NAME="Gradle" -APP_BASE_NAME=`basename "$0"` +APP_BASE_NAME=${0##*/} # Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"' # Use the maximum available, or set MAX_FD != -1 to use that value. -MAX_FD="maximum" +MAX_FD=maximum warn () { echo "$*" -} +} >&2 die () { echo echo "$*" echo exit 1 -} +} >&2 # OS specific support (must be 'true' or 'false'). cygwin=false msys=false darwin=false nonstop=false -case "`uname`" in - CYGWIN* ) - cygwin=true - ;; - Darwin* ) - darwin=true - ;; - MSYS* | MINGW* ) - msys=true - ;; - NONSTOP* ) - nonstop=true - ;; +case "$( uname )" in #( + CYGWIN* ) cygwin=true ;; #( + Darwin* ) darwin=true ;; #( + MSYS* | MINGW* ) msys=true ;; #( + NONSTOP* ) nonstop=true ;; esac CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar @@ -87,9 +121,9 @@ CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar if [ -n "$JAVA_HOME" ] ; then if [ -x "$JAVA_HOME/jre/sh/java" ] ; then # IBM's JDK on AIX uses strange locations for the executables - JAVACMD="$JAVA_HOME/jre/sh/java" + JAVACMD=$JAVA_HOME/jre/sh/java else - JAVACMD="$JAVA_HOME/bin/java" + JAVACMD=$JAVA_HOME/bin/java fi if [ ! -x "$JAVACMD" ] ; then die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME @@ -98,7 +132,7 @@ Please set the JAVA_HOME variable in your environment to match the location of your Java installation." fi else - JAVACMD="java" + JAVACMD=java which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. Please set the JAVA_HOME variable in your environment to match the @@ -106,80 +140,95 @@ location of your Java installation." fi # Increase the maximum file descriptors if we can. -if [ "$cygwin" = "false" -a "$darwin" = "false" -a "$nonstop" = "false" ] ; then - MAX_FD_LIMIT=`ulimit -H -n` - if [ $? -eq 0 ] ; then - if [ "$MAX_FD" = "maximum" -o "$MAX_FD" = "max" ] ; then - MAX_FD="$MAX_FD_LIMIT" - fi - ulimit -n $MAX_FD - if [ $? -ne 0 ] ; then - warn "Could not set maximum file descriptor limit: $MAX_FD" - fi - else - warn "Could not query maximum file descriptor limit: $MAX_FD_LIMIT" - fi +if ! "$cygwin" && ! "$darwin" && ! "$nonstop" ; then + case $MAX_FD in #( + max*) + MAX_FD=$( ulimit -H -n ) || + warn "Could not query maximum file descriptor limit" + esac + case $MAX_FD in #( + '' | soft) :;; #( + *) + ulimit -n "$MAX_FD" || + warn "Could not set maximum file descriptor limit to $MAX_FD" + esac fi -# For Darwin, add options to specify how the application appears in the dock -if $darwin; then - GRADLE_OPTS="$GRADLE_OPTS \"-Xdock:name=$APP_NAME\" \"-Xdock:icon=$APP_HOME/media/gradle.icns\"" -fi +# Collect all arguments for the java command, stacking in reverse order: +# * args from the command line +# * the main class name +# * -classpath +# * -D...appname settings +# * --module-path (only if needed) +# * DEFAULT_JVM_OPTS, JAVA_OPTS, and GRADLE_OPTS environment variables. # For Cygwin or MSYS, switch paths to Windows format before running java -if [ "$cygwin" = "true" -o "$msys" = "true" ] ; then - APP_HOME=`cygpath --path --mixed "$APP_HOME"` - CLASSPATH=`cygpath --path --mixed "$CLASSPATH"` - - JAVACMD=`cygpath --unix "$JAVACMD"` - - # We build the pattern for arguments to be converted via cygpath - ROOTDIRSRAW=`find -L / -maxdepth 1 -mindepth 1 -type d 2>/dev/null` - SEP="" - for dir in $ROOTDIRSRAW ; do - ROOTDIRS="$ROOTDIRS$SEP$dir" - SEP="|" - done - OURCYGPATTERN="(^($ROOTDIRS))" - # Add a user-defined pattern to the cygpath arguments - if [ "$GRADLE_CYGPATTERN" != "" ] ; then - OURCYGPATTERN="$OURCYGPATTERN|($GRADLE_CYGPATTERN)" - fi +if "$cygwin" || "$msys" ; then + APP_HOME=$( cygpath --path --mixed "$APP_HOME" ) + CLASSPATH=$( cygpath --path --mixed "$CLASSPATH" ) + + JAVACMD=$( cygpath --unix "$JAVACMD" ) + # Now convert the arguments - kludge to limit ourselves to /bin/sh - i=0 - for arg in "$@" ; do - CHECK=`echo "$arg"|egrep -c "$OURCYGPATTERN" -` - CHECK2=`echo "$arg"|egrep -c "^-"` ### Determine if an option - - if [ $CHECK -ne 0 ] && [ $CHECK2 -eq 0 ] ; then ### Added a condition - eval `echo args$i`=`cygpath --path --ignore --mixed "$arg"` - else - eval `echo args$i`="\"$arg\"" + for arg do + if + case $arg in #( + -*) false ;; # don't mess with options #( + /?*) t=${arg#/} t=/${t%%/*} # looks like a POSIX filepath + [ -e "$t" ] ;; #( + *) false ;; + esac + then + arg=$( cygpath --path --ignore --mixed "$arg" ) fi - i=`expr $i + 1` + # Roll the args list around exactly as many times as the number of + # args, so each arg winds up back in the position where it started, but + # possibly modified. + # + # NB: a `for` loop captures its iteration list before it begins, so + # changing the positional parameters here affects neither the number of + # iterations, nor the values presented in `arg`. + shift # remove old arg + set -- "$@" "$arg" # push replacement arg done - case $i in - 0) set -- ;; - 1) set -- "$args0" ;; - 2) set -- "$args0" "$args1" ;; - 3) set -- "$args0" "$args1" "$args2" ;; - 4) set -- "$args0" "$args1" "$args2" "$args3" ;; - 5) set -- "$args0" "$args1" "$args2" "$args3" "$args4" ;; - 6) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" ;; - 7) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" ;; - 8) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" ;; - 9) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" "$args8" ;; - esac fi -# Escape application args -save () { - for i do printf %s\\n "$i" | sed "s/'/'\\\\''/g;1s/^/'/;\$s/\$/' \\\\/" ; done - echo " " -} -APP_ARGS=`save "$@"` +# Collect all arguments for the java command; +# * $DEFAULT_JVM_OPTS, $JAVA_OPTS, and $GRADLE_OPTS can contain fragments of +# shell script including quotes and variable substitutions, so put them in +# double quotes to make sure that they get re-expanded; and +# * put everything else in single quotes, so that it's not re-expanded. + +set -- \ + "-Dorg.gradle.appname=$APP_BASE_NAME" \ + -classpath "$CLASSPATH" \ + org.gradle.wrapper.GradleWrapperMain \ + "$@" + +# Use "xargs" to parse quoted args. +# +# With -n1 it outputs one arg per line, with the quotes and backslashes removed. +# +# In Bash we could simply go: +# +# readarray ARGS < <( xargs -n1 <<<"$var" ) && +# set -- "${ARGS[@]}" "$@" +# +# but POSIX shell has neither arrays nor command substitution, so instead we +# post-process each arg (as a line of input to sed) to backslash-escape any +# character that might be a shell metacharacter, then use eval to reverse +# that process (while maintaining the separation between arguments), and wrap +# the whole thing up as a single "set" statement. +# +# This will of course break if any of these variables contains a newline or +# an unmatched quote. +# -# Collect all arguments for the java command, following the shell quoting and substitution rules -eval set -- $DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS "\"-Dorg.gradle.appname=$APP_BASE_NAME\"" -classpath "\"$CLASSPATH\"" org.gradle.wrapper.GradleWrapperMain "$APP_ARGS" +eval "set -- $( + printf '%s\n' "$DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS" | + xargs -n1 | + sed ' s~[^-[:alnum:]+,./:=@_]~\\&~g; ' | + tr '\n' ' ' + )" '"$@"' exec "$JAVACMD" "$@" diff --git a/sandbox/build.gradle.kts b/sandbox/build.gradle.kts index cb76d6b..674beca 100644 --- a/sandbox/build.gradle.kts +++ b/sandbox/build.gradle.kts @@ -1,5 +1,5 @@ plugins { - kotlin("jvm") version "1.5.30" + kotlin("jvm") version "1.6.10" application } diff --git a/settings.gradle.kts b/settings.gradle.kts index 2aa47f3..3e291f4 100644 --- a/settings.gradle.kts +++ b/settings.gradle.kts @@ -1,10 +1,17 @@ plugins { - id("de.fayard.refreshVersions") version "0.23.0" - id("com.gradle.enterprise") version "3.7.1" + id("de.fayard.refreshVersions") version "0.30.2" + id("com.gradle.enterprise") version "3.8" +} + +refreshVersions { + extraArtifactVersionKeyRules(rootDir.resolve("versions.rules")) } rootProject.name = "template-kmp-library" include(":test") -include(":lib:template-kmp-library-core", ":lib:template-kmp-library-dsl") +include( + ":lib:template-kmp-library-core", + ":lib:template-kmp-library-dsl" +) diff --git a/src/commonMain/kotlin/placeholder.kt b/src/commonMain/kotlin/placeholder.kt index 58a51c5..7e61819 100644 --- a/src/commonMain/kotlin/placeholder.kt +++ b/src/commonMain/kotlin/placeholder.kt @@ -1 +1 @@ -package dev.petuska.template.kmp.library +package dev.petuska.template.kmp.library diff --git a/versions.properties b/versions.properties index 0874cee..c01ea3b 100644 --- a/versions.properties +++ b/versions.properties @@ -1,5 +1,5 @@ #### Dependencies and Plugin versions with their available updates. -#### Generated by `./gradlew refreshVersions` version 0.23.0 +#### Generated by `./gradlew refreshVersions` version 0.30.2 #### #### Don't manually edit or split the comments that start with four hashtags (####), #### they will be overwritten by refreshVersions. @@ -8,12 +8,12 @@ #### suppress inspection "UnusedProperty" for whole file #======================================= Plugins ======================================== plugin.android=4.2.2 -version.com.diffplug.spotless..spotless-plugin-gradle=5.17.0 +version.klip=0.3.0 +version.ktlint=0.43.2 +version.com.diffplug.spotless..spotless-plugin-gradle=6.1.2 version.com.github.jakemarsden..git-hooks-gradle-plugin=0.0.2 -version.dev.petuska..klip=0.2.2 -version.dev.petuska..klip-gradle-plugin=0.2.2 version.io.github.gradle-nexus..publish-plugin=1.1.0 -version.org.jetbrains.dokka..dokka-gradle-plugin=1.5.31 +version.org.jetbrains.dokka..dokka-gradle-plugin=1.6.10 #====================================== Libraries ======================================= -version.kotlin=1.5.31 -version.kotlinx.coroutines=1.5.2 +version.kotlin=1.6.10 +version.kotlinx.coroutines=1.6.0 diff --git a/versions.rules b/versions.rules new file mode 100644 index 0000000..15556db --- /dev/null +++ b/versions.rules @@ -0,0 +1,2 @@ +dev.petuska:klip(-*) + ^^^^