├── .github └── workflows │ └── build.yml ├── .gitignore ├── README.md ├── api-to-use ├── build.gradle └── src │ └── main │ └── kotlin │ └── api.kt ├── build.gradle ├── create-plugin ├── build.gradle └── src │ └── main │ ├── kotlin │ └── SerialNamePlugin.kt │ └── resources │ └── META-INF │ └── services │ └── org.jetbrains.kotlin.compiler.plugin.ComponentRegistrar ├── gradle.properties ├── gradle └── wrapper │ ├── gradle-wrapper.jar │ └── gradle-wrapper.properties ├── gradlew ├── gradlew.bat ├── settings.gradle └── use-plugin ├── build.gradle └── src └── main └── kotlin └── Main.kt /.github/workflows/build.yml: -------------------------------------------------------------------------------- 1 | name: Build 2 | 3 | on: pull_request 4 | 5 | jobs: 6 | build: 7 | 8 | runs-on: ubuntu-latest 9 | env: 10 | JAVA_OPTS: -Xms512m -Xmx1024m 11 | 12 | steps: 13 | - name: "Set env" 14 | run: | 15 | echo "$JAVA_HOME_8_X64/bin" >> $GITHUB_PATH 16 | echo "JAVA_HOME=$JAVA_HOME_8_X64" >> $GITHUB_ENV 17 | - uses: actions/checkout@v2 18 | - name: "Build example: Hello World" 19 | working-directory: hello-world 20 | run: | 21 | ./gradlew clean build 22 | java -jar use-plugin/build/libs/use-plugin.jar 23 | - name: "Build example: use of Arrow Meta Compiler Plugin with Gradle Plugin" 24 | working-directory: use-arrow-meta-compiler-plugin 25 | run: ./gradlew clean build 26 | - name: "Build example: create new plugin to generate sources" 27 | working-directory: generate-sources 28 | run: ./gradlew clean build 29 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | .idea 2 | .gradle 3 | *.iml 4 | build 5 | *.meta 6 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Serial name plugin for kotlinx.serialization 2 | 3 | This project has a source code for the following article: [Arrow Meta and solving the issues of Kotlin serialization library by writing a compiler plugin](https://paranoidmonoid.github.io/articles/Kotlin%20and%20friends/Naming%20strategy%20plugin) 4 | 5 | This project is based on https://github.com/arrow-kt/arrow-meta-examples repository and uses Arrow meta 6 | 7 | The structure of repository is as follows: 8 | - `create-plugin` directory for the plugin itself 9 | - `use-plugin` for the sample usage. Can be run via main function as usual. 10 | -------------------------------------------------------------------------------- /api-to-use/build.gradle: -------------------------------------------------------------------------------- 1 | plugins { 2 | id 'org.jetbrains.kotlin.jvm' 3 | } -------------------------------------------------------------------------------- /api-to-use/src/main/kotlin/api.kt: -------------------------------------------------------------------------------- 1 | annotation class SerializeWithStrategy(val strategy: SerializationStrategy) 2 | 3 | enum class SerializationStrategy { 4 | SnakeCase, KebabCase 5 | } -------------------------------------------------------------------------------- /build.gradle: -------------------------------------------------------------------------------- 1 | plugins { 2 | id "org.jetbrains.kotlin.jvm" version "$KOTLIN_VERSION" apply false 3 | } 4 | 5 | allprojects { 6 | repositories { 7 | mavenCentral() 8 | maven { url 'https://oss.sonatype.org/content/repositories/snapshots/' } 9 | } 10 | } 11 | -------------------------------------------------------------------------------- /create-plugin/build.gradle: -------------------------------------------------------------------------------- 1 | import java.nio.file.Paths 2 | 3 | plugins { 4 | id "org.jetbrains.kotlin.jvm" 5 | } 6 | 7 | dependencies { 8 | compileOnly "org.jetbrains.kotlin:kotlin-compiler-embeddable:$KOTLIN_VERSION" 9 | compileOnly "io.arrow-kt:compiler-plugin:$ARROW_META_VERSION" 10 | compileOnly project(':api-to-use') 11 | } 12 | 13 | compileKotlin { 14 | kotlinOptions { 15 | jvmTarget = "$JVM_TARGET_VERSION" 16 | } 17 | } 18 | 19 | jar { 20 | from ( 21 | zipTree(sourceSets.main.compileClasspath.find { 22 | it.absolutePath.contains(Paths.get("arrow-kt","compiler-plugin").toString()) 23 | }) 24 | ) { 25 | exclude 'META-INF/services/org.jetbrains.kotlin.compiler.plugin.ComponentRegistrar' 26 | } 27 | } 28 | -------------------------------------------------------------------------------- /create-plugin/src/main/kotlin/SerialNamePlugin.kt: -------------------------------------------------------------------------------- 1 | import arrow.meta.CliPlugin 2 | import arrow.meta.Meta 3 | import arrow.meta.invoke 4 | import arrow.meta.phases.CompilerContext 5 | import arrow.meta.phases.analysis.isAnnotatedWith 6 | import arrow.meta.quotes.Transform 7 | import arrow.meta.quotes.classDeclaration 8 | import org.jetbrains.kotlin.psi.psiUtil.getValueParameters 9 | 10 | class SerialNamePlugin : Meta { 11 | override fun intercept(ctx: CompilerContext): List = 12 | listOf( 13 | customAnnotationSerialNamePlugin 14 | ) 15 | } 16 | 17 | val Meta.serialNamePlugin: CliPlugin 18 | get() = 19 | "Serial Name Plugin" { 20 | meta( 21 | classDeclaration(this, { isAnnotatedWith("@Serializable".toRegex()) }) { classElement -> 22 | val skip = value.getValueParameters().all { it.isAnnotatedWith(".*SerialName.*".toRegex()) } 23 | val paramList = value.getValueParameters() 24 | .map { "@kotlinx.serialization.SerialName(\"${it.name?.toSnakeCase()}\") ${it.text}" } 25 | val paramListString = paramList.joinToString(", ", "(", ")") 26 | val annotations = classElement.annotationEntries.joinToString("\n") { it.text } 27 | val newDeclaration = """ 28 | |$annotations $kind $name$`(typeParameters)`$paramListString { 29 | | $body 30 | |} 31 | """.trimMargin() 32 | Transform.replace(classElement, if (skip) this else newDeclaration.`class`.syntheticScope) 33 | } 34 | ) 35 | } 36 | 37 | val Meta.customAnnotationSerialNamePlugin: CliPlugin 38 | get() = 39 | "Serial Name With Strategy" { 40 | meta( 41 | classDeclaration(this, { isAnnotatedWith("@SerializeWithStrategy\\(.+\\)".toRegex()) }) { classElement -> 42 | val annotation = classElement.annotationEntries.first { 43 | it.text?.contains("SerializeWithStrategy") == true 44 | } 45 | val case = annotation.valueArguments 46 | .first() 47 | .getArgumentExpression()!! 48 | .text 49 | .removePrefix("SerializationStrategy.") 50 | val caseFunction = when(case) { 51 | "KebabCase" -> String::toKebabCase 52 | "SnakeCase" -> String::toSnakeCase 53 | else -> error("Unexpected strategy") 54 | } 55 | val paramList = value.getValueParameters() 56 | .map { if (it.isAnnotatedWith("@(kotlinx\\.serialization\\.)?SerialName\\(.+\\)".toRegex())) it.text else "@kotlinx.serialization.SerialName(\"${it.name?.let(caseFunction)}\") ${it.text}" } 57 | val paramListString = paramList.joinToString(", ", "(", ")") 58 | val annotations = classElement.annotationEntries.joinToString(" ") { it.text } // workaround to avoid arrow-meta issue 59 | 60 | val newDeclaration = """ 61 | |$annotations $kind $name$`(typeParameters)`$paramListString { 62 | | $body 63 | |} 64 | """.trimMargin() 65 | // check(false) {newDeclaration} 66 | Transform.replace(classElement, newDeclaration.`class`.syntheticScope) 67 | } 68 | ) 69 | } 70 | 71 | 72 | fun String.toSnakeCase() = splitToWords().joinToString("_").lowercase() 73 | fun String.toKebabCase() = splitToWords().joinToString("-").lowercase() 74 | 75 | // https://stackoverflow.com/questions/7593969/regex-to-split-camelcase-or-titlecase-advanced#comment57838106_7599674 76 | private fun String.splitToWords() = 77 | split("(?<=[a-z])(?=[A-Z])|(?<=[A-Z])(?=[A-Z][a-z])|(?<=[0-9])(?=[A-Z][a-z])|(?<=[a-zA-Z])(?=[0-9])".toRegex()) -------------------------------------------------------------------------------- /create-plugin/src/main/resources/META-INF/services/org.jetbrains.kotlin.compiler.plugin.ComponentRegistrar: -------------------------------------------------------------------------------- 1 | SerialNamePlugin -------------------------------------------------------------------------------- /gradle.properties: -------------------------------------------------------------------------------- 1 | KOTLIN_VERSION=1.5.31 2 | JVM_TARGET_VERSION=1.8 3 | ARROW_VERSION=1.0.0 4 | ARROW_META_VERSION=1.5.0-RC-SNAPSHOT 5 | -------------------------------------------------------------------------------- /gradle/wrapper/gradle-wrapper.jar: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/paranoidmonoid/kotlin-serial-name/166a318191a0e2aca42dd114e29e5e68f1f8a2e8/gradle/wrapper/gradle-wrapper.jar -------------------------------------------------------------------------------- /gradle/wrapper/gradle-wrapper.properties: -------------------------------------------------------------------------------- 1 | distributionBase=GRADLE_USER_HOME 2 | distributionPath=wrapper/dists 3 | distributionUrl=https\://services.gradle.org/distributions/gradle-7.1-bin.zip 4 | zipStoreBase=GRADLE_USER_HOME 5 | zipStorePath=wrapper/dists 6 | -------------------------------------------------------------------------------- /gradlew: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env sh 2 | 3 | # 4 | # Copyright 2015 the original author or authors. 5 | # 6 | # Licensed under the Apache License, Version 2.0 (the "License"); 7 | # you may not use this file except in compliance with the License. 8 | # You may obtain a copy of the License at 9 | # 10 | # https://www.apache.org/licenses/LICENSE-2.0 11 | # 12 | # Unless required by applicable law or agreed to in writing, software 13 | # distributed under the License is distributed on an "AS IS" BASIS, 14 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 15 | # See the License for the specific language governing permissions and 16 | # limitations under the License. 17 | # 18 | 19 | ############################################################################## 20 | ## 21 | ## Gradle start up script for UN*X 22 | ## 23 | ############################################################################## 24 | 25 | # Attempt to set APP_HOME 26 | # Resolve links: $0 may be a link 27 | PRG="$0" 28 | # Need this for relative symlinks. 29 | while [ -h "$PRG" ] ; do 30 | ls=`ls -ld "$PRG"` 31 | link=`expr "$ls" : '.*-> \(.*\)$'` 32 | if expr "$link" : '/.*' > /dev/null; then 33 | PRG="$link" 34 | else 35 | PRG=`dirname "$PRG"`"/$link" 36 | fi 37 | done 38 | SAVED="`pwd`" 39 | cd "`dirname \"$PRG\"`/" >/dev/null 40 | APP_HOME="`pwd -P`" 41 | cd "$SAVED" >/dev/null 42 | 43 | APP_NAME="Gradle" 44 | APP_BASE_NAME=`basename "$0"` 45 | 46 | # Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. 47 | DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"' 48 | 49 | # Use the maximum available, or set MAX_FD != -1 to use that value. 50 | MAX_FD="maximum" 51 | 52 | warn () { 53 | echo "$*" 54 | } 55 | 56 | die () { 57 | echo 58 | echo "$*" 59 | echo 60 | exit 1 61 | } 62 | 63 | # OS specific support (must be 'true' or 'false'). 64 | cygwin=false 65 | msys=false 66 | darwin=false 67 | nonstop=false 68 | case "`uname`" in 69 | CYGWIN* ) 70 | cygwin=true 71 | ;; 72 | Darwin* ) 73 | darwin=true 74 | ;; 75 | MSYS* | MINGW* ) 76 | msys=true 77 | ;; 78 | NONSTOP* ) 79 | nonstop=true 80 | ;; 81 | esac 82 | 83 | CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar 84 | 85 | 86 | # Determine the Java command to use to start the JVM. 87 | if [ -n "$JAVA_HOME" ] ; then 88 | if [ -x "$JAVA_HOME/jre/sh/java" ] ; then 89 | # IBM's JDK on AIX uses strange locations for the executables 90 | JAVACMD="$JAVA_HOME/jre/sh/java" 91 | else 92 | JAVACMD="$JAVA_HOME/bin/java" 93 | fi 94 | if [ ! -x "$JAVACMD" ] ; then 95 | die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME 96 | 97 | Please set the JAVA_HOME variable in your environment to match the 98 | location of your Java installation." 99 | fi 100 | else 101 | JAVACMD="java" 102 | which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. 103 | 104 | Please set the JAVA_HOME variable in your environment to match the 105 | location of your Java installation." 106 | fi 107 | 108 | # Increase the maximum file descriptors if we can. 109 | if [ "$cygwin" = "false" -a "$darwin" = "false" -a "$nonstop" = "false" ] ; then 110 | MAX_FD_LIMIT=`ulimit -H -n` 111 | if [ $? -eq 0 ] ; then 112 | if [ "$MAX_FD" = "maximum" -o "$MAX_FD" = "max" ] ; then 113 | MAX_FD="$MAX_FD_LIMIT" 114 | fi 115 | ulimit -n $MAX_FD 116 | if [ $? -ne 0 ] ; then 117 | warn "Could not set maximum file descriptor limit: $MAX_FD" 118 | fi 119 | else 120 | warn "Could not query maximum file descriptor limit: $MAX_FD_LIMIT" 121 | fi 122 | fi 123 | 124 | # For Darwin, add options to specify how the application appears in the dock 125 | if $darwin; then 126 | GRADLE_OPTS="$GRADLE_OPTS \"-Xdock:name=$APP_NAME\" \"-Xdock:icon=$APP_HOME/media/gradle.icns\"" 127 | fi 128 | 129 | # For Cygwin or MSYS, switch paths to Windows format before running java 130 | if [ "$cygwin" = "true" -o "$msys" = "true" ] ; then 131 | APP_HOME=`cygpath --path --mixed "$APP_HOME"` 132 | CLASSPATH=`cygpath --path --mixed "$CLASSPATH"` 133 | 134 | JAVACMD=`cygpath --unix "$JAVACMD"` 135 | 136 | # We build the pattern for arguments to be converted via cygpath 137 | ROOTDIRSRAW=`find -L / -maxdepth 1 -mindepth 1 -type d 2>/dev/null` 138 | SEP="" 139 | for dir in $ROOTDIRSRAW ; do 140 | ROOTDIRS="$ROOTDIRS$SEP$dir" 141 | SEP="|" 142 | done 143 | OURCYGPATTERN="(^($ROOTDIRS))" 144 | # Add a user-defined pattern to the cygpath arguments 145 | if [ "$GRADLE_CYGPATTERN" != "" ] ; then 146 | OURCYGPATTERN="$OURCYGPATTERN|($GRADLE_CYGPATTERN)" 147 | fi 148 | # Now convert the arguments - kludge to limit ourselves to /bin/sh 149 | i=0 150 | for arg in "$@" ; do 151 | CHECK=`echo "$arg"|egrep -c "$OURCYGPATTERN" -` 152 | CHECK2=`echo "$arg"|egrep -c "^-"` ### Determine if an option 153 | 154 | if [ $CHECK -ne 0 ] && [ $CHECK2 -eq 0 ] ; then ### Added a condition 155 | eval `echo args$i`=`cygpath --path --ignore --mixed "$arg"` 156 | else 157 | eval `echo args$i`="\"$arg\"" 158 | fi 159 | i=`expr $i + 1` 160 | done 161 | case $i in 162 | 0) set -- ;; 163 | 1) set -- "$args0" ;; 164 | 2) set -- "$args0" "$args1" ;; 165 | 3) set -- "$args0" "$args1" "$args2" ;; 166 | 4) set -- "$args0" "$args1" "$args2" "$args3" ;; 167 | 5) set -- "$args0" "$args1" "$args2" "$args3" "$args4" ;; 168 | 6) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" ;; 169 | 7) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" ;; 170 | 8) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" ;; 171 | 9) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" "$args8" ;; 172 | esac 173 | fi 174 | 175 | # Escape application args 176 | save () { 177 | for i do printf %s\\n "$i" | sed "s/'/'\\\\''/g;1s/^/'/;\$s/\$/' \\\\/" ; done 178 | echo " " 179 | } 180 | APP_ARGS=`save "$@"` 181 | 182 | # Collect all arguments for the java command, following the shell quoting and substitution rules 183 | eval set -- $DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS "\"-Dorg.gradle.appname=$APP_BASE_NAME\"" -classpath "\"$CLASSPATH\"" org.gradle.wrapper.GradleWrapperMain "$APP_ARGS" 184 | 185 | exec "$JAVACMD" "$@" 186 | -------------------------------------------------------------------------------- /gradlew.bat: -------------------------------------------------------------------------------- 1 | @rem 2 | @rem Copyright 2015 the original author or authors. 3 | @rem 4 | @rem Licensed under the Apache License, Version 2.0 (the "License"); 5 | @rem you may not use this file except in compliance with the License. 6 | @rem You may obtain a copy of the License at 7 | @rem 8 | @rem https://www.apache.org/licenses/LICENSE-2.0 9 | @rem 10 | @rem Unless required by applicable law or agreed to in writing, software 11 | @rem distributed under the License is distributed on an "AS IS" BASIS, 12 | @rem WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | @rem See the License for the specific language governing permissions and 14 | @rem limitations under the License. 15 | @rem 16 | 17 | @if "%DEBUG%" == "" @echo off 18 | @rem ########################################################################## 19 | @rem 20 | @rem Gradle startup script for Windows 21 | @rem 22 | @rem ########################################################################## 23 | 24 | @rem Set local scope for the variables with windows NT shell 25 | if "%OS%"=="Windows_NT" setlocal 26 | 27 | set DIRNAME=%~dp0 28 | if "%DIRNAME%" == "" set DIRNAME=. 29 | set APP_BASE_NAME=%~n0 30 | set APP_HOME=%DIRNAME% 31 | 32 | @rem Resolve any "." and ".." in APP_HOME to make it shorter. 33 | for %%i in ("%APP_HOME%") do set APP_HOME=%%~fi 34 | 35 | @rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. 36 | set DEFAULT_JVM_OPTS="-Xmx64m" "-Xms64m" 37 | 38 | @rem Find java.exe 39 | if defined JAVA_HOME goto findJavaFromJavaHome 40 | 41 | set JAVA_EXE=java.exe 42 | %JAVA_EXE% -version >NUL 2>&1 43 | if "%ERRORLEVEL%" == "0" goto execute 44 | 45 | echo. 46 | echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. 47 | echo. 48 | echo Please set the JAVA_HOME variable in your environment to match the 49 | echo location of your Java installation. 50 | 51 | goto fail 52 | 53 | :findJavaFromJavaHome 54 | set JAVA_HOME=%JAVA_HOME:"=% 55 | set JAVA_EXE=%JAVA_HOME%/bin/java.exe 56 | 57 | if exist "%JAVA_EXE%" goto execute 58 | 59 | echo. 60 | echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% 61 | echo. 62 | echo Please set the JAVA_HOME variable in your environment to match the 63 | echo location of your Java installation. 64 | 65 | goto fail 66 | 67 | :execute 68 | @rem Setup the command line 69 | 70 | set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar 71 | 72 | 73 | @rem Execute Gradle 74 | "%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %* 75 | 76 | :end 77 | @rem End local scope for the variables with windows NT shell 78 | if "%ERRORLEVEL%"=="0" goto mainEnd 79 | 80 | :fail 81 | rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of 82 | rem the _cmd.exe /c_ return code! 83 | if not "" == "%GRADLE_EXIT_CONSOLE%" exit 1 84 | exit /b 1 85 | 86 | :mainEnd 87 | if "%OS%"=="Windows_NT" endlocal 88 | 89 | :omega 90 | -------------------------------------------------------------------------------- /settings.gradle: -------------------------------------------------------------------------------- 1 | include ':create-plugin' 2 | include ':use-plugin' 3 | include ':api-to-use' -------------------------------------------------------------------------------- /use-plugin/build.gradle: -------------------------------------------------------------------------------- 1 | plugins { 2 | id "org.jetbrains.kotlin.jvm" 3 | id 'org.jetbrains.kotlin.plugin.serialization' version '1.5.31' 4 | } 5 | 6 | dependencies { 7 | compileOnly "io.arrow-kt:arrow-annotations:$ARROW_VERSION" 8 | implementation('org.jetbrains.kotlinx:kotlinx-serialization-json:1.3.0') 9 | implementation project(":api-to-use") 10 | } 11 | 12 | compileKotlin { 13 | kotlinOptions { 14 | jvmTarget = "$JVM_TARGET_VERSION" 15 | freeCompilerArgs = ["-Xplugin=${rootDir}/create-plugin/build/libs/create-plugin.jar"] 16 | } 17 | } 18 | 19 | tasks.withType(org.jetbrains.kotlin.gradle.tasks.KotlinCompile) { 20 | compileTask -> compileTask.dependsOn ":create-plugin:assemble" 21 | } 22 | -------------------------------------------------------------------------------- /use-plugin/src/main/kotlin/Main.kt: -------------------------------------------------------------------------------- 1 | import kotlinx.serialization.Serializable 2 | import kotlinx.serialization.encodeToString 3 | import kotlinx.serialization.json.Json 4 | 5 | @Serializable 6 | @SerializeWithStrategy(SerializationStrategy.KebabCase) 7 | data class Cat(val name: String, val age: Int, val ownerName: String, val breed: String) 8 | 9 | @Serializable 10 | @SerializeWithStrategy(SerializationStrategy.SnakeCase) 11 | data class Dog(val name: String, val age: Int, val ownerName: String, val breed: String) 12 | 13 | fun main() { 14 | val cat = Cat("Chonk", 3, "Max", "British Shorthair") 15 | val dog = Dog("Puff", 3, "Max", "Shiba Inu") 16 | println(Json.encodeToString(cat)) 17 | println(Json.encodeToString(dog)) 18 | } 19 | --------------------------------------------------------------------------------