├── .github ├── dependabot.yml └── workflows │ ├── gradle.yml │ └── update-gradle-wrapper.yml ├── .gitignore ├── LICENSE ├── Readme.md ├── build.gradle.kts ├── compiler-plugin ├── .gitignore ├── build.gradle.kts └── src │ └── main │ └── java │ └── de │ └── jensklingenberg │ ├── CommonComponentRegistrar.kt │ ├── DebugLogger.kt │ ├── ExampleCommandLineProcessor.kt │ └── transform │ ├── CreateFuncTransformer.kt │ ├── ElementTransformer.kt │ └── ExampleIrGenerationExtension.kt ├── docs └── screenshot.png ├── gradle-plugin ├── build.gradle.kts └── src │ └── main │ └── java │ └── de │ └── jensklingenberg │ └── gradle │ └── HelloWorldGradleSubplugin.kt ├── gradle.properties ├── gradle ├── libs.versions.toml └── wrapper │ ├── gradle-wrapper.jar │ └── gradle-wrapper.properties ├── gradlew ├── gradlew.bat ├── lib ├── build.gradle.kts └── src │ ├── commonMain │ └── kotlin │ │ └── sample │ │ └── Sample.kt │ ├── jsMain │ └── kotlin │ │ └── sample │ │ └── SampleJs.kt │ ├── jvmMain │ └── kotlin │ │ └── sample │ │ └── SampleJvm.kt │ ├── linuxMain │ └── kotlin │ │ └── sample │ │ └── SampleLinux.kt │ └── linuxTest │ └── kotlin │ └── sample │ └── SampleTestsNative.kt └── settings.gradle.kts /.github/dependabot.yml: -------------------------------------------------------------------------------- 1 | # Documentation for all configuration options: 2 | # https://help.github.com/github/administering-a-repository/configuration-options-for-dependency-updates 3 | 4 | version: 2 5 | updates: 6 | # Updates for Github Actions used in the repo 7 | - package-ecosystem: "github-actions" 8 | directory: "/" 9 | schedule: 10 | interval: "weekly" 11 | # Updates for Gradle dependencies used in the app 12 | - package-ecosystem: gradle 13 | directory: "/" 14 | schedule: 15 | interval: "weekly" 16 | open-pull-requests-limit: 2 17 | -------------------------------------------------------------------------------- /.github/workflows/gradle.yml: -------------------------------------------------------------------------------- 1 | name: Java CI 2 | 3 | on: [push] 4 | 5 | jobs: 6 | build: 7 | 8 | runs-on: ubuntu-latest 9 | 10 | steps: 11 | - uses: actions/checkout@v4 12 | - name: Set up JDK 1.8 13 | uses: actions/setup-java@v4 14 | with: 15 | java-version: '11' 16 | distribution: 'zulu' 17 | - name: Build with Gradle 18 | run: ./gradlew clean build 19 | -------------------------------------------------------------------------------- /.github/workflows/update-gradle-wrapper.yml: -------------------------------------------------------------------------------- 1 | name: Update Gradle Wrapper 2 | 3 | on: 4 | workflow_dispatch: 5 | schedule: 6 | - cron: "0 0 * * *" 7 | 8 | jobs: 9 | update-gradle-wrapper: 10 | 11 | runs-on: ubuntu-latest 12 | 13 | steps: 14 | - name: Install JDK 21 15 | uses: actions/setup-java@v4 16 | with: 17 | distribution: 'temurin' 18 | java-version: 21 19 | - uses: actions/checkout@v4 20 | - name: Update Gradle Wrapper 21 | uses: gradle-update/update-gradle-wrapper-action@v2 22 | with: 23 | merge-method: SQUASH 24 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | /build 2 | /.gradle 3 | .idea 4 | /lib/build/ 5 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "[]" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright [yyyy] [name of copyright owner] 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | -------------------------------------------------------------------------------- /Readme.md: -------------------------------------------------------------------------------- 1 | 2 |

KotlinCompilerPluginExample

3 | 4 | [![jCenter](https://img.shields.io/badge/Apache-2.0-green.svg 5 | )](https://github.com/Foso/KotlinReactNativeMpp/blob/master/LICENSE) 6 | [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](http://makeapullrequest.com) 7 | [![jCenter](https://img.shields.io/badge/Kotlin-2.0.0-green.svg 8 | )](https://github.com/Foso/Sheasy/blob/master/LICENSE) 9 | 10 | 11 | 12 | ## Introduction 🙋‍♂️ 13 | 14 | This is an example project that shows how to create a Kotlin Compiler Plugin. At compile time a gradle plugin will trigger the compiler plugin. The plugin will print "Hello from" and the name of the file that is being compiled, as a compiler warning to the terminal log. 15 | 16 |

17 | 18 | 19 |

20 | 21 | ### Show some :heart: and star the repo to support the project 22 | 23 | [![GitHub stars](https://img.shields.io/github/stars/Foso/KotlinCompilerPluginExample.svg?style=social&label=Star)](https://github.com/Foso/KotlinCompilerPluginExample) [![GitHub forks](https://img.shields.io/github/forks/Foso/KotlinCompilerPluginExample.svg?style=social&label=Fork)](https://github.com/Foso/KotlinCompilerPluginExample/fork) [![GitHub watchers](https://img.shields.io/github/watchers/Foso/KotlinCompilerPluginExample.svg?style=social&label=Watch)](https://github.com/Foso/KotlinCompilerPluginExample) [![Twitter Follow](https://img.shields.io/twitter/follow/jklingenberg_.svg?style=social)](https://twitter.com/jklingenberg_) 24 | 25 | 26 | ## Usage 27 | 28 | > :information_source: Please be aware that the Kotlin Compiler still doesn't have any stable API and there is no 29 | > backwards compatibility guaranteed. Kotlin versions above 1.9.23 can have a totally different API. 30 | 31 | * Inside the project folder run `./gradlew clean build` 32 | 33 | The plugin is only active when the build cache is changed. This is why you need to run "clean" before building, when you want to see the log output again. 34 | 35 | ### 👷 Project Structure 36 | * lib - A Kotlin Multiplatform project which applies a gradle plugin(compiler.plugin.helloworld) which triggers the compiler plugin. 37 | * compiler-plugin - This module contains the Kotlin Compiler Plugin 38 | * gradle-plugin - This module contains the gradle plugin which trigger the compiler plugin 39 | 40 | ## Useful resources 41 | [The Road to the New Kotlin Compiler](https://www.youtube.com/watch?v=iTdJJq_LyoY) 42 | 43 | [https://github.com/bnorm/kotlin-ir-plugin-template](https://github.com/bnorm/kotlin-ir-plugin-template) 44 | 45 | [Writing Your Second Kotlin Compiler Plugin, Part 1 — Project Setup](https://blog.bnorm.dev/writing-your-second-compiler-plugin-part-1) 46 | 47 | [Experimenting with the Kotlin Compiler by Jossi Wolf, Snapp Mobile EN](https://www.youtube.com/watch?v=Y6gEA-nS2uQ) 48 | 49 | [Crash course on the Kotlin compiler | 1. Frontend: Parsing phase](https://medium.com/google-developer-experts/crash-course-on-the-kotlin-compiler-1-frontend-parsing-phase-9898490d922b) 50 | 51 | ## ✍️ Feedback 52 | 53 | Feel free to send feedback on [Twitter](https://twitter.com/jklingenberg_) or [file an issue](https://github.com/foso/KotlinCompilerPluginExample/issues/new). Feature requests are always welcome. 54 | 55 | 56 | ### Find this project useful ? :heart: 57 | * Support it by clicking the :star: button on the upper right of this page. :v: 58 | 59 | ## 📜 License 60 | 61 | ------- 62 | 63 | This project is licensed under Apache License, Version 2.0 64 | 65 | Copyright 2019 Jens Klingenberg 66 | 67 | Licensed under the Apache License, Version 2.0 (the "License"); 68 | you may not use this file except in compliance with the License. 69 | You may obtain a copy of the License at 70 | 71 | http://www.apache.org/licenses/LICENSE-2.0 72 | 73 | Unless required by applicable law or agreed to in writing, software 74 | distributed under the License is distributed on an "AS IS" BASIS, 75 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 76 | See the License for the specific language governing permissions and 77 | limitations under the License. 78 | 79 | 80 | ## Acknowledgments 81 | Projects that helped me understand how to setup the project: 82 | * [kevinmost/debuglog](https://github.com/kevinmost/debuglog) 83 | * [ZacSweers/redacted-compiler-plugin](https://github.com/ZacSweers/redacted-compiler-plugin) 84 | * [hotchemi/kotlin-compiler-plugin-example 85 | ](https://github.com/hotchemi/kotlin-compiler-plugin-example) 86 | * [Takhion/sample-kotlin-compiler-plugin](https://github.com/Takhion/sample-kotlin-compiler-plugin) 87 | -------------------------------------------------------------------------------- /build.gradle.kts: -------------------------------------------------------------------------------- 1 | import org.gradle.kotlin.dsl.libs 2 | 3 | buildscript { 4 | 5 | repositories { 6 | mavenLocal() 7 | google() 8 | mavenCentral() 9 | } 10 | 11 | dependencies { 12 | classpath("com.vanniktech:gradle-maven-publish-plugin:0.25.3") 13 | classpath("de.jensklingenberg:gradle-plugin:1.0.0") 14 | } 15 | } 16 | plugins { 17 | id("org.jetbrains.kotlin.multiplatform") version libs.versions.kotlin apply false 18 | } 19 | apply(plugin = "compiler.gradleplugin.helloworld") 20 | 21 | System.setProperty("kotlin.compiler.execution.strategy", "in-process") // For debugging 22 | 23 | 24 | allprojects { 25 | repositories { 26 | mavenLocal() 27 | mavenCentral() 28 | maven("https://maven.google.com") 29 | maven("https://plugins.gradle.org/m2/") 30 | google() 31 | } 32 | } 33 | 34 | -------------------------------------------------------------------------------- /compiler-plugin/.gitignore: -------------------------------------------------------------------------------- 1 | /build 2 | -------------------------------------------------------------------------------- /compiler-plugin/build.gradle.kts: -------------------------------------------------------------------------------- 1 | import org.jetbrains.kotlin.gradle.tasks.KotlinCompilationTask 2 | import org.jetbrains.kotlin.gradle.tasks.KotlinCompile 3 | 4 | plugins { 5 | kotlin("jvm") version("2.0.0") 6 | kotlin("kapt") version("2.0.0") 7 | id("com.vanniktech.maven.publish") version("0.23.1") 8 | `maven-publish` 9 | signing 10 | 11 | } 12 | 13 | allprojects { 14 | repositories { 15 | mavenLocal() 16 | mavenCentral() 17 | maven("https://maven.google.com") 18 | maven("https://plugins.gradle.org/m2/") 19 | google() 20 | } 21 | } 22 | 23 | mavenPublishing { 24 | publishToMavenCentral() 25 | 26 | } 27 | 28 | group = "de.jensklingenberg" 29 | version = "0.0.1" 30 | val autoService = "1.1.1" 31 | dependencies { 32 | compileOnly("com.google.auto.service:auto-service:$autoService") 33 | kapt("com.google.auto.service:auto-service:$autoService") 34 | compileOnly("org.jetbrains.kotlin:kotlin-compiler-embeddable:2.0.0") 35 | testImplementation("dev.zacsweers.kctfork:core:0.4.1") 36 | testImplementation("junit:junit:4.13.2") 37 | testImplementation("com.google.truth:truth:1.4.2") 38 | testImplementation(kotlin("reflect")) 39 | 40 | } 41 | 42 | publishing { 43 | publications { 44 | create("default") { 45 | from(components["java"]) 46 | 47 | pom { 48 | name.set("compiler-plugin") 49 | description.set("Hello World Compiler Plugin") 50 | url.set("https://github.com/Foso/KotlinCompilerPluginExample") 51 | 52 | licenses { 53 | license { 54 | name.set("Apache License 2.0") 55 | url.set("https://github.com/Foso/KotlinCompilerPluginExample/blob/master/LICENSE.txt") 56 | } 57 | } 58 | scm { 59 | url.set("https://github.com/Foso/KotlinCompilerPluginExample") 60 | connection.set("scm:git:git://github.com/Foso/KotlinCompilerPluginExample.git") 61 | } 62 | developers { 63 | developer { 64 | name.set("Developer Name") 65 | url.set("Developer URL") 66 | } 67 | } 68 | } 69 | } 70 | } 71 | 72 | repositories { 73 | if ( 74 | hasProperty("sonatypeUsername") && 75 | hasProperty("sonatypePassword") && 76 | hasProperty("sonatypeSnapshotUrl") && 77 | hasProperty("sonatypeReleaseUrl") 78 | ) { 79 | maven { 80 | val url = when { 81 | "SNAPSHOT" in version.toString() -> property("sonatypeSnapshotUrl") 82 | else -> property("sonatypeReleaseUrl") 83 | } as String 84 | setUrl(url) 85 | credentials { 86 | username = property("sonatypeUsername") as String 87 | password = property("sonatypePassword") as String 88 | } 89 | } 90 | } 91 | } 92 | } 93 | 94 | java { 95 | toolchain { 96 | languageVersion.set(JavaLanguageVersion.of(8)) 97 | } 98 | } 99 | 100 | tasks.withType { 101 | kotlinOptions.jvmTarget = "1.8" 102 | } 103 | tasks.withType>().configureEach { 104 | compilerOptions.freeCompilerArgs.add("-opt-in=org.jetbrains.kotlin.compiler.plugin.ExperimentalCompilerApi") 105 | } 106 | 107 | //./gradlew clean :lib:compileKotlinJvm --no-daemon -Dorg.gradle.debug=true -Dkotlin.compiler.execution.strategy="in-process" -Dkotlin.daemon.jvm.options="-Xdebug,-Xrunjdwp:transport=dt_socket,address=5005,server=y,suspend=n" 108 | -------------------------------------------------------------------------------- /compiler-plugin/src/main/java/de/jensklingenberg/CommonComponentRegistrar.kt: -------------------------------------------------------------------------------- 1 | package de.jensklingenberg 2 | 3 | import com.google.auto.service.AutoService 4 | import de.jensklingenberg.transform.ExampleIrGenerationExtension 5 | import org.jetbrains.kotlin.backend.common.extensions.IrGenerationExtension 6 | import org.jetbrains.kotlin.cli.common.CLIConfigurationKeys 7 | import org.jetbrains.kotlin.cli.common.config.kotlinSourceRoots 8 | import org.jetbrains.kotlin.cli.common.messages.CompilerMessageSeverity 9 | import org.jetbrains.kotlin.cli.common.messages.MessageCollector 10 | import org.jetbrains.kotlin.compiler.plugin.CompilerPluginRegistrar 11 | import org.jetbrains.kotlin.config.CompilerConfiguration 12 | 13 | @AutoService(CompilerPluginRegistrar::class) 14 | class CommonComponentRegistrar : CompilerPluginRegistrar() { 15 | 16 | override val supportsK2: Boolean 17 | get() = true 18 | 19 | override fun ExtensionStorage.registerExtensions(configuration: CompilerConfiguration) { 20 | if (configuration[KEY_ENABLED] == false) { 21 | return 22 | } 23 | 24 | val messageCollector = configuration.get(CLIConfigurationKeys.MESSAGE_COLLECTOR_KEY, MessageCollector.NONE) 25 | configuration.kotlinSourceRoots.forEach { 26 | messageCollector.report( 27 | CompilerMessageSeverity.WARNING, 28 | "*** Hello from ***" + it.path 29 | ) 30 | } 31 | 32 | val logging = true 33 | IrGenerationExtension.registerExtension( 34 | ExampleIrGenerationExtension(DebugLogger(logging, messageCollector)) 35 | ) 36 | } 37 | } 38 | -------------------------------------------------------------------------------- /compiler-plugin/src/main/java/de/jensklingenberg/DebugLogger.kt: -------------------------------------------------------------------------------- 1 | package de.jensklingenberg 2 | 3 | import org.jetbrains.kotlin.cli.common.messages.CompilerMessageSeverity 4 | import org.jetbrains.kotlin.cli.common.messages.MessageCollector 5 | 6 | internal data class DebugLogger(val debug: Boolean, val messageCollector: MessageCollector) { 7 | fun log(message: String) { 8 | if (debug) { 9 | messageCollector.report(CompilerMessageSeverity.INFO, message) 10 | } 11 | } 12 | } -------------------------------------------------------------------------------- /compiler-plugin/src/main/java/de/jensklingenberg/ExampleCommandLineProcessor.kt: -------------------------------------------------------------------------------- 1 | package de.jensklingenberg 2 | 3 | import com.google.auto.service.AutoService 4 | import org.jetbrains.kotlin.compiler.plugin.AbstractCliOption 5 | import org.jetbrains.kotlin.compiler.plugin.CliOption 6 | import org.jetbrains.kotlin.compiler.plugin.CommandLineProcessor 7 | import org.jetbrains.kotlin.config.CompilerConfiguration 8 | import org.jetbrains.kotlin.config.CompilerConfigurationKey 9 | 10 | @AutoService(CommandLineProcessor::class) // don't forget! 11 | class ExampleCommandLineProcessor : CommandLineProcessor { 12 | 13 | override val pluginId: String = "helloWorldPlugin" 14 | 15 | override val pluginOptions: Collection = listOf( 16 | CliOption( 17 | optionName = "enabled", valueDescription = "", 18 | description = "whether to enable the plugin or not" 19 | ) 20 | ) 21 | 22 | override fun processOption( 23 | option: AbstractCliOption, 24 | value: String, 25 | configuration: CompilerConfiguration 26 | ) = when (option.optionName) { 27 | "enabled" -> configuration.put(KEY_ENABLED, value.toBoolean()) 28 | else -> configuration.put(KEY_ENABLED, true) 29 | } 30 | } 31 | 32 | val KEY_ENABLED = CompilerConfigurationKey("whether the plugin is enabled") 33 | -------------------------------------------------------------------------------- /compiler-plugin/src/main/java/de/jensklingenberg/transform/CreateFuncTransformer.kt: -------------------------------------------------------------------------------- 1 | package de.jensklingenberg.transform 2 | 3 | import de.jensklingenberg.DebugLogger 4 | import org.jetbrains.kotlin.backend.common.IrElementTransformerVoidWithContext 5 | import org.jetbrains.kotlin.backend.common.extensions.IrPluginContext 6 | import org.jetbrains.kotlin.ir.expressions.IrCall 7 | import org.jetbrains.kotlin.ir.expressions.IrExpression 8 | import org.jetbrains.kotlin.ir.expressions.impl.IrConstructorCallImpl 9 | import org.jetbrains.kotlin.ir.types.classFqName 10 | import org.jetbrains.kotlin.ir.types.defaultType 11 | import org.jetbrains.kotlin.ir.types.impl.originalKotlinType 12 | import org.jetbrains.kotlin.ir.util.constructors 13 | import org.jetbrains.kotlin.name.ClassId 14 | import org.jetbrains.kotlin.name.FqName 15 | import org.jetbrains.kotlin.name.Name 16 | 17 | /** 18 | * Transform create() to create(_TestApiIProvider()) 19 | */ 20 | internal class CreateFuncTransformer( 21 | private val pluginContext: IrPluginContext, 22 | private val debugLogger: DebugLogger 23 | ) : IrElementTransformerVoidWithContext() { 24 | 25 | companion object { 26 | 27 | fun ERROR_IMPL_NOT_FOUND(implName: String) = 28 | "${implName} not found" 29 | 30 | private const val EXAMPLE_PACKAGE = "sample" 31 | private const val EXAMPLE_CREATE = "create" 32 | 33 | } 34 | 35 | override fun visitExpression(expression: IrExpression): IrExpression { 36 | 37 | //Find exampleKtorfit.create() 38 | (expression as? IrCall)?.let { irCall -> 39 | if (irCall.typeArgumentsCount > 0) { 40 | 41 | if (!expression.symbol.owner.symbol.toString().contains(EXAMPLE_PACKAGE)) { 42 | return expression 43 | } 44 | if (expression.symbol.owner.name.asString() != EXAMPLE_CREATE) { 45 | return expression 46 | } 47 | 48 | if (expression.getValueArgument(0) != null) { 49 | return expression 50 | } 51 | 52 | //Get T from create() 53 | val argumentType = irCall.getTypeArgument(0) ?: return expression 54 | val classFqName = argumentType.classFqName 55 | 56 | //if (!argumentType.isInterface()) throw IllegalStateException(ERROR_TYPE_ARGUMENT_NOT_INTERFACE(argumentType.originalKotlinType.toString())) 57 | 58 | if (classFqName == null) { 59 | throw IllegalStateException(ERROR_IMPL_NOT_FOUND(argumentType.originalKotlinType.toString())) 60 | } 61 | 62 | val packageName = classFqName.packageName 63 | val className = classFqName.shortName().toString() 64 | val providerClassName = "_$className" + "Provider" 65 | 66 | //Find the class _TestApiProvider 67 | val implClassSymbol = pluginContext.referenceClass( 68 | ClassId( 69 | FqName(packageName), 70 | Name.identifier(providerClassName) 71 | ) 72 | ) ?: throw IllegalStateException(ERROR_IMPL_NOT_FOUND(providerClassName)) 73 | 74 | val newConstructor = implClassSymbol.constructors.first() 75 | 76 | //Create the constructor call for _ExampleApiImpl() 77 | val newCall = IrConstructorCallImpl( 78 | 0, 79 | 0, 80 | type = implClassSymbol.defaultType, 81 | symbol = newConstructor, 82 | 0, 83 | 0, 84 | 0, 85 | null 86 | ) 87 | 88 | //Set _ExampleApiImpl() as argument for create() 89 | irCall.putValueArgument(0, newCall) 90 | debugLogger.log( 91 | "Transformed " + argumentType.originalKotlinType.toString() + " to _$className" + "Impl" 92 | ) 93 | return super.visitExpression(irCall) 94 | } 95 | } 96 | return super.visitExpression(expression) 97 | } 98 | 99 | } 100 | 101 | 102 | private val FqName?.packageName: String 103 | get() { 104 | return this.toString().substringBeforeLast(".") 105 | } 106 | -------------------------------------------------------------------------------- /compiler-plugin/src/main/java/de/jensklingenberg/transform/ElementTransformer.kt: -------------------------------------------------------------------------------- 1 | package de.jensklingenberg.transform 2 | 3 | import de.jensklingenberg.DebugLogger 4 | import org.jetbrains.kotlin.backend.common.IrElementTransformerVoidWithContext 5 | import org.jetbrains.kotlin.backend.common.extensions.IrPluginContext 6 | import org.jetbrains.kotlin.ir.IrStatement 7 | import org.jetbrains.kotlin.ir.declarations.* 8 | import org.jetbrains.kotlin.ir.expressions.IrCall 9 | import org.jetbrains.kotlin.ir.expressions.IrExpression 10 | import org.jetbrains.kotlin.ir.expressions.IrFunctionExpression 11 | 12 | internal class ElementTransformer( 13 | private val pluginContext: IrPluginContext, 14 | private val debugLogger: DebugLogger 15 | ) : IrElementTransformerVoidWithContext() { 16 | 17 | override fun visitValueParameterNew(declaration: IrValueParameter): IrStatement { 18 | declaration.transform(CreateFuncTransformer(pluginContext,debugLogger), null) 19 | return super.visitValueParameterNew(declaration) 20 | } 21 | 22 | override fun visitPropertyNew(declaration: IrProperty): IrStatement { 23 | declaration.transform(CreateFuncTransformer(pluginContext, debugLogger), null) 24 | return super.visitPropertyNew(declaration) 25 | } 26 | 27 | override fun visitCall(expression: IrCall): IrExpression { 28 | expression.transform(CreateFuncTransformer(pluginContext, debugLogger), null) 29 | return super.visitCall(expression) 30 | } 31 | 32 | override fun visitVariable(declaration: IrVariable): IrStatement { 33 | declaration.transform(CreateFuncTransformer(pluginContext, debugLogger), null) 34 | return super.visitVariable(declaration) 35 | } 36 | 37 | 38 | override fun visitFunctionExpression(expression: IrFunctionExpression): IrExpression { 39 | expression.transform(CreateFuncTransformer(pluginContext, debugLogger), null) 40 | return super.visitFunctionExpression(expression) 41 | } 42 | } -------------------------------------------------------------------------------- /compiler-plugin/src/main/java/de/jensklingenberg/transform/ExampleIrGenerationExtension.kt: -------------------------------------------------------------------------------- 1 | package de.jensklingenberg.transform 2 | 3 | import de.jensklingenberg.DebugLogger 4 | import org.jetbrains.kotlin.backend.common.extensions.IrGenerationExtension 5 | import org.jetbrains.kotlin.backend.common.extensions.IrPluginContext 6 | import org.jetbrains.kotlin.ir.declarations.IrModuleFragment 7 | 8 | internal class ExampleIrGenerationExtension(private val debugLogger: DebugLogger) : IrGenerationExtension { 9 | override fun generate(moduleFragment: IrModuleFragment, pluginContext: IrPluginContext) { 10 | moduleFragment.transform(ElementTransformer(pluginContext,debugLogger), null) 11 | } 12 | } -------------------------------------------------------------------------------- /docs/screenshot.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Foso/KotlinCompilerPluginExample/d58e25660ee8d154b0364c94c8cfb723908b56ef/docs/screenshot.png -------------------------------------------------------------------------------- /gradle-plugin/build.gradle.kts: -------------------------------------------------------------------------------- 1 | plugins { 2 | kotlin("jvm") version("2.0.0") 3 | kotlin("kapt") version("2.0.0") 4 | id("java-gradle-plugin") 5 | `maven-publish` 6 | } 7 | 8 | group = "de.jensklingenberg" 9 | version = "1.0.0" 10 | 11 | 12 | allprojects { 13 | repositories { 14 | mavenLocal() 15 | mavenCentral() 16 | maven("https://maven.google.com") 17 | maven("https://plugins.gradle.org/m2/") 18 | google() 19 | } 20 | } 21 | dependencies { 22 | implementation("org.jetbrains.kotlin:kotlin-gradle-plugin-api:2.0.0") 23 | } 24 | 25 | gradlePlugin { 26 | plugins { 27 | 28 | create("simplePlugin") { 29 | id = "compiler.gradleplugin.helloworld" // users will do `apply plugin: "compiler.plugin.helloworld"` 30 | implementationClass = "de.jensklingenberg.gradle.HelloWorldGradleSubPlugin" // entry-point class 31 | } 32 | } 33 | } 34 | 35 | tasks.register("sourcesJar", Jar::class) { 36 | group = "build" 37 | description = "Assembles Kotlin sources" 38 | 39 | archiveClassifier.set("sources") 40 | from(sourceSets.main.get().allSource) 41 | dependsOn(tasks.classes) 42 | } 43 | 44 | publishing { 45 | publications { 46 | create("default") { 47 | from(components["java"]) 48 | artifact(tasks["sourcesJar"]) 49 | //artifact(tasks["dokkaJar"]) 50 | 51 | pom { 52 | name.set("compiler.gradleplugin.helloworld") 53 | description.set("KotlinCompilerPluginExample") 54 | url.set("https://github.com/Foso/KotlinCompilerPluginExample") 55 | 56 | licenses { 57 | license { 58 | name.set("Apache License 2.0") 59 | url.set("https://github.com/Foso/Ktorfit/blob/master/LICENSE.txt") 60 | } 61 | } 62 | scm { 63 | url.set("https://github.com/Foso/KotlinCompilerPluginExample") 64 | connection.set("scm:git:git://github.com/Foso/KotlinCompilerPluginExample.git") 65 | } 66 | developers { 67 | developer { 68 | name.set("Jens Klingenberg") 69 | url.set("https://github.com/Foso") 70 | } 71 | } 72 | } 73 | } 74 | } 75 | 76 | repositories { 77 | if ( 78 | hasProperty("sonatypeUsername") && 79 | hasProperty("sonatypePassword") && 80 | hasProperty("sonatypeSnapshotUrl") && 81 | hasProperty("sonatypeReleaseUrl") 82 | ) { 83 | maven { 84 | val url = when { 85 | "SNAPSHOT" in version.toString() -> property("sonatypeSnapshotUrl") 86 | else -> property("sonatypeReleaseUrl") 87 | } as String 88 | setUrl(url) 89 | credentials { 90 | username = property("sonatypeUsername") as String 91 | password = property("sonatypePassword") as String 92 | } 93 | } 94 | } 95 | } 96 | } 97 | 98 | 99 | tasks.build { 100 | dependsOn(":kotlin-plugin:publishToMavenLocal") 101 | 102 | } -------------------------------------------------------------------------------- /gradle-plugin/src/main/java/de/jensklingenberg/gradle/HelloWorldGradleSubplugin.kt: -------------------------------------------------------------------------------- 1 | package de.jensklingenberg.gradle 2 | 3 | import org.gradle.api.Project 4 | import org.gradle.api.provider.Provider 5 | import org.jetbrains.kotlin.gradle.plugin.KotlinCompilation 6 | import org.jetbrains.kotlin.gradle.plugin.KotlinCompilerPluginSupportPlugin 7 | import org.jetbrains.kotlin.gradle.plugin.SubpluginArtifact 8 | import org.jetbrains.kotlin.gradle.plugin.SubpluginOption 9 | 10 | open class TestCompilerExtension { 11 | var enabled: Boolean = true 12 | } 13 | 14 | class HelloWorldGradleSubPlugin : KotlinCompilerPluginSupportPlugin { 15 | 16 | companion object { 17 | const val SERIALIZATION_GROUP_NAME = "de.jensklingenberg" 18 | const val ARTIFACT_NAME = "compiler-plugin" 19 | const val VERSION_NUMBER = "0.0.1" 20 | } 21 | 22 | private var gradleExtension : TestCompilerExtension = TestCompilerExtension() 23 | override fun applyToCompilation(kotlinCompilation: KotlinCompilation<*>): Provider> { 24 | gradleExtension = kotlinCompilation.target.project.extensions.findByType(TestCompilerExtension::class.java) ?: TestCompilerExtension() 25 | 26 | return kotlinCompilation.target.project.provider { 27 | val options = mutableListOf(SubpluginOption("enabled", gradleExtension.enabled.toString())) 28 | options 29 | } 30 | } 31 | 32 | override fun apply(target: Project) { 33 | target.extensions.create( 34 | "helloWorld", 35 | TestCompilerExtension::class.java 36 | ) 37 | super.apply(target) 38 | } 39 | 40 | override fun getCompilerPluginId(): String = "helloWorldPlugin" 41 | 42 | override fun isApplicable(kotlinCompilation: KotlinCompilation<*>): Boolean { 43 | return true 44 | } 45 | 46 | override fun getPluginArtifact(): SubpluginArtifact = SubpluginArtifact( 47 | groupId = SERIALIZATION_GROUP_NAME, 48 | artifactId = ARTIFACT_NAME, 49 | version = VERSION_NUMBER // remember to bump this version before any release! 50 | ) 51 | 52 | } 53 | -------------------------------------------------------------------------------- /gradle.properties: -------------------------------------------------------------------------------- 1 | kotlin.incremental=false 2 | org.gradle.daemon=false 3 | org.gradle.parallel=false 4 | org.gradle.configureondemand=false 5 | kotlin.compiler.execution.strategy=in-process 6 | kotlin.daemon.debug.log=true 7 | kotlin.js.compiler=ir 8 | org.gradle.jvmargs=-Xmx2g 9 | 10 | -------------------------------------------------------------------------------- /gradle/libs.versions.toml: -------------------------------------------------------------------------------- 1 | [versions] 2 | kotlin = "2.0.0" -------------------------------------------------------------------------------- /gradle/wrapper/gradle-wrapper.jar: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Foso/KotlinCompilerPluginExample/d58e25660ee8d154b0364c94c8cfb723908b56ef/gradle/wrapper/gradle-wrapper.jar -------------------------------------------------------------------------------- /gradle/wrapper/gradle-wrapper.properties: -------------------------------------------------------------------------------- 1 | distributionBase=GRADLE_USER_HOME 2 | distributionPath=wrapper/dists 3 | distributionSha256Sum=20f1b1176237254a6fc204d8434196fa11a4cfb387567519c61556e8710aed78 4 | distributionUrl=https\://services.gradle.org/distributions/gradle-8.13-bin.zip 5 | networkTimeout=10000 6 | validateDistributionUrl=true 7 | zipStoreBase=GRADLE_USER_HOME 8 | zipStorePath=wrapper/dists 9 | -------------------------------------------------------------------------------- /gradlew: -------------------------------------------------------------------------------- 1 | #!/bin/sh 2 | 3 | # 4 | # Copyright © 2015-2021 the original 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 | # SPDX-License-Identifier: Apache-2.0 19 | # 20 | 21 | ############################################################################## 22 | # 23 | # Gradle start up script for POSIX generated by Gradle. 24 | # 25 | # Important for running: 26 | # 27 | # (1) You need a POSIX-compliant shell to run this script. If your /bin/sh is 28 | # noncompliant, but you have some other compliant shell such as ksh or 29 | # bash, then to run this script, type that shell name before the whole 30 | # command line, like: 31 | # 32 | # ksh Gradle 33 | # 34 | # Busybox and similar reduced shells will NOT work, because this script 35 | # requires all of these POSIX shell features: 36 | # * functions; 37 | # * expansions «$var», «${var}», «${var:-default}», «${var+SET}», 38 | # «${var#prefix}», «${var%suffix}», and «$( cmd )»; 39 | # * compound commands having a testable exit status, especially «case»; 40 | # * various built-in commands including «command», «set», and «ulimit». 41 | # 42 | # Important for patching: 43 | # 44 | # (2) This script targets any POSIX shell, so it avoids extensions provided 45 | # by Bash, Ksh, etc; in particular arrays are avoided. 46 | # 47 | # The "traditional" practice of packing multiple parameters into a 48 | # space-separated string is a well documented source of bugs and security 49 | # problems, so this is (mostly) avoided, by progressively accumulating 50 | # options in "$@", and eventually passing that to Java. 51 | # 52 | # Where the inherited environment variables (DEFAULT_JVM_OPTS, JAVA_OPTS, 53 | # and GRADLE_OPTS) rely on word-splitting, this is performed explicitly; 54 | # see the in-line comments for details. 55 | # 56 | # There are tweaks for specific operating systems such as AIX, CygWin, 57 | # Darwin, MinGW, and NonStop. 58 | # 59 | # (3) This script is generated from the Groovy template 60 | # https://github.com/gradle/gradle/blob/HEAD/platforms/jvm/plugins-application/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt 61 | # within the Gradle project. 62 | # 63 | # You can find Gradle at https://github.com/gradle/gradle/. 64 | # 65 | ############################################################################## 66 | 67 | # Attempt to set APP_HOME 68 | 69 | # Resolve links: $0 may be a link 70 | app_path=$0 71 | 72 | # Need this for daisy-chained symlinks. 73 | while 74 | APP_HOME=${app_path%"${app_path##*/}"} # leaves a trailing /; empty if no leading path 75 | [ -h "$app_path" ] 76 | do 77 | ls=$( ls -ld "$app_path" ) 78 | link=${ls#*' -> '} 79 | case $link in #( 80 | /*) app_path=$link ;; #( 81 | *) app_path=$APP_HOME$link ;; 82 | esac 83 | done 84 | 85 | # This is normally unused 86 | # shellcheck disable=SC2034 87 | APP_BASE_NAME=${0##*/} 88 | # Discard cd standard output in case $CDPATH is set (https://github.com/gradle/gradle/issues/25036) 89 | APP_HOME=$( cd -P "${APP_HOME:-./}" > /dev/null && printf '%s\n' "$PWD" ) || exit 90 | 91 | # Use the maximum available, or set MAX_FD != -1 to use that value. 92 | MAX_FD=maximum 93 | 94 | warn () { 95 | echo "$*" 96 | } >&2 97 | 98 | die () { 99 | echo 100 | echo "$*" 101 | echo 102 | exit 1 103 | } >&2 104 | 105 | # OS specific support (must be 'true' or 'false'). 106 | cygwin=false 107 | msys=false 108 | darwin=false 109 | nonstop=false 110 | case "$( uname )" in #( 111 | CYGWIN* ) cygwin=true ;; #( 112 | Darwin* ) darwin=true ;; #( 113 | MSYS* | MINGW* ) msys=true ;; #( 114 | NONSTOP* ) nonstop=true ;; 115 | esac 116 | 117 | CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar 118 | 119 | 120 | # Determine the Java command to use to start the JVM. 121 | if [ -n "$JAVA_HOME" ] ; then 122 | if [ -x "$JAVA_HOME/jre/sh/java" ] ; then 123 | # IBM's JDK on AIX uses strange locations for the executables 124 | JAVACMD=$JAVA_HOME/jre/sh/java 125 | else 126 | JAVACMD=$JAVA_HOME/bin/java 127 | fi 128 | if [ ! -x "$JAVACMD" ] ; then 129 | die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME 130 | 131 | Please set the JAVA_HOME variable in your environment to match the 132 | location of your Java installation." 133 | fi 134 | else 135 | JAVACMD=java 136 | if ! command -v java >/dev/null 2>&1 137 | then 138 | die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. 139 | 140 | Please set the JAVA_HOME variable in your environment to match the 141 | location of your Java installation." 142 | fi 143 | fi 144 | 145 | # Increase the maximum file descriptors if we can. 146 | if ! "$cygwin" && ! "$darwin" && ! "$nonstop" ; then 147 | case $MAX_FD in #( 148 | max*) 149 | # In POSIX sh, ulimit -H is undefined. That's why the result is checked to see if it worked. 150 | # shellcheck disable=SC2039,SC3045 151 | MAX_FD=$( ulimit -H -n ) || 152 | warn "Could not query maximum file descriptor limit" 153 | esac 154 | case $MAX_FD in #( 155 | '' | soft) :;; #( 156 | *) 157 | # In POSIX sh, ulimit -n is undefined. That's why the result is checked to see if it worked. 158 | # shellcheck disable=SC2039,SC3045 159 | ulimit -n "$MAX_FD" || 160 | warn "Could not set maximum file descriptor limit to $MAX_FD" 161 | esac 162 | fi 163 | 164 | # Collect all arguments for the java command, stacking in reverse order: 165 | # * args from the command line 166 | # * the main class name 167 | # * -classpath 168 | # * -D...appname settings 169 | # * --module-path (only if needed) 170 | # * DEFAULT_JVM_OPTS, JAVA_OPTS, and GRADLE_OPTS environment variables. 171 | 172 | # For Cygwin or MSYS, switch paths to Windows format before running java 173 | if "$cygwin" || "$msys" ; then 174 | APP_HOME=$( cygpath --path --mixed "$APP_HOME" ) 175 | CLASSPATH=$( cygpath --path --mixed "$CLASSPATH" ) 176 | 177 | JAVACMD=$( cygpath --unix "$JAVACMD" ) 178 | 179 | # Now convert the arguments - kludge to limit ourselves to /bin/sh 180 | for arg do 181 | if 182 | case $arg in #( 183 | -*) false ;; # don't mess with options #( 184 | /?*) t=${arg#/} t=/${t%%/*} # looks like a POSIX filepath 185 | [ -e "$t" ] ;; #( 186 | *) false ;; 187 | esac 188 | then 189 | arg=$( cygpath --path --ignore --mixed "$arg" ) 190 | fi 191 | # Roll the args list around exactly as many times as the number of 192 | # args, so each arg winds up back in the position where it started, but 193 | # possibly modified. 194 | # 195 | # NB: a `for` loop captures its iteration list before it begins, so 196 | # changing the positional parameters here affects neither the number of 197 | # iterations, nor the values presented in `arg`. 198 | shift # remove old arg 199 | set -- "$@" "$arg" # push replacement arg 200 | done 201 | fi 202 | 203 | 204 | # Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. 205 | DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"' 206 | 207 | # Collect all arguments for the java command: 208 | # * DEFAULT_JVM_OPTS, JAVA_OPTS, and optsEnvironmentVar are not allowed to contain shell fragments, 209 | # and any embedded shellness will be escaped. 210 | # * For example: A user cannot expect ${Hostname} to be expanded, as it is an environment variable and will be 211 | # treated as '${Hostname}' itself on the command line. 212 | 213 | set -- \ 214 | "-Dorg.gradle.appname=$APP_BASE_NAME" \ 215 | -classpath "$CLASSPATH" \ 216 | org.gradle.wrapper.GradleWrapperMain \ 217 | "$@" 218 | 219 | # Stop when "xargs" is not available. 220 | if ! command -v xargs >/dev/null 2>&1 221 | then 222 | die "xargs is not available" 223 | fi 224 | 225 | # Use "xargs" to parse quoted args. 226 | # 227 | # With -n1 it outputs one arg per line, with the quotes and backslashes removed. 228 | # 229 | # In Bash we could simply go: 230 | # 231 | # readarray ARGS < <( xargs -n1 <<<"$var" ) && 232 | # set -- "${ARGS[@]}" "$@" 233 | # 234 | # but POSIX shell has neither arrays nor command substitution, so instead we 235 | # post-process each arg (as a line of input to sed) to backslash-escape any 236 | # character that might be a shell metacharacter, then use eval to reverse 237 | # that process (while maintaining the separation between arguments), and wrap 238 | # the whole thing up as a single "set" statement. 239 | # 240 | # This will of course break if any of these variables contains a newline or 241 | # an unmatched quote. 242 | # 243 | 244 | eval "set -- $( 245 | printf '%s\n' "$DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS" | 246 | xargs -n1 | 247 | sed ' s~[^-[:alnum:]+,./:=@_]~\\&~g; ' | 248 | tr '\n' ' ' 249 | )" '"$@"' 250 | 251 | exec "$JAVACMD" "$@" 252 | -------------------------------------------------------------------------------- /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 | @rem SPDX-License-Identifier: Apache-2.0 17 | @rem 18 | 19 | @if "%DEBUG%"=="" @echo off 20 | @rem ########################################################################## 21 | @rem 22 | @rem Gradle startup script for Windows 23 | @rem 24 | @rem ########################################################################## 25 | 26 | @rem Set local scope for the variables with windows NT shell 27 | if "%OS%"=="Windows_NT" setlocal 28 | 29 | set DIRNAME=%~dp0 30 | if "%DIRNAME%"=="" set DIRNAME=. 31 | @rem This is normally unused 32 | set APP_BASE_NAME=%~n0 33 | set APP_HOME=%DIRNAME% 34 | 35 | @rem Resolve any "." and ".." in APP_HOME to make it shorter. 36 | for %%i in ("%APP_HOME%") do set APP_HOME=%%~fi 37 | 38 | @rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. 39 | set DEFAULT_JVM_OPTS="-Xmx64m" "-Xms64m" 40 | 41 | @rem Find java.exe 42 | if defined JAVA_HOME goto findJavaFromJavaHome 43 | 44 | set JAVA_EXE=java.exe 45 | %JAVA_EXE% -version >NUL 2>&1 46 | if %ERRORLEVEL% equ 0 goto execute 47 | 48 | echo. 1>&2 49 | echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. 1>&2 50 | echo. 1>&2 51 | echo Please set the JAVA_HOME variable in your environment to match the 1>&2 52 | echo location of your Java installation. 1>&2 53 | 54 | goto fail 55 | 56 | :findJavaFromJavaHome 57 | set JAVA_HOME=%JAVA_HOME:"=% 58 | set JAVA_EXE=%JAVA_HOME%/bin/java.exe 59 | 60 | if exist "%JAVA_EXE%" goto execute 61 | 62 | echo. 1>&2 63 | echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% 1>&2 64 | echo. 1>&2 65 | echo Please set the JAVA_HOME variable in your environment to match the 1>&2 66 | echo location of your Java installation. 1>&2 67 | 68 | goto fail 69 | 70 | :execute 71 | @rem Setup the command line 72 | 73 | set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar 74 | 75 | 76 | @rem Execute Gradle 77 | "%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %* 78 | 79 | :end 80 | @rem End local scope for the variables with windows NT shell 81 | if %ERRORLEVEL% equ 0 goto mainEnd 82 | 83 | :fail 84 | rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of 85 | rem the _cmd.exe /c_ return code! 86 | set EXIT_CODE=%ERRORLEVEL% 87 | if %EXIT_CODE% equ 0 set EXIT_CODE=1 88 | if not ""=="%GRADLE_EXIT_CONSOLE%" exit %EXIT_CODE% 89 | exit /b %EXIT_CODE% 90 | 91 | :mainEnd 92 | if "%OS%"=="Windows_NT" endlocal 93 | 94 | :omega 95 | -------------------------------------------------------------------------------- /lib/build.gradle.kts: -------------------------------------------------------------------------------- 1 | plugins { 2 | id("org.jetbrains.kotlin.multiplatform") version libs.versions.kotlin 3 | } 4 | apply(plugin = "compiler.gradleplugin.helloworld") 5 | 6 | 7 | configure { 8 | enabled = true 9 | } 10 | 11 | kotlin { 12 | jvm() 13 | linuxX64("linux") 14 | js() 15 | sourceSets { 16 | val commonMain by getting {} 17 | 18 | val jsMain by getting { 19 | 20 | dependencies { 21 | 22 | } 23 | } 24 | 25 | val jvmMain by getting { 26 | 27 | 28 | dependencies { 29 | 30 | } 31 | } 32 | val linuxMain by getting { 33 | 34 | } 35 | 36 | } 37 | } 38 | 39 | -------------------------------------------------------------------------------- /lib/src/commonMain/kotlin/sample/Sample.kt: -------------------------------------------------------------------------------- 1 | package sample 2 | 3 | expect class Sample() { 4 | fun checkMe(): Int 5 | } 6 | 7 | expect object Platform { 8 | val name: String 9 | } 10 | 11 | fun hello(): String = "Hello from ${Platform.name}" 12 | 13 | class _MyTestProvider : MyTest{ 14 | override fun print(){ 15 | println("Hello from _MyTestProvider") 16 | } 17 | } 18 | 19 | interface MyTest{ 20 | fun print() 21 | } 22 | 23 | fun create(myTestProvider: MyTest? = null): MyTest { 24 | return myTestProvider!! 25 | } -------------------------------------------------------------------------------- /lib/src/jsMain/kotlin/sample/SampleJs.kt: -------------------------------------------------------------------------------- 1 | package sample 2 | 3 | actual class Sample { 4 | actual fun checkMe() = 12 5 | } 6 | 7 | actual object Platform { 8 | actual val name: String = "JS" 9 | } -------------------------------------------------------------------------------- /lib/src/jvmMain/kotlin/sample/SampleJvm.kt: -------------------------------------------------------------------------------- 1 | package sample 2 | 3 | actual class Sample { 4 | actual fun checkMe() = 42 5 | } 6 | 7 | actual object Platform { 8 | actual val name: String = "JVM" 9 | } 10 | 11 | fun main() { 12 | /** 13 | * The compiler plugin will replace this with create(_MyTestProvider) 14 | */ 15 | val myTest = create() 16 | myTest.print() 17 | } -------------------------------------------------------------------------------- /lib/src/linuxMain/kotlin/sample/SampleLinux.kt: -------------------------------------------------------------------------------- 1 | package sample 2 | 3 | actual class Sample { 4 | actual fun checkMe() = 7 5 | } 6 | 7 | actual object Platform { 8 | actual val name: String = "Native" 9 | } -------------------------------------------------------------------------------- /lib/src/linuxTest/kotlin/sample/SampleTestsNative.kt: -------------------------------------------------------------------------------- 1 | package sample 2 | 3 | import kotlin.test.Test 4 | import kotlin.test.assertTrue 5 | 6 | class SampleTestsNative { 7 | @Test 8 | fun testHello() { 9 | assertTrue("Native" in hello()) 10 | } 11 | } -------------------------------------------------------------------------------- /settings.gradle.kts: -------------------------------------------------------------------------------- 1 | 2 | includeBuild("gradle-plugin") { 3 | dependencySubstitution { 4 | substitute(module("de.jensklingenberg:gradle-plugin:1.0.0")).using(project(":")) 5 | } 6 | } 7 | includeBuild("compiler-plugin") 8 | 9 | include(":lib") 10 | --------------------------------------------------------------------------------