diff --git a/.editorconfig b/.editorconfig new file mode 100644 index 0000000..e38ba78 --- /dev/null +++ b/.editorconfig @@ -0,0 +1,12 @@ +root = true + +[*] +charset = utf-8 +insert_final_newline = true +indent_style = tab +trim_trailing_whitespace = true +max_line_length = 120 + +[{*.yml,*.yaml}] +indent_style = space +indent_size = 2 diff --git a/.github/boring-cyborg.yml b/.github/boring-cyborg.yml new file mode 100644 index 0000000..b6071de --- /dev/null +++ b/.github/boring-cyborg.yml @@ -0,0 +1,2 @@ +# Boring Cyborg: https://probot.github.io/apps/boring-cyborg/ +_extends: ".github" diff --git a/.github/config.yml b/.github/config.yml new file mode 100644 index 0000000..b3cd5de --- /dev/null +++ b/.github/config.yml @@ -0,0 +1,2 @@ +# to-do: https://probot.github.io/apps/todo/ +_extends: ".github" diff --git a/.github/dependabot.yml b/.github/dependabot.yml new file mode 100644 index 0000000..e1d211c --- /dev/null +++ b/.github/dependabot.yml @@ -0,0 +1,15 @@ +version: 2 +enable-beta-ecosystems: true + +updates: + - package-ecosystem: "gradle" + directory: "/" + + schedule: + interval: "weekly" + + - package-ecosystem: "github-actions" + directory: "/" + + schedule: + interval: "weekly" diff --git a/.github/release.main.kts b/.github/release.main.kts new file mode 100644 index 0000000..0fc691e --- /dev/null +++ b/.github/release.main.kts @@ -0,0 +1,105 @@ +@file:DependsOn("io.github.rybalkinsd:kohttp:0.12.0") +@file:DependsOn("com.google.code.gson:gson:2.8.6") + +import com.google.gson.GsonBuilder +import io.github.rybalkinsd.kohttp.dsl.httpGet +import io.github.rybalkinsd.kohttp.dsl.httpPost +import io.github.rybalkinsd.kohttp.ext.url +import kotlin.system.exitProcess + +val gson = GsonBuilder() + +val webhookUrl: String = System.getenv("WEBHOOK_URL") + +var githubTag: String = System.getenv("GITHUB_REF") +val repo: String = System.getenv("GITHUB_REPOSITORY") + +if (githubTag.contains("/")) { + githubTag = githubTag.split("/").last() +} + +println("Current tag: $githubTag") + +val apiUrl = "https://api.github.com/repos/$repo/releases/tags/$githubTag" + +if (githubTag.contains("v")) { + githubTag = githubTag.split("v", limit = 2).last() +} + +val response = httpGet { url(apiUrl) } +val responseCode = response.code() + +if (responseCode >= 400) { + println("API error: HTTP $responseCode") + println(response.body()?.string()) + + exitProcess(1) +} + +val data = gson.create().fromJson>(response.body()!!.string(), Map::class.java) + +val author = data["author"] as Map<*, *> + +val authorAvatar = author["avatar_url"] as String +val authorName = author["login"] as String +val authorUrl = author["html_url"] as String + +var releaseBody = (data["body"] as String).replace("\n* ", "\n**»** ").trim() +val releaseName = data["name"] as String +val releaseTime = data["published_at"] as String +val releaseUrl = data["html_url"] as String + +if (releaseBody.startsWith("#")) { + val lines = releaseBody.split("\n").toMutableList() + + lines[0] = lines[0].replaceFirst("#", "**") + "**" + releaseBody = lines.joinToString("\n") +} + +if (releaseBody.contains("---")) { + releaseBody = releaseBody.split("---", limit = 2).first() +} + +val webhook = mapOf( + "embeds" to listOf( + mapOf( + "color" to 7506394, + "description" to releaseBody, + "timestamp" to releaseTime.replace("Z", ".000Z"), + "title" to releaseName, + "url" to releaseUrl, + + "author" to mapOf( + "icon_url" to authorAvatar, + "name" to authorName, + "url" to authorUrl, + ) + ) + ) +) + +val jsonBody = gson.create().toJson(webhook) + +val webhookResponse = httpPost { + url(webhookUrl) + + header { + "User-Agent" to "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_9_3) AppleWebKit/537.36 (KHTML, like Gecko) " + + "Chrome/35.0.1916.47 Safari/537.36" + } + + body { + json(jsonBody) + } +} + +val webhookCode = webhookResponse.code() + +if (webhookCode >= 400) { + println("Webhook error: HTTP $webhookCode") + println(webhookResponse.body()?.string()) + + exitProcess(1) +} + +exitProcess(0) diff --git a/.github/settings.yml b/.github/settings.yml new file mode 100644 index 0000000..862a003 --- /dev/null +++ b/.github/settings.yml @@ -0,0 +1,2 @@ +# Settings: https://probot.github.io/apps/settings/ +_extends: ".github" diff --git a/.github/tag.main.kts b/.github/tag.main.kts new file mode 100644 index 0000000..7fa3f91 --- /dev/null +++ b/.github/tag.main.kts @@ -0,0 +1,77 @@ +@file:DependsOn("com.lordcodes.turtle:turtle:0.5.0") + +import com.lordcodes.turtle.shellRun +import java.io.File +import kotlin.system.exitProcess + +//val webhookUrl = System.getenv("WEBHOOK_URL") +val repo = System.getenv("GITHUB_REPOSITORY") + +var githubTag: String = System.getenv("GITHUB_REF") ?: error("No tag found in GITHUB_REF env var") + +if (githubTag.contains("/")) { + githubTag = githubTag.split("/").last() +} + +println("Current tag: $githubTag") + +if (githubTag.contains("v")) { + githubTag = githubTag.split("v", limit = 2).last() +} + +val tags = shellRun("git", listOf("tag")).trim().split("\n") + +val commits = if (tags.size < 2) { + println("No previous tags, using all branch commits.") + + shellRun("git", listOf("log", "--format=oneline", "--no-color")) +} else { + val previousTag = tags.takeLast(2).first() + + println("Previous tag: $previousTag") + + shellRun("git", listOf("log", "--format=oneline", "--no-color", "$previousTag..HEAD")) +}.split("\n").map { + val split = it.split(" ", limit = 2) + val commit = split.first() + val message = split.last() + + Pair(commit, message) +} + +println("Commits: ${commits.size}") + +val commitList = if (commits.size > 10) { + commits.take(10).joinToString("\n") { + val (commit, message) = it + + "* [${commit.take(6)}](https://github.com/$repo/commit/$commit): $message" + } + "\n\n...and ${commits.size - 10} more." +} else { + commits.joinToString("\n") { + val (commit, message) = it + + "* [${commit.take(6)}](https://github.com/$repo/commit/$commit): $message" + } +} + +val descFile = File("changes/$githubTag.md") + +val description = if (descFile.exists()) { + descFile.readText(Charsets.UTF_8).trim() +} else { + "Description file `changes/$githubTag.md` not found - this release will need to be updated later!" +} + +val file = File("release.md") + +file.writeText( + "$description\n\n" + + "---\n\n" + + "# Commits (${commits.size}) \n\n" + + commitList +) + +print("File written: release.md") + +exitProcess(0) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml new file mode 100644 index 0000000..df0ce4c --- /dev/null +++ b/.github/workflows/ci.yml @@ -0,0 +1,44 @@ +name: CI (PRs/branches) + +on: + push: + branches-ignore: + - "root" + + pull_request: + merge_group: + +jobs: + build: + runs-on: ubuntu-latest + + steps: + - uses: actions/checkout@v4 + + - name: Set up Java + uses: actions/setup-java@v4 + + with: + java-version: 17 + distribution: temurin + + - name: Set up Gradle properties + run: | + mkdir -p ~/.gradle + echo "org.gradle.jvmargs=-XX:MaxMetaspaceSize=5G" >> ~/.gradle/gradle.properties + + - name: Gradle (Setup) + uses: gradle/actions/setup-gradle@v4 + + - name: Gradle (Build) + run: "./gradlew checkLicenses build" + + env: + NO_SIGNING: "true" + + - name: Upload JARs + uses: actions/upload-artifact@v4 + + with: + name: JARs + path: "*/build/libs/*.jar" diff --git a/.github/workflows/root.yml b/.github/workflows/root.yml new file mode 100644 index 0000000..51bff44 --- /dev/null +++ b/.github/workflows/root.yml @@ -0,0 +1,53 @@ +name: CI (root) + +on: + push: + branches: + - "root" + +permissions: + contents: write + id-token: write + +jobs: + build: + runs-on: ubuntu-latest + + steps: + - uses: actions/checkout@v4 + + - name: Set up Java + uses: actions/setup-java@v4 + + with: + java-version: 17 + distribution: temurin + + - name: Set up Kotlin + uses: fwilhe2/setup-kotlin@main + + - name: Set up Gradle properties + + run: | + mkdir -p ~/.gradle + echo "githubToken=${{ secrets.GITHUB_TOKEN }}" >> ~/.gradle/gradle.properties + echo -e "\norg.gradle.jvmargs=-XX:MaxMetaspaceSize=5G" >> ~/.gradle/gradle.properties + + - name: Gradle (Setup) + uses: gradle/actions/setup-gradle@v4 + + with: + dependency-graph: generate-and-submit + + - name: Gradle (Build) + run: "./gradlew checkLicenses build" + + env: + NO_SIGNING: "true" + + - name: Upload JARs + uses: actions/upload-artifact@v4 + + with: + name: JARs + path: "*/build/libs/*.jar" diff --git a/.github/workflows/tag.yml b/.github/workflows/tag.yml new file mode 100644 index 0000000..77cb92e --- /dev/null +++ b/.github/workflows/tag.yml @@ -0,0 +1,89 @@ +name: Release Tag + +on: + push: + tags: + - "v*" + +jobs: + release: + runs-on: ubuntu-latest + + steps: + - uses: actions/checkout@v4 + + - name: Set up Java + uses: actions/setup-java@v4 + + with: + java-version: 17 + distribution: temurin + + - name: Set up Kotlin + uses: fwilhe2/setup-kotlin@main + + - name: Set up Gradle properties + run: | + mkdir -p ~/.gradle + echo "org.gradle.jvmargs=-XX:MaxMetaspaceSize=5G" >> ~/.gradle/gradle.properties + echo -e "\nsigning.gnupg.keyName=BFAAD5D6093EF5E62BC9A16A10DB8C6B4AE61C2F" >> ~/.gradle/gradle.properties + echo -e "\nsigning.gnupg.passphrase=${{ secrets.GPG_PASSWORD }}" >> ~/.gradle/gradle.properties + + - name: Set up git credentials + uses: oleksiyrudenko/gha-git-credentials@v2 + + with: + global: true + token: '${{ secrets.GITHUB_TOKEN }}' + + + - name: Gradle (Setup) + uses: gradle/actions/setup-gradle@v4 + + with: + dependency-graph: generate-and-submit + + - name: Gradle (Build and Publish) + run: "./gradlew checkLicenses build publish" + + env: + ORG_GRADLE_PROJECT_signingKey: "${{ secrets.GPG_KEY }}" + ORG_GRADLE_PROJECT_signingPassword: "${{ secrets.GPG_PASSWORD }}" + + KORDEX_MAVEN_PASSWORD: "${{ secrets.KORDEX_MAVEN_PASSWORD }}" + KORDEX_MAVEN_USERNAME: "${{ secrets.KORDEX_MAVEN_USERNAME }}" + + TOKEN: "${{ secrets.TOKEN }}" + + - name: Create release description + run: kotlin .github/tag.main.kts + + - name: Get tag name + id: get_tag + run: echo ::set-output name=NAME::${GITHUB_REF#refs/tags/} + + - name: Create Release + uses: softprops/action-gh-release@v2 + + env: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + + with: + body_path: release.md + name: Release ${{ steps.get_tag.outputs.NAME }} + + files: | + */build/libs/*.jar + + - name: Release webhook + run: kotlin .github/release.main.kts + + env: + WEBHOOK_URL: ${{ secrets.WEBHOOK_URL }} + + - name: Upload JARs + uses: actions/upload-artifact@v4 + + with: + name: JARs + path: "*/build/libs/*.jar" diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..094473a --- /dev/null +++ b/.gitignore @@ -0,0 +1,46 @@ +.gradle +build/ +!gradle/wrapper/gradle-wrapper.jar +!**/src/main/**/build/ +!**/src/test/**/build/ + +### IntelliJ IDEA ### +.idea/modules.xml +.idea/jarRepositories.xml +.idea/compiler.xml +.idea/libraries/ +*.iws +*.iml +*.ipr +out/ +!**/src/main/**/out/ +!**/src/test/**/out/ + +### Eclipse ### +.apt_generated +.classpath +.factorypath +.project +.settings +.springBeans +.sts4-cache +bin/ +!**/src/main/**/bin/ +!**/src/test/**/bin/ + +### NetBeans ### +/nbproject/private/ +/nbbuild/ +/dist/ +/nbdist/ +/.nb-gradle/ + +### VS Code ### +.vscode/ + +### Mac OS ### +.DS_Store + +### Custom Ignores ### +/testModule/Dockerfile +/test/output diff --git a/.idea/.gitignore b/.idea/.gitignore new file mode 100644 index 0000000..0a8642f --- /dev/null +++ b/.idea/.gitignore @@ -0,0 +1,10 @@ +# Default ignored files +/shelf/ +/workspace.xml +# Editor-based HTTP Client requests +/httpRequests/ +# Datasource local storage ignored files +/dataSources/ +/dataSources.local.xml +# Zeppelin ignored files +/ZeppelinRemoteNotebooks/ diff --git a/.idea/copyright/MPL.xml b/.idea/copyright/MPL.xml new file mode 100644 index 0000000..b7c4bb5 --- /dev/null +++ b/.idea/copyright/MPL.xml @@ -0,0 +1,6 @@ + + + + \ No newline at end of file diff --git a/.idea/git_toolbox_blame.xml b/.idea/git_toolbox_blame.xml new file mode 100644 index 0000000..7dc1249 --- /dev/null +++ b/.idea/git_toolbox_blame.xml @@ -0,0 +1,6 @@ + + + + + \ No newline at end of file diff --git a/.idea/gradle.xml b/.idea/gradle.xml new file mode 100644 index 0000000..464fb93 --- /dev/null +++ b/.idea/gradle.xml @@ -0,0 +1,30 @@ + + + + + + + \ No newline at end of file diff --git a/.idea/kotlinc.xml b/.idea/kotlinc.xml new file mode 100644 index 0000000..fe63bb6 --- /dev/null +++ b/.idea/kotlinc.xml @@ -0,0 +1,6 @@ + + + + + \ No newline at end of file diff --git a/.idea/misc.xml b/.idea/misc.xml new file mode 100644 index 0000000..5066fd0 --- /dev/null +++ b/.idea/misc.xml @@ -0,0 +1,13 @@ + + + + + + + + + + + + \ No newline at end of file diff --git a/.idea/vcs.xml b/.idea/vcs.xml new file mode 100644 index 0000000..94a25f7 --- /dev/null +++ b/.idea/vcs.xml @@ -0,0 +1,6 @@ + + + + + + \ No newline at end of file diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..a612ad9 --- /dev/null +++ b/LICENSE @@ -0,0 +1,373 @@ +Mozilla Public License Version 2.0 +================================== + +1. Definitions +-------------- + +1.1. "Contributor" + means each individual or legal entity that creates, contributes to + the creation of, or owns Covered Software. + +1.2. "Contributor Version" + means the combination of the Contributions of others (if any) used + by a Contributor and that particular Contributor's Contribution. + +1.3. "Contribution" + means Covered Software of a particular Contributor. + +1.4. "Covered Software" + means Source Code Form to which the initial Contributor has attached + the notice in Exhibit A, the Executable Form of such Source Code + Form, and Modifications of such Source Code Form, in each case + including portions thereof. + +1.5. "Incompatible With Secondary Licenses" + means + + (a) that the initial Contributor has attached the notice described + in Exhibit B to the Covered Software; or + + (b) that the Covered Software was made available under the terms of + version 1.1 or earlier of the License, but not also under the + terms of a Secondary License. + +1.6. "Executable Form" + means any form of the work other than Source Code Form. + +1.7. "Larger Work" + means a work that combines Covered Software with other material, in + a separate file or files, that is not Covered Software. + +1.8. "License" + means this document. + +1.9. "Licensable" + means having the right to grant, to the maximum extent possible, + whether at the time of the initial grant or subsequently, any and + all of the rights conveyed by this License. + +1.10. "Modifications" + means any of the following: + + (a) any file in Source Code Form that results from an addition to, + deletion from, or modification of the contents of Covered + Software; or + + (b) any new file in Source Code Form that contains any Covered + Software. + +1.11. "Patent Claims" of a Contributor + means any patent claim(s), including without limitation, method, + process, and apparatus claims, in any patent Licensable by such + Contributor that would be infringed, but for the grant of the + License, by the making, using, selling, offering for sale, having + made, import, or transfer of either its Contributions or its + Contributor Version. + +1.12. "Secondary License" + means either the GNU General Public License, Version 2.0, the GNU + Lesser General Public License, Version 2.1, the GNU Affero General + Public License, Version 3.0, or any later versions of those + licenses. + +1.13. "Source Code Form" + means the form of the work preferred for making modifications. + +1.14. "You" (or "Your") + means an individual or a legal entity exercising rights under this + License. For legal entities, "You" includes any entity that + controls, is controlled by, or is under common control with You. For + purposes of this definition, "control" means (a) the power, direct + or indirect, to cause the direction or management of such entity, + whether by contract or otherwise, or (b) ownership of more than + fifty percent (50%) of the outstanding shares or beneficial + ownership of such entity. + +2. License Grants and Conditions +-------------------------------- + +2.1. Grants + +Each Contributor hereby grants You a world-wide, royalty-free, +non-exclusive license: + +(a) under intellectual property rights (other than patent or trademark) + Licensable by such Contributor to use, reproduce, make available, + modify, display, perform, distribute, and otherwise exploit its + Contributions, either on an unmodified basis, with Modifications, or + as part of a Larger Work; and + +(b) under Patent Claims of such Contributor to make, use, sell, offer + for sale, have made, import, and otherwise transfer either its + Contributions or its Contributor Version. + +2.2. Effective Date + +The licenses granted in Section 2.1 with respect to any Contribution +become effective for each Contribution on the date the Contributor first +distributes such Contribution. + +2.3. Limitations on Grant Scope + +The licenses granted in this Section 2 are the only rights granted under +this License. No additional rights or licenses will be implied from the +distribution or licensing of Covered Software under this License. +Notwithstanding Section 2.1(b) above, no patent license is granted by a +Contributor: + +(a) for any code that a Contributor has removed from Covered Software; + or + +(b) for infringements caused by: (i) Your and any other third party's + modifications of Covered Software, or (ii) the combination of its + Contributions with other software (except as part of its Contributor + Version); or + +(c) under Patent Claims infringed by Covered Software in the absence of + its Contributions. + +This License does not grant any rights in the trademarks, service marks, +or logos of any Contributor (except as may be necessary to comply with +the notice requirements in Section 3.4). + +2.4. Subsequent Licenses + +No Contributor makes additional grants as a result of Your choice to +distribute the Covered Software under a subsequent version of this +License (see Section 10.2) or under the terms of a Secondary License (if +permitted under the terms of Section 3.3). + +2.5. Representation + +Each Contributor represents that the Contributor believes its +Contributions are its original creation(s) or it has sufficient rights +to grant the rights to its Contributions conveyed by this License. + +2.6. Fair Use + +This License is not intended to limit any rights You have under +applicable copyright doctrines of fair use, fair dealing, or other +equivalents. + +2.7. Conditions + +Sections 3.1, 3.2, 3.3, and 3.4 are conditions of the licenses granted +in Section 2.1. + +3. Responsibilities +------------------- + +3.1. Distribution of Source Form + +All distribution of Covered Software in Source Code Form, including any +Modifications that You create or to which You contribute, must be under +the terms of this License. You must inform recipients that the Source +Code Form of the Covered Software is governed by the terms of this +License, and how they can obtain a copy of this License. You may not +attempt to alter or restrict the recipients' rights in the Source Code +Form. + +3.2. Distribution of Executable Form + +If You distribute Covered Software in Executable Form then: + +(a) such Covered Software must also be made available in Source Code + Form, as described in Section 3.1, and You must inform recipients of + the Executable Form how they can obtain a copy of such Source Code + Form by reasonable means in a timely manner, at a charge no more + than the cost of distribution to the recipient; and + +(b) You may distribute such Executable Form under the terms of this + License, or sublicense it under different terms, provided that the + license for the Executable Form does not attempt to limit or alter + the recipients' rights in the Source Code Form under this License. + +3.3. Distribution of a Larger Work + +You may create and distribute a Larger Work under terms of Your choice, +provided that You also comply with the requirements of this License for +the Covered Software. If the Larger Work is a combination of Covered +Software with a work governed by one or more Secondary Licenses, and the +Covered Software is not Incompatible With Secondary Licenses, this +License permits You to additionally distribute such Covered Software +under the terms of such Secondary License(s), so that the recipient of +the Larger Work may, at their option, further distribute the Covered +Software under the terms of either this License or such Secondary +License(s). + +3.4. Notices + +You may not remove or alter the substance of any license notices +(including copyright notices, patent notices, disclaimers of warranty, +or limitations of liability) contained within the Source Code Form of +the Covered Software, except that You may alter any license notices to +the extent required to remedy known factual inaccuracies. + +3.5. Application of Additional Terms + +You may choose to offer, and to charge a fee for, warranty, support, +indemnity or liability obligations to one or more recipients of Covered +Software. However, You may do so only on Your own behalf, and not on +behalf of any Contributor. You must make it absolutely clear that any +such warranty, support, indemnity, or liability obligation is offered by +You alone, and You hereby agree to indemnify every Contributor for any +liability incurred by such Contributor as a result of warranty, support, +indemnity or liability terms You offer. You may include additional +disclaimers of warranty and limitations of liability specific to any +jurisdiction. + +4. Inability to Comply Due to Statute or Regulation +--------------------------------------------------- + +If it is impossible for You to comply with any of the terms of this +License with respect to some or all of the Covered Software due to +statute, judicial order, or regulation then You must: (a) comply with +the terms of this License to the maximum extent possible; and (b) +describe the limitations and the code they affect. Such description must +be placed in a text file included with all distributions of the Covered +Software under this License. Except to the extent prohibited by statute +or regulation, such description must be sufficiently detailed for a +recipient of ordinary skill to be able to understand it. + +5. Termination +-------------- + +5.1. The rights granted under this License will terminate automatically +if You fail to comply with any of its terms. However, if You become +compliant, then the rights granted under this License from a particular +Contributor are reinstated (a) provisionally, unless and until such +Contributor explicitly and finally terminates Your grants, and (b) on an +ongoing basis, if such Contributor fails to notify You of the +non-compliance by some reasonable means prior to 60 days after You have +come back into compliance. Moreover, Your grants from a particular +Contributor are reinstated on an ongoing basis if such Contributor +notifies You of the non-compliance by some reasonable means, this is the +first time You have received notice of non-compliance with this License +from such Contributor, and You become compliant prior to 30 days after +Your receipt of the notice. + +5.2. If You initiate litigation against any entity by asserting a patent +infringement claim (excluding declaratory judgment actions, +counter-claims, and cross-claims) alleging that a Contributor Version +directly or indirectly infringes any patent, then the rights granted to +You by any and all Contributors for the Covered Software under Section +2.1 of this License shall terminate. + +5.3. In the event of termination under Sections 5.1 or 5.2 above, all +end user license agreements (excluding distributors and resellers) which +have been validly granted by You or Your distributors under this License +prior to termination shall survive termination. + +************************************************************************ +* * +* 6. Disclaimer of Warranty * +* ------------------------- * +* * +* Covered Software is provided under this License on an "as is" * +* basis, without warranty of any kind, either expressed, implied, or * +* statutory, including, without limitation, warranties that the * +* Covered Software is free of defects, merchantable, fit for a * +* particular purpose or non-infringing. The entire risk as to the * +* quality and performance of the Covered Software is with You. * +* Should any Covered Software prove defective in any respect, You * +* (not any Contributor) assume the cost of any necessary servicing, * +* repair, or correction. This disclaimer of warranty constitutes an * +* essential part of this License. No use of any Covered Software is * +* authorized under this License except under this disclaimer. * +* * +************************************************************************ + +************************************************************************ +* * +* 7. Limitation of Liability * +* -------------------------- * +* * +* Under no circumstances and under no legal theory, whether tort * +* (including negligence), contract, or otherwise, shall any * +* Contributor, or anyone who distributes Covered Software as * +* permitted above, be liable to You for any direct, indirect, * +* special, incidental, or consequential damages of any character * +* including, without limitation, damages for lost profits, loss of * +* goodwill, work stoppage, computer failure or malfunction, or any * +* and all other commercial damages or losses, even if such party * +* shall have been informed of the possibility of such damages. This * +* limitation of liability shall not apply to liability for death or * +* personal injury resulting from such party's negligence to the * +* extent applicable law prohibits such limitation. Some * +* jurisdictions do not allow the exclusion or limitation of * +* incidental or consequential damages, so this exclusion and * +* limitation may not apply to You. * +* * +************************************************************************ + +8. Litigation +------------- + +Any litigation relating to this License may be brought only in the +courts of a jurisdiction where the defendant maintains its principal +place of business and such litigation shall be governed by laws of that +jurisdiction, without reference to its conflict-of-law provisions. +Nothing in this Section shall prevent a party's ability to bring +cross-claims or counter-claims. + +9. Miscellaneous +---------------- + +This License represents the complete agreement concerning the subject +matter hereof. If any provision of this License is held to be +unenforceable, such provision shall be reformed only to the extent +necessary to make it enforceable. Any law or regulation which provides +that the language of a contract shall be construed against the drafter +shall not be used to construe this License against a Contributor. + +10. Versions of the License +--------------------------- + +10.1. New Versions + +Mozilla Foundation is the license steward. Except as provided in Section +10.3, no one other than the license steward has the right to modify or +publish new versions of this License. Each version will be given a +distinguishing version number. + +10.2. Effect of New Versions + +You may distribute the Covered Software under the terms of the version +of the License under which You originally received the Covered Software, +or under the terms of any subsequent version published by the license +steward. + +10.3. Modified Versions + +If you create software not governed by this License, and you want to +create a new license for such software, you may create and use a +modified version of this License if you rename the license and remove +any references to the name of the license steward (except to note that +such modified license differs from this License). + +10.4. Distributing Source Code Form that is Incompatible With Secondary +Licenses + +If You choose to distribute Source Code Form that is Incompatible With +Secondary Licenses under the terms of this version of the License, the +notice described in Exhibit B of this License must be attached. + +Exhibit A - Source Code Form License Notice +------------------------------------------- + + This Source Code Form is subject to the terms of the Mozilla Public + License, v. 2.0. If a copy of the MPL was not distributed with this + file, You can obtain one at http://mozilla.org/MPL/2.0/. + +If it is not possible or desirable to put the notice in a particular +file, then You may include the notice in a location (such as a LICENSE +file in a relevant directory) where a recipient would be likely to look +for such a notice. + +You may add additional accurate notices of copyright ownership. + +Exhibit B - "Incompatible With Secondary Licenses" Notice +--------------------------------------------------------- + + This Source Code Form is "Incompatible With Secondary Licenses", as + defined by the Mozilla Public License, v. 2.0. diff --git a/README.md b/README.md new file mode 100644 index 0000000..344b4ea --- /dev/null +++ b/README.md @@ -0,0 +1,68 @@ +# Kord Extensions i18n Tools + +This repository contains a set of tools and APIs used by Kord Extensions and its Gradle plugins to implement and work +with the translations system. + +You can find the current version on [the releases page](https://github.com/Kord-Extensions/i18n/releases). + +# Translation Class Generator + +As of Kord Extensions 2.3.0, users must provide all translation keys as `Key` objects. +To make this easier and more intuitive, the translation class generator reads the default translations for a translation +bundle and generates a class containing the corresponding keys. + +As some Kord Extensions users either don't use Gradle or don't wish to use our Gradle plugin, the generator is available +here as a standalone API and CLI tool. + +## API + +- Releases repo: `https://releases-repo.kordex.dev` +- Snapshots repo: `https://snapshots-repo.kordex.dev` +- Maven Coordinate: `dev.kordex.i18n:i18n-generator:VERSION` + +A single API class is exposed as `TranslationsClass`. + +To generate a translations class, create an instance of `TranslationsClass`, pass the constructor the following data: + +- `allProps`, a `Properties` instance containing the translation keys and default values. +- `bundle`, the corresponding bundle name. +- `className`, the name used by the generated class. +- `classPackage`, the package containing the generated class. + +If you need to access the KotlinPoet `FileSpec` object, access it via the `spec` property. +Otherwise, use the `writeTo(File)` function to write the generated class to a given directory, including the package +structure. + +## CLI Tool + +The CLI tool is meant to be integrated with non-Gradle workflows, allowing you to generate translations classes without +using our Gradle plugins. + +This tool requires Java 21 or later. Download the latest `-all` JAR from +[the releases page](https://github.com/Kord-Extensions/i18n/releases), and run it as follows: + +```bash +java -jar i18n-generator--all.jar +``` + +This tool will parse a properties file and output a generated class containing the given bundle, +and the file's translation keys along with a comment containing the default translation. +The tool will generate this class within a directory tree matching the given package. + +### Required Parameters + +- `-b, --bundle` - Bundle name, represented as a dot-separated string matching your resource files. + For example, `template.string` would correspond with `translations/template/string.properties`. +- `-i, --input-file` - Location of a properties file representing your bundle's default translations. +- `-p, --class-package` - Dot-separated package name to place your generated files within. + +### Optional Parameters + +- `-c, --class-name = Translations` - Name for the generated root class. +- `-e, --encoding = UTF-8` - Encoding used to read the input properties file. +- `-o, --output-dir = ./output` - Output directory for the generated files. + +### Other Parameters + +- `-h, --help` - Output a help message and exit. +- `-V ,--version` - Output the current version number and exit. diff --git a/buildSrc/build.gradle.kts b/buildSrc/build.gradle.kts new file mode 100644 index 0000000..0532e49 --- /dev/null +++ b/buildSrc/build.gradle.kts @@ -0,0 +1,25 @@ +plugins { + `kotlin-dsl` +} + +repositories { + google() + gradlePluginPortal() + + mavenCentral() +} + +dependencies { + implementation(kotlin("gradle-plugin", version = "1.9.23")) + implementation(kotlin("serialization", version = "1.9.23")) + + implementation("dev.yumi", "yumi-gradle-licenser", "1.2.0") + implementation("io.gitlab.arturbosch.detekt", "detekt-gradle-plugin", "1.23.6") +} + +beforeEvaluate { + val projectVersion: String by project + + group = "dev.kordex.i18n" + version = projectVersion +} diff --git a/buildSrc/src/main/kotlin/ProjectTools.kt b/buildSrc/src/main/kotlin/ProjectTools.kt new file mode 100644 index 0000000..ad00f17 --- /dev/null +++ b/buildSrc/src/main/kotlin/ProjectTools.kt @@ -0,0 +1,20 @@ +import org.gradle.api.Project +import org.gradle.api.plugins.ExtraPropertiesExtension +import org.gradle.kotlin.dsl.getByType +import kotlin.apply + +class MetadataBuilder { + lateinit var name: String + lateinit var description: String +} + +fun Project.metadata(body: (MetadataBuilder).() -> Unit) { + val builder = MetadataBuilder() + + body(builder) + + extensions.getByType().apply { + set("pubName", builder.name) + set("pubDesc", builder.description) + } +} diff --git a/buildSrc/src/main/kotlin/general.gradle.kts b/buildSrc/src/main/kotlin/general.gradle.kts new file mode 100644 index 0000000..71bdc09 --- /dev/null +++ b/buildSrc/src/main/kotlin/general.gradle.kts @@ -0,0 +1,39 @@ +import org.gradle.kotlin.dsl.from + +plugins { + id("dev.yumi.gradle.licenser") + id("io.gitlab.arturbosch.detekt") + + kotlin("jvm") + kotlin("plugin.serialization") +} + +repositories { + mavenCentral() +} + +detekt { + buildUponDefaultConfig = true + config.from(rootProject.file("detekt.yml")) + + autoCorrect = true +} + +dependencies { + detektPlugins("io.gitlab.arturbosch.detekt:detekt-formatting:1.23.6") + detektPlugins("io.gitlab.arturbosch.detekt:detekt-rules-libraries:1.23.6") +} + +license { + rule(rootProject.file("codeformat/HEADER")) +} + +kotlin { + explicitApi() +} + +val sourceJar = task("sourceJar", Jar::class) { + dependsOn(tasks["classes"]) + archiveClassifier = "sources" + from(sourceSets.main.get().allSource) +} diff --git a/buildSrc/src/main/kotlin/published.gradle.kts b/buildSrc/src/main/kotlin/published.gradle.kts new file mode 100644 index 0000000..deefe4f --- /dev/null +++ b/buildSrc/src/main/kotlin/published.gradle.kts @@ -0,0 +1,85 @@ +import org.gradle.kotlin.dsl.from +import kotlin.text.get +import kotlin.text.set + +plugins { + `maven-publish` + signing +} + +val sourceJar: Task by tasks.getting +//val javadocJar: Task by tasks.getting +//val dokkaJar: Task by tasks.getting + +afterEvaluate { + publishing { + repositories { + maven { + name = "KordEx: i18n" + + url = if (project.version.toString().contains("SNAPSHOT")) { + uri("https://repo.kordex.dev/snapshots/") + } else { + uri("https://repo.kordex.dev/releases/") + } + + credentials { + username = project.findProperty("ossrhUsername") as String? + ?: System.getenv("KORDEX_MAVEN_USERNAME") + + password = project.findProperty("ossrhPassword") as String? + ?: System.getenv("KORDEX_MAVEN_PASSWORD") + } + + version = project.version + } + } + + publications { + create("maven") { + from(components.getByName("java")) + + artifact(sourceJar) +// artifact(javadocJar) + + pom { + name.set(project.ext.get("pubName").toString()) + description.set(project.ext.get("pubDesc").toString()) + + url.set("https://kordex.dev") + + packaging = "jar" + + scm { + connection.set("scm:git:https://github.com/Kord-Extensions/i18n.git") + developerConnection.set("scm:git:git@github.com:Kord-Extensions/i18n.git") + url.set("https://github.com/Kord-Extensions/i18n.git") + } + + licenses { + license { + name.set("Mozilla Public License Version 2.0") + url.set("https://www.mozilla.org/en-US/MPL/2.0/") + } + } + + developers { + developer { + id.set("gdude2002") + name.set("Gareth Coles") + } + } + } + } + } + } + + signing { + val signingKey: String? by project ?: return@signing + val signingPassword: String? by project ?: return@signing + + useInMemoryPgpKeys(signingKey, signingPassword) + + sign(publishing.publications["maven"]) + } +} diff --git a/changes/v1.0.0.md b/changes/v1.0.0.md new file mode 100644 index 0000000..544e73c --- /dev/null +++ b/changes/v1.0.0.md @@ -0,0 +1,9 @@ +# i18n tools 1.0.0 + +This is the first tagged release for our i18n tools, and it represents the first major milestone for this repository. + +## Translations Class Generator + +This is the first release for our translation class generator tool. This is a self-contained API and CLI tool, which generates a KordEx translations class based on a translation properties file and a few other pieces of information. + +To learn more about what this is and how to use it, please check [the README file](https://github.com/Kord-Extensions/i18n#readme). diff --git a/codeformat/HEADER b/codeformat/HEADER new file mode 100644 index 0000000..b0a9688 --- /dev/null +++ b/codeformat/HEADER @@ -0,0 +1,3 @@ +This Source Code Form is subject to the terms of the Mozilla Public +License, v. 2.0. If a copy of the MPL was not distributed with this +file, You can obtain one at https://mozilla.org/MPL/2.0/. diff --git a/detekt.yml b/detekt.yml new file mode 100644 index 0000000..7bd176e --- /dev/null +++ b/detekt.yml @@ -0,0 +1,660 @@ +build: + maxIssues: 0 + excludeCorrectable: false + weights: + # complexity: 2 + # LongParameterList: 1 + # style: 1 + # comments: 1 + +config: + validation: true + # when writing own rules with new properties, exclude the property path e.g.: 'my_rule_set,.*>.*>[my_property]' + excludes: '' + +processors: + active: true + exclude: + - 'DetektProgressListener' + - 'FunctionCountProcessor' + - 'PropertyCountProcessor' + - 'ClassCountProcessor' + - 'PackageCountProcessor' + - 'KtFileCountProcessor' + +console-reports: + active: true + exclude: + - 'ProjectStatisticsReport' + - 'NotificationReport' + - 'FileBasedFindingsReport' + +output-reports: + active: true + exclude: + # - 'HtmlOutputReport' + - 'TxtOutputReport' + # - 'XmlOutputReport' + +comments: + active: true + excludes: [ '**/test/**', '**/androidTest/**', '**/*.Test.kt', '**/*.Spec.kt', '**/*.Spek.kt' ] + AbsentOrWrongFileLicense: + active: false + licenseTemplateFile: 'license.template' + CommentOverPrivateFunction: + active: false + CommentOverPrivateProperty: + active: false + EndOfSentenceFormat: + active: true + endOfSentenceFormat: '([.?!][ \t\n\r\f<])|([.?!:]$)' + UndocumentedPublicClass: + active: false + searchInNestedClass: true + searchInInnerClass: true + searchInInnerObject: true + searchInInnerInterface: true + UndocumentedPublicFunction: + active: false + UndocumentedPublicProperty: + active: false + +complexity: + active: true + ComplexCondition: + active: true + threshold: 10 + ComplexInterface: + active: false + threshold: 10 + includeStaticDeclarations: false + includePrivateDeclarations: false + CyclomaticComplexMethod: + active: false + threshold: 15 + ignoreSingleWhenExpression: false + ignoreSimpleWhenEntries: false + ignoreNestingFunctions: false + nestingFunctions: [ run, let, apply, with, also, use, forEach, isNotNull, ifNull ] + LabeledExpression: + active: false + ignoredLabels: [ ] + LargeClass: + active: false + threshold: 600 + LongMethod: + active: false + threshold: 60 + LongParameterList: + active: false + functionThreshold: 6 + constructorThreshold: 7 + ignoreDefaultParameters: false + ignoreDataClasses: true + ignoreAnnotated: [ ] + MethodOverloading: + active: false + threshold: 6 + NestedBlockDepth: + active: false + threshold: 4 + ReplaceSafeCallChainWithRun: + active: true + StringLiteralDuplication: + active: true + excludes: [ '**/test/**', '**/androidTest/**', '**/*.Test.kt', '**/*.Spec.kt', '**/*.Spek.kt' ] + threshold: 3 + ignoreAnnotation: true + excludeStringsWithLessThan5Characters: true + ignoreStringsRegex: '$^' + TooManyFunctions: + active: false + excludes: [ '**/test/**', '**/androidTest/**', '**/*.Test.kt', '**/*.Spec.kt', '**/*.Spek.kt' ] + thresholdInFiles: 11 + thresholdInClasses: 11 + thresholdInInterfaces: 11 + thresholdInObjects: 11 + thresholdInEnums: 11 + ignoreDeprecated: false + ignorePrivate: false + ignoreOverridden: false + +coroutines: + active: true + GlobalCoroutineUsage: + active: true + RedundantSuspendModifier: + active: true + SuspendFunWithFlowReturnType: + active: true + +empty-blocks: + active: true + EmptyCatchBlock: + active: true + allowedExceptionNameRegex: '^(_|(ignore|expected).*)' + EmptyClassBlock: + active: true + EmptyDefaultConstructor: + active: true + EmptyDoWhileBlock: + active: true + EmptyElseBlock: + active: true + EmptyFinallyBlock: + active: true + EmptyForBlock: + active: true + EmptyFunctionBlock: + active: true + ignoreOverridden: false + EmptyIfBlock: + active: true + EmptyInitBlock: + active: true + EmptyKtFile: + active: true + EmptySecondaryConstructor: + active: true + EmptyTryBlock: + active: true + EmptyWhenBlock: + active: true + EmptyWhileBlock: + active: true + +exceptions: + active: true + ExceptionRaisedInUnexpectedLocation: + active: true + methodNames: [ toString, hashCode, equals, finalize ] + InstanceOfCheckForException: + active: false # It does often make things more readable + excludes: [ '**/test/**', '**/androidTest/**', '**/*.Test.kt', '**/*.Spec.kt', '**/*.Spek.kt' ] + NotImplementedDeclaration: + active: false + PrintStackTrace: + active: true + RethrowCaughtException: + active: true + ReturnFromFinally: + active: true + ignoreLabeled: false + SwallowedException: + active: false + ignoredExceptionTypes: + - InterruptedException + - NumberFormatException + - ParseException + - MalformedURLException + allowedExceptionNameRegex: '^(_|(ignore|expected).*)' + ThrowingExceptionFromFinally: + active: true + ThrowingExceptionInMain: + active: true + ThrowingExceptionsWithoutMessageOrCause: + active: true + exceptions: + - IllegalArgumentException + - IllegalStateException + - IOException + ThrowingNewInstanceOfSameException: + active: true + TooGenericExceptionCaught: + active: true + excludes: [ '**/test/**', '**/androidTest/**', '**/*.Test.kt', '**/*.Spec.kt', '**/*.Spek.kt' ] + exceptionNames: + - ArrayIndexOutOfBoundsException + - Error + - Exception + - IllegalMonitorStateException + - NullPointerException + - IndexOutOfBoundsException + - RuntimeException + - Throwable + allowedExceptionNameRegex: '^(_|(ignore|expected).*)' + TooGenericExceptionThrown: + active: true + exceptionNames: + - Error + - Exception + - Throwable + - RuntimeException + +formatting: + active: true + android: false + autoCorrect: true + AnnotationOnSeparateLine: + active: true + autoCorrect: true + AnnotationSpacing: + active: true + autoCorrect: true + ArgumentListWrapping: + active: false # It's wrong! + autoCorrect: true + ChainWrapping: + active: true + autoCorrect: true + CommentSpacing: + active: true + autoCorrect: true + EnumEntryNameCase: + active: true + autoCorrect: true + Filename: + active: false + FinalNewline: + active: true + autoCorrect: true + insertFinalNewLine: true + ImportOrdering: + active: true + autoCorrect: true + layout: "*,java.**,javax.**,kotlin.**,^" + Indentation: + active: false + autoCorrect: false + MaximumLineLength: + active: true + maxLineLength: 120 + ModifierOrdering: + active: true + autoCorrect: true + MultiLineIfElse: + active: true + autoCorrect: true + NoBlankLineBeforeRbrace: + active: true + autoCorrect: true + NoConsecutiveBlankLines: + active: true + autoCorrect: true + NoEmptyClassBody: + active: true + autoCorrect: true + NoEmptyFirstLineInMethodBlock: + active: true + autoCorrect: true + NoLineBreakAfterElse: + active: true + autoCorrect: true + NoLineBreakBeforeAssignment: + active: true + autoCorrect: true + NoMultipleSpaces: + active: false + autoCorrect: false + NoSemicolons: + active: true + autoCorrect: true + NoTrailingSpaces: + active: true + autoCorrect: true + NoUnitReturn: + active: true + autoCorrect: true + NoUnusedImports: + active: true + autoCorrect: true + NoWildcardImports: + active: false + PackageName: + active: true + autoCorrect: true + ParameterListWrapping: + active: true + autoCorrect: true + SpacingAroundColon: + active: true + autoCorrect: true + SpacingAroundComma: + active: true + autoCorrect: true + SpacingAroundCurly: + active: true + autoCorrect: true + SpacingAroundDot: + active: true + autoCorrect: true + SpacingAroundDoubleColon: + active: true + autoCorrect: true + SpacingAroundKeyword: + active: true + autoCorrect: true + SpacingAroundOperators: + active: true + autoCorrect: true + SpacingAroundParens: + active: true + autoCorrect: true + SpacingAroundRangeOperator: + active: true + autoCorrect: true + SpacingBetweenDeclarationsWithAnnotations: + active: true + autoCorrect: true + SpacingBetweenDeclarationsWithComments: + active: true + autoCorrect: true + StringTemplate: + active: true + autoCorrect: true + +naming: + active: true + ClassNaming: + active: true + excludes: [ '**/test/**', '**/androidTest/**', '**/*.Test.kt', '**/*.Spec.kt', '**/*.Spek.kt' ] + classPattern: '[A-Z$][a-zA-Z0-9$]*' + ConstructorParameterNaming: + active: true + excludes: [ '**/test/**', '**/androidTest/**', '**/*.Test.kt', '**/*.Spec.kt', '**/*.Spek.kt' ] + parameterPattern: '[a-z][A-Za-z0-9]*' + privateParameterPattern: '[a-z][A-Za-z0-9]*' + excludeClassPattern: '$^' + EnumNaming: + active: true + excludes: [ '**/test/**', '**/androidTest/**', '**/*.Test.kt', '**/*.Spec.kt', '**/*.Spek.kt' ] + enumEntryPattern: '^[A-Z][_a-zA-Z0-9]*' + ForbiddenClassName: + active: false + excludes: [ '**/test/**', '**/androidTest/**', '**/*.Test.kt', '**/*.Spec.kt', '**/*.Spek.kt' ] + forbiddenName: [ ] + FunctionMaxLength: + active: false + excludes: [ '**/test/**', '**/androidTest/**', '**/*.Test.kt', '**/*.Spec.kt', '**/*.Spek.kt' ] + maximumFunctionNameLength: 30 + FunctionMinLength: + active: false + excludes: [ '**/test/**', '**/androidTest/**', '**/*.Test.kt', '**/*.Spec.kt', '**/*.Spek.kt' ] + minimumFunctionNameLength: 3 + FunctionNaming: + active: true + excludes: [ '**/test/**', '**/androidTest/**', '**/*.Test.kt', '**/*.Spec.kt', '**/*.Spek.kt' ] + functionPattern: '^([a-z$][a-zA-Z$0-9]*)|(`.*`)$' + excludeClassPattern: '$^' + FunctionParameterNaming: + active: true + excludes: [ '**/test/**', '**/androidTest/**', '**/*.Test.kt', '**/*.Spec.kt', '**/*.Spek.kt' ] + parameterPattern: '[a-z][A-Za-z0-9]*' + excludeClassPattern: '$^' + InvalidPackageDeclaration: + active: true + rootPackage: 'dev.kordex' + MatchingDeclarationName: + active: true + mustBeFirst: true + MemberNameEqualsClassName: + active: true + ignoreOverridden: true + NonBooleanPropertyPrefixedWithIs: + active: true + ObjectPropertyNaming: + active: true + excludes: [ '**/test/**', '**/androidTest/**', '**/*.Test.kt', '**/*.Spec.kt', '**/*.Spek.kt' ] + constantPattern: '[A-Za-z][_A-Za-z0-9]*' + propertyPattern: '[A-Za-z][_A-Za-z0-9]*' + privatePropertyPattern: '(_)?[A-Za-z][_A-Za-z0-9]*' + PackageNaming: + active: true + excludes: [ '**/test/**', '**/androidTest/**', '**/*.Test.kt', '**/*.Spec.kt', '**/*.Spek.kt' ] + packagePattern: '^[a-z]+(\.[a-z][A-Za-z0-9]*)*$' + TopLevelPropertyNaming: + active: true + excludes: [ '**/test/**', '**/androidTest/**', '**/*.Test.kt', '**/*.Spec.kt', '**/*.Spek.kt' ] + constantPattern: '[A-Z][_A-Z0-9]*' + propertyPattern: '[A-Za-z][_A-Za-z0-9]*' + privatePropertyPattern: '_?[A-Za-z][_A-Za-z0-9]*' + VariableMaxLength: + active: false + excludes: [ '**/test/**', '**/androidTest/**', '**/*.Test.kt', '**/*.Spec.kt', '**/*.Spek.kt' ] + maximumVariableNameLength: 64 + VariableMinLength: + active: false + excludes: [ '**/test/**', '**/androidTest/**', '**/*.Test.kt', '**/*.Spec.kt', '**/*.Spek.kt' ] + minimumVariableNameLength: 1 + VariableNaming: + active: true + excludes: [ '**/test/**', '**/androidTest/**', '**/*.Test.kt', '**/*.Spec.kt', '**/*.Spek.kt' ] + variablePattern: '[a-z][A-Za-z0-9]*' + privateVariablePattern: '(_)?[a-z][A-Za-z0-9]*' + excludeClassPattern: '$^' + +performance: + active: true + ArrayPrimitive: + active: true + ForEachOnRange: + active: true + excludes: [ '**/test/**', '**/androidTest/**', '**/*.Test.kt', '**/*.Spec.kt', '**/*.Spek.kt' ] + SpreadOperator: + active: true + excludes: [ '**/test/**', '**/androidTest/**', '**/*.Test.kt', '**/*.Spec.kt', '**/*.Spek.kt' ] + UnnecessaryTemporaryInstantiation: + active: true + +potential-bugs: + active: true + Deprecation: + active: true + EqualsAlwaysReturnsTrueOrFalse: + active: true + EqualsWithHashCodeExist: + active: true + ExplicitGarbageCollectionCall: + active: true + HasPlatformType: + active: true + IgnoredReturnValue: + active: true + ImplicitDefaultLocale: + active: false + ImplicitUnitReturnType: + active: true + allowExplicitReturnType: true + InvalidRange: + active: true + IteratorHasNextCallsNextMethod: + active: true + IteratorNotThrowingNoSuchElementException: + active: true + LateinitUsage: + active: false + excludes: [ '**/test/**', '**/androidTest/**', '**/*.Test.kt', '**/*.Spec.kt', '**/*.Spek.kt' ] + ignoreAnnotated: [ ] + ignoreOnClassesPattern: '' + MapGetWithNotNullAssertionOperator: + active: true + NullableToStringCall: + active: true + UnconditionalJumpStatementInLoop: + active: true + UnnecessaryNotNullOperator: + active: true + UnnecessarySafeCall: + active: true + UnreachableCode: + active: true + UnsafeCallOnNullableType: + active: true + UnsafeCast: + active: true + UselessPostfixExpression: + active: true + WrongEqualsTypeParameter: + active: true + +style: + active: true + BracesOnIfStatements: + active: true + + singleLine: always + multiLine: always + BracesOnWhenStatements: + active: true + ClassOrdering: + active: true + CollapsibleIfStatements: + active: true + DataClassContainsFunctions: + active: false + DataClassShouldBeImmutable: + active: true + EqualsNullCall: + active: true + EqualsOnSignatureLine: + active: true + ExplicitCollectionElementAccessMethod: + active: true + ExplicitItLambdaParameter: + active: true + ExpressionBodySyntax: + active: true + includeLineWrapping: false + ForbiddenComment: + active: false + ForbiddenImport: + active: false + ForbiddenMethodCall: + active: false + methods: [ ] + ForbiddenVoid: + active: true + ignoreOverridden: true + ignoreUsageInGenerics: false + FunctionOnlyReturningConstant: + active: true + ignoreOverridableFunction: true + excludedFunctions: [ 'describeContents' ] + ignoreAnnotated: [ 'dagger.Provides' ] + LoopWithTooManyJumpStatements: + active: true + maxJumpCount: 3 + MagicNumber: + active: true + excludes: [ '**/test/**', '**/androidTest/**', '**/*.Test.kt', '**/*.Spec.kt', '**/*.Spek.kt' ] + ignoreNumbers: [ '-1', '0', '1', '2' ] + ignoreHashCodeFunction: true + ignorePropertyDeclaration: false + ignoreLocalVariableDeclaration: false + ignoreConstantDeclaration: true + ignoreCompanionObjectPropertyDeclaration: true + ignoreAnnotation: true + ignoreNamedArgument: true + ignoreEnums: true + ignoreRanges: false + MandatoryBracesLoops: + active: true + MaxLineLength: + active: true + maxLineLength: 120 + excludePackageStatements: true + excludeImportStatements: true + excludeCommentStatements: false + MayBeConst: + active: true + ModifierOrder: + active: true + NestedClassesVisibility: + active: true + NewLineAtEndOfFile: + active: true + NoTabs: + active: false + OptionalAbstractKeyword: + active: true + OptionalUnit: + active: false + PreferToOverPairSyntax: + active: true + ProtectedMemberInFinalClass: + active: true + RedundantExplicitType: + active: true + RedundantVisibilityModifierRule: + active: false + ReturnCount: + active: false + max: 2 + excludedFunctions: [ 'equals' ] + excludeLabeled: false + excludeReturnFromLambda: true + excludeGuardClauses: false + SafeCast: + active: true + SerialVersionUIDInSerializableClass: + active: true + SpacingBetweenPackageAndImports: + active: true + ThrowsCount: + active: false + max: 2 + TrailingWhitespace: + active: true + UnderscoresInNumericLiterals: + active: true + acceptableLength: 5 + UnnecessaryAbstractClass: + active: true + ignoreAnnotated: [ 'dagger.Module' ] + UnnecessaryAnnotationUseSiteTarget: + active: true + UnnecessaryApply: + active: true + UnnecessaryInheritance: + active: true + UnnecessaryLet: + active: true + UnnecessaryParentheses: + active: true + UntilInsteadOfRangeTo: + active: true + UnusedImports: + active: true + UnusedPrivateClass: + active: true + UnusedPrivateMember: + active: true + allowedNames: '(_|ignored|expected|serialVersionUID)' + UseArrayLiteralsInAnnotations: + active: true + UseCheckNotNull: + active: true + UseCheckOrError: + active: true + UseDataClass: + active: true + ignoreAnnotated: [ ] + allowVars: false + UseEmptyCounterpart: + active: true + UseIfInsteadOfWhen: + active: true + UseRequire: + active: false + UseRequireNotNull: + active: true + UselessCallOnNotNull: + active: true + UtilityClassWithPublicConstructor: + active: true + VarCouldBeVal: + active: true + WildcardImport: + active: false + excludes: [ '**/test/**', '**/androidTest/**', '**/*.Test.kt', '**/*.Spec.kt', '**/*.Spek.kt' ] + excludeImports: [ 'java.util.*', 'kotlinx.android.synthetic.*' ] + +libraries: + ForbiddenPublicDataClass: + active: false + ignorePackages: [ '*.internal', '*.internal.*' ] + LibraryCodeMustSpecifyReturnType: + active: true + LibraryEntitiesShouldNotBePublic: + active: false diff --git a/gradle.properties b/gradle.properties new file mode 100644 index 0000000..e12a500 --- /dev/null +++ b/gradle.properties @@ -0,0 +1,5 @@ +kotlin.incremental=true +org.gradle.jvmargs=-XX:MaxMetaspaceSize=1024m +org.gradle.parallel=true + +projectVersion=1.0.0 diff --git a/gradle/wrapper/gradle-wrapper.jar b/gradle/wrapper/gradle-wrapper.jar new file mode 100644 index 0000000..249e583 Binary files /dev/null and b/gradle/wrapper/gradle-wrapper.jar differ diff --git a/gradle/wrapper/gradle-wrapper.properties b/gradle/wrapper/gradle-wrapper.properties new file mode 100644 index 0000000..5eca621 --- /dev/null +++ b/gradle/wrapper/gradle-wrapper.properties @@ -0,0 +1,6 @@ +#Sat Sep 21 10:50:23 IST 2024 +distributionBase=GRADLE_USER_HOME +distributionPath=wrapper/dists +distributionUrl=https\://services.gradle.org/distributions/gradle-8.8-bin.zip +zipStoreBase=GRADLE_USER_HOME +zipStorePath=wrapper/dists diff --git a/gradlew b/gradlew new file mode 100644 index 0000000..1b6c787 --- /dev/null +++ b/gradlew @@ -0,0 +1,234 @@ +#!/bin/sh + +# +# Copyright © 2015-2021 the original authors. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://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. +# + +############################################################################## +# +# Gradle start up script for POSIX generated by Gradle. +# +# Important for running: +# +# (1) You need a POSIX-compliant shell to run this script. If your /bin/sh is +# noncompliant, but you have some other compliant shell such as ksh or +# bash, then to run this script, type that shell name before the whole +# command line, like: +# +# ksh Gradle +# +# Busybox and similar reduced shells will NOT work, because this script +# requires all of these POSIX shell features: +# * functions; +# * expansions «$var», «${var}», «${var:-default}», «${var+SET}», +# «${var#prefix}», «${var%suffix}», and «$( cmd )»; +# * compound commands having a testable exit status, especially «case»; +# * various built-in commands including «command», «set», and «ulimit». +# +# Important for patching: +# +# (2) This script targets any POSIX shell, so it avoids extensions provided +# by Bash, Ksh, etc; in particular arrays are avoided. +# +# The "traditional" practice of packing multiple parameters into a +# space-separated string is a well documented source of bugs and security +# problems, so this is (mostly) avoided, by progressively accumulating +# options in "$@", and eventually passing that to Java. +# +# Where the inherited environment variables (DEFAULT_JVM_OPTS, JAVA_OPTS, +# and GRADLE_OPTS) rely on word-splitting, this is performed explicitly; +# see the in-line comments for details. +# +# There are tweaks for specific operating systems such as AIX, CygWin, +# Darwin, MinGW, and NonStop. +# +# (3) This script is generated from the Groovy template +# https://github.com/gradle/gradle/blob/master/subprojects/plugins/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt +# within the Gradle project. +# +# You can find Gradle at https://github.com/gradle/gradle/. +# +############################################################################## + +# Attempt to set APP_HOME + +# Resolve links: $0 may be a link +app_path=$0 + +# Need this for daisy-chained symlinks. +while + APP_HOME=${app_path%"${app_path##*/}"} # leaves a trailing /; empty if no leading path + [ -h "$app_path" ] +do + ls=$( ls -ld "$app_path" ) + link=${ls#*' -> '} + case $link in #( + /*) app_path=$link ;; #( + *) app_path=$APP_HOME$link ;; + esac +done + +APP_HOME=$( cd "${APP_HOME:-./}" && pwd -P ) || exit + +APP_NAME="Gradle" +APP_BASE_NAME=${0##*/} + +# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. +DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"' + +# Use the maximum available, or set MAX_FD != -1 to use that value. +MAX_FD=maximum + +warn () { + echo "$*" +} >&2 + +die () { + echo + echo "$*" + echo + exit 1 +} >&2 + +# OS specific support (must be 'true' or 'false'). +cygwin=false +msys=false +darwin=false +nonstop=false +case "$( uname )" in #( + CYGWIN* ) cygwin=true ;; #( + Darwin* ) darwin=true ;; #( + MSYS* | MINGW* ) msys=true ;; #( + NONSTOP* ) nonstop=true ;; +esac + +CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar + + +# Determine the Java command to use to start the JVM. +if [ -n "$JAVA_HOME" ] ; then + if [ -x "$JAVA_HOME/jre/sh/java" ] ; then + # IBM's JDK on AIX uses strange locations for the executables + JAVACMD=$JAVA_HOME/jre/sh/java + else + JAVACMD=$JAVA_HOME/bin/java + fi + if [ ! -x "$JAVACMD" ] ; then + die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME + +Please set the JAVA_HOME variable in your environment to match the +location of your Java installation." + fi +else + JAVACMD=java + which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. + +Please set the JAVA_HOME variable in your environment to match the +location of your Java installation." +fi + +# Increase the maximum file descriptors if we can. +if ! "$cygwin" && ! "$darwin" && ! "$nonstop" ; then + case $MAX_FD in #( + max*) + MAX_FD=$( ulimit -H -n ) || + warn "Could not query maximum file descriptor limit" + esac + case $MAX_FD in #( + '' | soft) :;; #( + *) + ulimit -n "$MAX_FD" || + warn "Could not set maximum file descriptor limit to $MAX_FD" + esac +fi + +# Collect all arguments for the java command, stacking in reverse order: +# * args from the command line +# * the main class name +# * -classpath +# * -D...appname settings +# * --module-path (only if needed) +# * DEFAULT_JVM_OPTS, JAVA_OPTS, and GRADLE_OPTS environment variables. + +# For Cygwin or MSYS, switch paths to Windows format before running java +if "$cygwin" || "$msys" ; then + APP_HOME=$( cygpath --path --mixed "$APP_HOME" ) + CLASSPATH=$( cygpath --path --mixed "$CLASSPATH" ) + + JAVACMD=$( cygpath --unix "$JAVACMD" ) + + # Now convert the arguments - kludge to limit ourselves to /bin/sh + for arg do + if + case $arg in #( + -*) false ;; # don't mess with options #( + /?*) t=${arg#/} t=/${t%%/*} # looks like a POSIX filepath + [ -e "$t" ] ;; #( + *) false ;; + esac + then + arg=$( cygpath --path --ignore --mixed "$arg" ) + fi + # Roll the args list around exactly as many times as the number of + # args, so each arg winds up back in the position where it started, but + # possibly modified. + # + # NB: a `for` loop captures its iteration list before it begins, so + # changing the positional parameters here affects neither the number of + # iterations, nor the values presented in `arg`. + shift # remove old arg + set -- "$@" "$arg" # push replacement arg + done +fi + +# Collect all arguments for the java command; +# * $DEFAULT_JVM_OPTS, $JAVA_OPTS, and $GRADLE_OPTS can contain fragments of +# shell script including quotes and variable substitutions, so put them in +# double quotes to make sure that they get re-expanded; and +# * put everything else in single quotes, so that it's not re-expanded. + +set -- \ + "-Dorg.gradle.appname=$APP_BASE_NAME" \ + -classpath "$CLASSPATH" \ + org.gradle.wrapper.GradleWrapperMain \ + "$@" + +# Use "xargs" to parse quoted args. +# +# With -n1 it outputs one arg per line, with the quotes and backslashes removed. +# +# In Bash we could simply go: +# +# readarray ARGS < <( xargs -n1 <<<"$var" ) && +# set -- "${ARGS[@]}" "$@" +# +# but POSIX shell has neither arrays nor command substitution, so instead we +# post-process each arg (as a line of input to sed) to backslash-escape any +# character that might be a shell metacharacter, then use eval to reverse +# that process (while maintaining the separation between arguments), and wrap +# the whole thing up as a single "set" statement. +# +# This will of course break if any of these variables contains a newline or +# an unmatched quote. +# + +eval "set -- $( + printf '%s\n' "$DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS" | + xargs -n1 | + sed ' s~[^-[:alnum:]+,./:=@_]~\\&~g; ' | + tr '\n' ' ' + )" '"$@"' + +exec "$JAVACMD" "$@" diff --git a/gradlew.bat b/gradlew.bat new file mode 100644 index 0000000..107acd3 --- /dev/null +++ b/gradlew.bat @@ -0,0 +1,89 @@ +@rem +@rem Copyright 2015 the original author or authors. +@rem +@rem Licensed under the Apache License, Version 2.0 (the "License"); +@rem you may not use this file except in compliance with the License. +@rem You may obtain a copy of the License at +@rem +@rem https://www.apache.org/licenses/LICENSE-2.0 +@rem +@rem Unless required by applicable law or agreed to in writing, software +@rem distributed under the License is distributed on an "AS IS" BASIS, +@rem WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +@rem See the License for the specific language governing permissions and +@rem limitations under the License. +@rem + +@if "%DEBUG%" == "" @echo off +@rem ########################################################################## +@rem +@rem Gradle startup script for Windows +@rem +@rem ########################################################################## + +@rem Set local scope for the variables with windows NT shell +if "%OS%"=="Windows_NT" setlocal + +set DIRNAME=%~dp0 +if "%DIRNAME%" == "" set DIRNAME=. +set APP_BASE_NAME=%~n0 +set APP_HOME=%DIRNAME% + +@rem Resolve any "." and ".." in APP_HOME to make it shorter. +for %%i in ("%APP_HOME%") do set APP_HOME=%%~fi + +@rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. +set DEFAULT_JVM_OPTS="-Xmx64m" "-Xms64m" + +@rem Find java.exe +if defined JAVA_HOME goto findJavaFromJavaHome + +set JAVA_EXE=java.exe +%JAVA_EXE% -version >NUL 2>&1 +if "%ERRORLEVEL%" == "0" goto execute + +echo. +echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. +echo. +echo Please set the JAVA_HOME variable in your environment to match the +echo location of your Java installation. + +goto fail + +:findJavaFromJavaHome +set JAVA_HOME=%JAVA_HOME:"=% +set JAVA_EXE=%JAVA_HOME%/bin/java.exe + +if exist "%JAVA_EXE%" goto execute + +echo. +echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% +echo. +echo Please set the JAVA_HOME variable in your environment to match the +echo location of your Java installation. + +goto fail + +:execute +@rem Setup the command line + +set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar + + +@rem Execute Gradle +"%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %* + +:end +@rem End local scope for the variables with windows NT shell +if "%ERRORLEVEL%"=="0" goto mainEnd + +:fail +rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of +rem the _cmd.exe /c_ return code! +if not "" == "%GRADLE_EXIT_CONSOLE%" exit 1 +exit /b 1 + +:mainEnd +if "%OS%"=="Windows_NT" endlocal + +:omega diff --git a/i18n-generator/build.gradle.kts b/i18n-generator/build.gradle.kts new file mode 100644 index 0000000..700518a --- /dev/null +++ b/i18n-generator/build.gradle.kts @@ -0,0 +1,50 @@ +import org.gradle.kotlin.dsl.invoke + +plugins { + val env = System.getenv() + + general + + if (env.contains("GITHUB_ACTIONS") && !env.contains("NO_SIGNING")) { + published + } + + id("com.github.johnrengelman.shadow") version "8.1.1" +} + +val projectVersion: String by project + +group = "dev.kordex.i18n" +version = projectVersion + +repositories { + mavenCentral() +} + +dependencies { + implementation("info.picocli:picocli:4.7.6") + + api("com.hanggrian:kotlinpoet-dsl:0.2") + api("com.squareup:kotlinpoet:1.18.1") +} + +val propsTask = tasks.register("kordExProps") { + group = "generation" + description = "Generate KordEx properties file" + + comment = "Generated during KordEx compilation" + destinationFile = layout.buildDirectory.file("kordex-build.properties") + encoding = "UTF-8" + + property("version", project.version) +} + +tasks.processResources { + from(propsTask) { + duplicatesStrategy = DuplicatesStrategy.INCLUDE + } +} + +tasks.build { + dependsOn(tasks.shadowJar) +} diff --git a/i18n-generator/src/main/kotlin/dev/kordex/i18n/generator/Main.kt b/i18n-generator/src/main/kotlin/dev/kordex/i18n/generator/Main.kt new file mode 100644 index 0000000..ae6b61f --- /dev/null +++ b/i18n-generator/src/main/kotlin/dev/kordex/i18n/generator/Main.kt @@ -0,0 +1,167 @@ +/* + * This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this + * file, You can obtain one at https://mozilla.org/MPL/2.0/. + */ + +package dev.kordex.i18n.generator + +import picocli.CommandLine +import picocli.CommandLine.Model.OptionSpec +import java.io.File +import java.nio.charset.Charset +import java.nio.file.Files +import java.util.Properties +import kotlin.system.exitProcess + +public fun main(vararg args: String) { + val spec = CommandLine.Model.CommandSpec.create() + + spec.name("i18n-generator") + spec.version(VERSION) + + spec.parser() + .abbreviatedOptionsAllowed(true) + .allowOptionsAsOptionParameters(true) + + spec.usageMessage() + .description( + "%nCommand-line tool for generating Kord Extensions translations classes from translation bundle " + + "properties files.%n" + ) + .footer("%nAvailable encodings: " + Charset.availableCharsets().keys.joinToString()) + + spec.version(null) + spec.mixinStandardHelpOptions(true) + + spec.addOption("-b", "--bundle") { + paramLabel("BUNDLE") + required(true) + + description("Name of the relevant translations bundle, which will be included in the output.") + } + + spec.addOption("-i", "--input-file") { + paramLabel("INPUT") + required(true) + + description("Input file, a properties file representing a set of translations from a translation bundle.") + } + + spec.addOption("-p", "--class-package") { + paramLabel("PACKAGE") + required(true) + + description("Package containing the generated class.") + } + + spec.addOption("-c", "--class-name") { + paramLabel("CLASS") + defaultValue("Translations") + + description("Generated class name. Defaults to \"Translations\".") + } + + spec.addOption("-e", "--encoding") { + paramLabel("ENCODING") + defaultValue("UTF-8") + + Charset.availableCharsets().keys + + description("Character encoding used to load the bundle file. Defaults to UTF-8.") + } + + spec.addOption("-o", "--output-dir") { + paramLabel("DIRECTORY") + defaultValue("output") + + description( + "Output directory for the generated files, which will include the package structure.%n " + + "Defaults to \"./output\"." + ) + } + + val commandLine = CommandLine(spec) + + commandLine.setExecutionStrategy(::run) + + exitProcess(commandLine.execute(*args)) +} + +private fun run(result: CommandLine.ParseResult): Int { + val helpExitCode = CommandLine.executeHelpRequest(result) + + if (helpExitCode != null) { + return helpExitCode + } + + var bundle: String = result.matchedOption("b").getValue() + val inputFile: File = result.matchedOption("i").getValue() + val classPackage: String = result.matchedOption("p").getValue() + val encoding: String = result.matchedOptionValue("e", "UTF-8") + + val className: String = result.matchedOptionValue("c", "Translations") + val outputDir: File = result.matchedOptionValue("o", File("output")) + + if ("." !in bundle) { + bundle = "$bundle.strings" + } + + if (!inputFile.exists()) { + exitError("Unable to find ${inputFile.absolutePath}") + } + + if (!outputDir.exists()) { + println("Creating output directory: ${outputDir.absolutePath}") + outputDir.mkdirs() + } + + println("Loading properties...") + + val props = Properties() + + props.load( + Files.newBufferedReader( + inputFile.toPath(), + charset(encoding) + ) + ) + + println("Found ${props.size} translation keys.") + println("Generating class \"$className\" for bundle \"$bundle\"...") + + val translationsClass = TranslationsClass( + bundle = bundle, + allProps = props, + className = className, + classPackage = classPackage, + ) + + translationsClass.writeTo(outputDir) + + println("Written to directory: ${outputDir.absolutePath}") + + return 0 +} + +private fun exitError(message: String): Nothing { + println("ERROR: $message") + exitProcess(1) +} + +public inline fun CommandLine.Model.CommandSpec.addOption( + name: String, + vararg names: String, + body: OptionSpec.Builder.() -> Unit +): OptionSpec { + val builder = OptionSpec.builder(name, *names) + + body(builder) + builder.type(T::class.java) + + val build = builder.build() + + addOption(build) + + return build +} diff --git a/i18n-generator/src/main/kotlin/dev/kordex/i18n/generator/TranslationsClass.kt b/i18n-generator/src/main/kotlin/dev/kordex/i18n/generator/TranslationsClass.kt new file mode 100644 index 0000000..700d688 --- /dev/null +++ b/i18n-generator/src/main/kotlin/dev/kordex/i18n/generator/TranslationsClass.kt @@ -0,0 +1,120 @@ +/* + * This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this + * file, You can obtain one at https://mozilla.org/MPL/2.0/. + */ + +package dev.kordex.i18n.generator + +import com.hanggrian.kotlinpoet.TypeSpecBuilder +import com.hanggrian.kotlinpoet.addObject +import com.hanggrian.kotlinpoet.buildFileSpec +import com.hanggrian.kotlinpoet.buildPropertySpec +import com.squareup.kotlinpoet.ClassName +import com.squareup.kotlinpoet.FileSpec +import com.squareup.kotlinpoet.PropertySpec +import java.io.File +import java.util.Properties + +public class TranslationsClass( + public val allProps: Properties, + public val bundle: String, + public val className: String, + + classPackage: String +) { + public val allKeys: List = allProps.toList().map { (left, _) -> left.toString() } + + public val spec: FileSpec = buildFileSpec(classPackage, className) { + types.addObject(className) { + bundle() + + addKeys(allKeys, allProps, className) + } + } + + public fun writeTo(outputDir: File) { + spec.writeTo(outputDir) + } + + public fun key(name: String, value: String, property: String, translationsClassName: String): PropertySpec = + buildPropertySpec(name.replace("-", "_"), ClassName("dev.kordex.core.i18n.types", "Key")) { + setInitializer("Key(%S)\n.withBundle(%L.bundle)", value, translationsClassName) + + property.lines().forEach { + kdoc.addStatement( + "%L", + it.trim().replace("*/", "") + ) + } + } + + public fun TypeSpecBuilder.addKeys( + keys: List, + props: Properties, + translationsClassName: String, + parent: String? = null, + ) { + val paritioned = keys.partition() + + paritioned.forEach { (k, v) -> + val keyName = if (parent != null) { + "$parent.$k" + } else { + k + } + + if (v.isEmpty() || props[keyName] != null) { + properties.add( + key(k.toVarName(), keyName, props.getProperty(keyName), translationsClassName) + ) + } + + if (v.isNotEmpty()) { + // Object + val objName = k + .replace("-", " ") + .split(" ") + .map { it.capitalized() } + .joinToString("") + + types.addObject(objName) { + addKeys(v, props, translationsClassName, keyName) + } + } + } + } + + public fun TypeSpecBuilder.bundle() { + properties.add( + buildPropertySpec("bundle", ClassName("dev.kordex.core.i18n.types", "Bundle")) { + setInitializer("Bundle(%S)", bundle) + } + ) + } + + public fun List.partition(): Map> = + filterNotNull() + .groupBy( + keySelector = { it.substringBefore(".") }, + + valueTransform = { + if ("." in it) { + it.substringAfter(".") + } else { + null + } + }, + ) + .mapValues { (_, value) -> + value.filterNotNull() + } + + public fun String.capitalized(): String = + replaceFirstChar { it.uppercase() } + + public fun String.toVarName(): String = + replace("-", "_") + .replace(".", "_") + .replaceFirstChar { it.lowercase() } +} diff --git a/i18n-generator/src/main/kotlin/dev/kordex/i18n/generator/_Properties.kt b/i18n-generator/src/main/kotlin/dev/kordex/i18n/generator/_Properties.kt new file mode 100644 index 0000000..e8883b1 --- /dev/null +++ b/i18n-generator/src/main/kotlin/dev/kordex/i18n/generator/_Properties.kt @@ -0,0 +1,27 @@ +/* + * This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this + * file, You can obtain one at https://mozilla.org/MPL/2.0/. + */ + +package dev.kordex.i18n.generator + +import java.util.Properties + +/** Convenient access to the kordex-build.properties file. **/ +public val kordexProps: Properties by lazy { + val props = Properties() + + props.load( + TranslationsClass::class.java.getResourceAsStream( + "/kordex-build.properties" + ) + ) + + props +} + +/** Current Kord Extensions version. **/ +public val VERSION: String? by lazy { + kordexProps["versions"] as String? +} diff --git a/settings.gradle.kts b/settings.gradle.kts new file mode 100644 index 0000000..b99cd86 --- /dev/null +++ b/settings.gradle.kts @@ -0,0 +1,7 @@ +plugins { + id("org.gradle.toolchains.foojay-resolver-convention") version "0.8.0" +} + +rootProject.name = "i18n" + +include("i18n-generator") diff --git a/test/strings.properties b/test/strings.properties new file mode 100644 index 0000000..99b39f9 --- /dev/null +++ b/test/strings.properties @@ -0,0 +1,11 @@ +commands.button.action=You pushed the button! +commands.button.description=A simple example command sending a button +commands.button.label=Button! +commands.button.name=button +commands.slap.action=slaps {0} with their {1} +commands.slap.args.target.description=Person you want to slap +commands.slap.args.target.name=target +commands.slap.args.weapon.description=What you want to slap with +commands.slap.args.weapon.name=weapon +commands.slap.description=Ask the bot to slap another user +commands.slap.name=slap