diff --git a/LICENSE.txt b/LICENSE.txt new file mode 100644 index 0000000..4d7e4af --- /dev/null +++ b/LICENSE.txt @@ -0,0 +1,202 @@ + + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [2023] [Kanyun.Inc.] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/README.md b/README.md index 54a69db..ebbfa79 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,43 @@ # Sword +[![License: Apache 2.0](https://img.shields.io/badge/License-Apache-yellow.svg)](./LICENSE.txt) ![Maven Central](https://img.shields.io/maven-central/v/com.sunxiaodou.kotlin/sword-kcp-gradle-plugin) + 使用 kotlin compiler plugin 实现，目前仅作用于 Kotlin 函数，为 Kotlin 函数提供代理实现。 +Implemented using kotlin compiler plugin, currently only applicable to Kotlin functions, providing proxy implementation for Kotlin functions. + ## 集成 -`def version = 0.0.1` +`val version = 0.0.2` + +### Top-level build.gradle.kts + +```kotlin +plugins { + id("com.sunxiaodou.kotlin.sword.kcp") version "${version}" apply false + + // Option KSP + id("com.google.devtools.ksp") version "1.7.10-1.0.6" apply false +} +``` + +### Module-level build.gradle.kts + +```kotlin +plugins { + id("com.sunxiaodou.kotlin.sword.kcp") + + // Option KSP + id("com.google.devtools.ksp") +} + +dependencies { + implementation("com.sunxiaodou.kotlin:sword-api-kt:${version}") + + // Option 为标记[InvocationHandler]的子类生成FqName索引类`HandlerFqName` + ksp("com.sunxiaodou.kotlin:sword-compiler-ksp:${version}") +} +``` ## Api diff --git a/api-kotlin/build.gradle.kts b/api-kotlin/build.gradle.kts index 93a72ff..474fa46 100644 --- a/api-kotlin/build.gradle.kts +++ b/api-kotlin/build.gradle.kts @@ -1,9 +1,7 @@ import org.jetbrains.kotlin.gradle.tasks.KotlinCompile -import java.util.Properties plugins { kotlin("jvm") - `maven-publish` } java { @@ -15,46 +13,11 @@ tasks.withType { kotlinOptions.jvmTarget = "1.8" } -tasks.register("sourcesJar", Jar::class) { - group = "build" - description = "Assembles Kotlin sources" - - archiveClassifier.set("sources") - from(sourceSets.main.get().allSource) - dependsOn(tasks.classes) -} - publishing { - publications { - create("default") { - groupId = rootProject.extra["GROUP_ID"].toString() - artifactId = project.extra["ARTIFACT_ID"].toString() - version = rootProject.extra["PLUGIN_VERSION"].toString() - from(components["java"]) - artifact(tasks["sourcesJar"]) - } - } - repositories { maven { name = "Local" url = rootProject.uri("repo") } - - maven { - - // https://github.com/guodongAndroid/maven.git - val mavenUrl = uri(getMavenUrl()) - - name = "Github" - url = mavenUrl - } } -} - -fun getMavenUrl(): String { - val properties = Properties() - val dis = rootProject.file("local.properties").inputStream() - properties.load(dis) - return properties.getProperty("maven.url") } \ No newline at end of file diff --git a/api-kotlin/gradle.properties b/api-kotlin/gradle.properties index 0383478..1947868 100644 --- a/api-kotlin/gradle.properties +++ b/api-kotlin/gradle.properties @@ -1,2 +1,3 @@ -ARTIFACT_ID=sword-api-kt -DESCRIPTION=sword-api-kt \ No newline at end of file +POM_NAME=sword-api-kt +POM_ARTIFACT_ID=sword-api-kt +POM_DESCRIPTION=sword-api-kt \ No newline at end of file diff --git a/app/build.gradle.kts b/app/build.gradle.kts index 73e2a21..77bd916 100644 --- a/app/build.gradle.kts +++ b/app/build.gradle.kts @@ -1,7 +1,8 @@ plugins { id("com.android.application") id("org.jetbrains.kotlin.android") - id("com.guodong.android.sword.kcp") +// id("com.guodong.android.sword.kcp") + id("com.sunxiaodou.kotlin.sword.kcp") id("com.google.devtools.ksp") } @@ -70,10 +71,11 @@ dependencies { implementation("com.google.android.material:material:1.6.0") implementation("androidx.constraintlayout:constraintlayout:2.1.4") - implementation(project(":api-kotlin")) + debugImplementation(project(":api-kotlin")) + releaseImplementation("com.sunxiaodou.kotlin:sword-api-kt:${project.extra["PLUGIN_VERSION"]}") kspDebug(project(":compiler:ksp")) - kspRelease("com.guodong.android:sword-compiler-ksp:0.0.1") + kspRelease("com.sunxiaodou.kotlin:sword-compiler-ksp:${project.extra["PLUGIN_VERSION"]}") testImplementation("junit:junit:4.13.2") androidTestImplementation("androidx.test.ext:junit:1.1.3") diff --git a/build.gradle.kts b/build.gradle.kts index 92ab7b9..87a5f77 100644 --- a/build.gradle.kts +++ b/build.gradle.kts @@ -4,8 +4,6 @@ buildscript { google() mavenCentral() maven(uri("repo")) - - maven("https://raw.githubusercontent.com/guodongAndroid/maven/main/repository/") } dependencies { classpath("com.android.tools.build:gradle:4.1.3") @@ -17,7 +15,7 @@ buildscript { // debug // classpath("com.guodong.android:sword-gradle-plugin:${project.PLUGIN_VERSION}") - classpath("com.guodong.android:sword-kcp-gradle-plugin:${project.extra["PLUGIN_VERSION"]}") +// classpath("com.guodong.android:sword-kcp-gradle-plugin:${project.extra["PLUGIN_VERSION"]}") // NOTE: Do not place your application dependencies here; they belong // in the individual module build.gradle files @@ -29,6 +27,7 @@ plugins { id("com.google.devtools.ksp") version "1.7.10-1.0.6" apply false id("com.github.gmazzo.buildconfig") version "3.1.0" apply false id("com.vanniktech.maven.publish") version "0.22.0" apply false + id("com.sunxiaodou.kotlin.sword.kcp") version "0.0.2" apply false } allprojects { @@ -39,8 +38,12 @@ allprojects { dirs("repo") } maven(uri(rootProject.uri("repo"))) + } +} - maven("https://raw.githubusercontent.com/guodongAndroid/maven/main/repository/") +subprojects { + if (name != "app") { + apply(plugin = "com.vanniktech.maven.publish") } } diff --git a/compiler/ksp/build.gradle.kts b/compiler/ksp/build.gradle.kts index 8fde93f..c29b487 100644 --- a/compiler/ksp/build.gradle.kts +++ b/compiler/ksp/build.gradle.kts @@ -1,9 +1,7 @@ import org.jetbrains.kotlin.gradle.tasks.KotlinCompile -import java.util.Properties plugins { kotlin("jvm") - `maven-publish` } java { @@ -13,8 +11,8 @@ java { dependencies { implementation("com.google.devtools.ksp:symbol-processing-api:1.7.10-1.0.6") - implementation("com.squareup:kotlinpoet:1.11.0") - implementation("com.squareup:kotlinpoet-ksp:1.11.0") + implementation("com.squareup:kotlinpoet:1.14.2") + implementation("com.squareup:kotlinpoet-ksp:1.12.0") implementation(project(":api-kotlin")) } @@ -29,46 +27,11 @@ tasks.withType { } } -tasks.register("sourcesJar", Jar::class) { - group = "build" - description = "Assembles Kotlin sources" - - archiveClassifier.set("sources") - from(sourceSets.main.get().allSource) - dependsOn(tasks.classes) -} - publishing { - publications { - create("default") { - groupId = rootProject.extra["GROUP_ID"].toString() - artifactId = project.extra["ARTIFACT_ID"].toString() - version = rootProject.extra["PLUGIN_VERSION"].toString() - from(components["java"]) - artifact(tasks["sourcesJar"]) - } - } - repositories { maven { name = "Local" url = rootProject.uri("repo") } - - maven { - - // https://github.com/guodongAndroid/maven.git - val mavenUrl = uri(getMavenUrl()) - - name = "Github" - url = mavenUrl - } } -} - -fun getMavenUrl(): String { - val properties = Properties() - val dis = rootProject.file("local.properties").inputStream() - properties.load(dis) - return properties.getProperty("maven.url") } \ No newline at end of file diff --git a/compiler/ksp/gradle.properties b/compiler/ksp/gradle.properties index 1f12a54..b30304d 100644 --- a/compiler/ksp/gradle.properties +++ b/compiler/ksp/gradle.properties @@ -1,2 +1,3 @@ -ARTIFACT_ID=sword-compiler-ksp -DESCRIPTION=sword-compiler-ksp \ No newline at end of file +POM_NAME=sword-compiler-ksp +POM_ARTIFACT_ID=sword-compiler-ksp +POM_DESCRIPTION=sword-compiler-ksp \ No newline at end of file diff --git a/gradle.properties b/gradle.properties index 6d72d40..2510d1e 100644 --- a/gradle.properties +++ b/gradle.properties @@ -22,6 +22,31 @@ kotlin.code.style=official # thereby reducing the size of the R class for that library android.nonTransitiveRClass=false -GROUP_ID=com.sunxiaodou.kotlin -PLUGIN_VERSION=0.0.2-alpha -KOTLIN_PLUGIN_ID=com.sunxiaodou.kotlin.sword.kcp \ No newline at end of file +PLUGIN_VERSION=0.0.2 +KOTLIN_PLUGIN_ID=com.sunxiaodou.kotlin.sword.kcp + +GROUP=com.sunxiaodou.kotlin + +# PLUGIN_VERSION +VERSION_NAME=0.0.2 + +POM_NAME=Sword +POM_DESCRIPTION=Implemented using kotlin compiler plugin, currently only applicable to Kotlin functions, providing proxy implementation for Kotlin functions. +POM_INCEPTION_YEAR=2022 +POM_URL=https://github.com/guodongAndroid/Sword + +POM_LICENSE_NAME=The Apache Software License, Version 2.0 +POM_LICENSE_URL=https://www.apache.org/licenses/LICENSE-2.0.txt +POM_LICENSE_DIST=repo + +POM_SCM_URL=https://github.com/guodongAndroid/Sword +POM_SCM_CONNECTION=scm:git:git://github.com/guodongAndroid/Sword.git +POM_SCM_DEV_CONNECTION=scm:git:ssh://git@github.com/guodongAndroid/Sword.git + +POM_DEVELOPER_ID=guodongAndroid +POM_DEVELOPER_NAME=guodongAndroid +POM_DEVELOPER_URL=https://github.com/guodongAndroid/Sword + +SONATYPE_HOST=S01 +SONATYPE_AUTOMATIC_RELEASE=true +RELEASE_SIGNING_ENABLED=true \ No newline at end of file diff --git a/kcp/plugin-gradle/build.gradle.kts b/kcp/plugin-gradle/build.gradle.kts index 3b4e22d..a26a825 100644 --- a/kcp/plugin-gradle/build.gradle.kts +++ b/kcp/plugin-gradle/build.gradle.kts @@ -1,11 +1,9 @@ import org.jetbrains.kotlin.gradle.tasks.KotlinCompile -import java.util.Properties plugins { id("java-gradle-plugin") kotlin("jvm") id("com.github.gmazzo.buildconfig") - `maven-publish` } java { @@ -40,46 +38,11 @@ tasks.withType { kotlinOptions.jvmTarget = "1.8" } -tasks.register("sourcesJar", Jar::class) { - group = "build" - description = "Assembles Kotlin sources" - - archiveClassifier.set("sources") - from(sourceSets.main.get().allSource) - dependsOn(tasks.classes) -} - publishing { - publications { - create("default") { - groupId = rootProject.extra["GROUP_ID"].toString() - artifactId = project.extra["ARTIFACT_ID"].toString() - version = rootProject.extra["PLUGIN_VERSION"].toString() - from(components["java"]) - artifact(tasks["sourcesJar"]) - } - } - repositories { maven { name = "Local" url = rootProject.uri("repo") } - - maven { - - // https://github.com/guodongAndroid/maven.git - val mavenUrl = uri(getMavenUrl()) - - name = "Github" - url = mavenUrl - } } -} - -fun getMavenUrl(): String { - val properties = Properties() - val dis = rootProject.file("local.properties").inputStream() - properties.load(dis) - return properties.getProperty("maven.url") } \ No newline at end of file diff --git a/kcp/plugin-gradle/gradle.properties b/kcp/plugin-gradle/gradle.properties index 31117d4..d3da78b 100644 --- a/kcp/plugin-gradle/gradle.properties +++ b/kcp/plugin-gradle/gradle.properties @@ -1,2 +1,3 @@ -ARTIFACT_ID=sword-kcp-gradle-plugin -DESCRIPTION=sword-kcp-gradle-plugin \ No newline at end of file +POM_NAME=sword-kcp-gradle-plugin +POM_ARTIFACT_ID=sword-kcp-gradle-plugin +POM_DESCRIPTION=sword-kcp-gradle-plugin \ No newline at end of file diff --git a/kcp/plugin-kotlin/build.gradle.kts b/kcp/plugin-kotlin/build.gradle.kts index 51c4393..4a30b5d 100644 --- a/kcp/plugin-kotlin/build.gradle.kts +++ b/kcp/plugin-kotlin/build.gradle.kts @@ -1,11 +1,9 @@ import org.jetbrains.kotlin.gradle.tasks.KotlinCompile -import java.util.Properties plugins { kotlin("jvm") kotlin("kapt") id("com.github.gmazzo.buildconfig") - `maven-publish` } java { @@ -39,36 +37,10 @@ tasks.register("sourcesJar", Jar::class) { } publishing { - publications { - create("default") { - groupId = rootProject.extra["GROUP_ID"].toString() - artifactId = project.extra["ARTIFACT_ID"].toString() - version = rootProject.extra["PLUGIN_VERSION"].toString() - from(components["java"]) - artifact(tasks["sourcesJar"]) - } - } - repositories { maven { name = "Local" url = rootProject.uri("repo") } - - maven { - - // https://github.com/guodongAndroid/maven.git - val mavenUrl = uri(getMavenUrl()) - - name = "Github" - url = mavenUrl - } } -} - -fun getMavenUrl(): String { - val properties = Properties() - val dis = rootProject.file("local.properties").inputStream() - properties.load(dis) - return properties.getProperty("maven.url") } \ No newline at end of file diff --git a/kcp/plugin-kotlin/gradle.properties b/kcp/plugin-kotlin/gradle.properties index c507d39..37919a4 100644 --- a/kcp/plugin-kotlin/gradle.properties +++ b/kcp/plugin-kotlin/gradle.properties @@ -1,2 +1,3 @@ -ARTIFACT_ID=sword-kcp-kotlin-plugin -DESCRIPTION=sword-kcp-kotlin-plugin \ No newline at end of file +POM_NAME=sword-kcp-kotlin-plugin +POM_ARTIFACT_ID=sword-kcp-kotlin-plugin +POM_DESCRIPTION=sword-kcp-kotlin-plugin \ No newline at end of file