From 57354c058c6a5dd720a8da8c30ef4ce20bcf25da Mon Sep 17 00:00:00 2001 From: Martin Bonnin Date: Wed, 30 Oct 2024 18:38:23 +0100 Subject: [PATCH] Add side panel + some fixes --- .devcontainer/requirements.txt | 2 +- .gitignore | 2 ++ docs/plugin-development/kotlin-plugins.md | 9 +++++---- mkdocs.yml | 4 +++- 4 files changed, 11 insertions(+), 6 deletions(-) diff --git a/.devcontainer/requirements.txt b/.devcontainer/requirements.txt index 3d5608c..08db785 100644 --- a/.devcontainer/requirements.txt +++ b/.devcontainer/requirements.txt @@ -15,7 +15,7 @@ mkdocs-render-swagger-plugin==0.1.1 mkdocs-pdf==0.1.1 mkdocs-with-pdf==0.9.3 livereload==2.6.3 -lxml==4.9.3 +lxml==5.3.0 click==8.1.7 dacite==1.8.1 ghp-import==2.1.0 diff --git a/.gitignore b/.gitignore index e6018f7..5d2c507 100644 --- a/.gitignore +++ b/.gitignore @@ -10,3 +10,5 @@ temp_dir /.idea/vcs.xml .DS_Store + +pyvenv.cfg diff --git a/docs/plugin-development/kotlin-plugins.md b/docs/plugin-development/kotlin-plugins.md index 3a1a0c3..d485089 100644 --- a/docs/plugin-development/kotlin-plugins.md +++ b/docs/plugin-development/kotlin-plugins.md @@ -142,18 +142,19 @@ If you are used to writing `build.gradle.kts` files, you may use the `kotlin-dsl `kotlin-dsl` configures the Kotlin compiler so that you can use precompiled scripts plugins and/or write similar syntax in your regular `.kt` files. The `kotlin-dls` plugin: + * applies `"java-gradle-plugin"`. * applies `kotlin-embedded` to use the same Kotlin embeeded version as your Gradle distribution. * applies the ``kotlin-dsl-precompiled-script-plugins`` allowing to use `build.gradle.kts` files. * adds `gradleKotlinDsl()` to the `compileOnly` configuration. * configures the `sam-with-receiver` Kotlin compiler plugin to transform `it.` usages into `this.`. * configures the `kotlin-assignment` Kotlin compiler plugin to allow setting `Property` with the `=` operator. -* sets Kotlin `apiVersion` and `languageVersion` according to Gradle [compatibility [atrix](https://docs.gradle.org/current/userguide/compatibility.html#kotlin). +* sets Kotlin `apiVersion` and `languageVersion` according to Gradle [compatibility Matrix](https://docs.gradle.org/current/userguide/compatibility.html#kotlin). * adds the `-Xsam-conversions=class` compiler option. * adds others compiler options for compatibility: - ** `-java-parameters` to support https://docs.oracle.com/javase/8/docs/api/java/lang/reflect/Parameter.html[Java 8 Parameter] class and getting method parameters through reflection - ** `-Xjvm-default=all` to add link:https://kotlinlang.org/docs/java-to-kotlin-interop.html#default-methods-in-interfaces[Default methods in interfaces] - ** `-Xjsr305=strict` for https://kotlinlang.org/docs/java-interop.html#compiler-configuration[increased null safety] + * `-java-parameters` to support [Java 8 Parameter](https://docs.oracle.com/javase/8/docs/api/java/lang/reflect/Parameter.html) class and getting method parameters through reflection + * `-Xjvm-default=all` to add [Default methods in interfaces](https://kotlinlang.org/docs/java-to-kotlin-interop.html#default-methods-in-interfaces) + * `-Xjsr305=strict` for [increased null safety](https://kotlinlang.org/docs/java-interop.html#compiler-configuration) This is a significant departure from the baseline Kotlin configuration so be aware of the tradeoffs when using `kotlin-dsl`. diff --git a/mkdocs.yml b/mkdocs.yml index a05f1f8..18b6bb7 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -35,7 +35,9 @@ nav: - Gradle for Kotlin: kotlin/README.md - Gradle for Android: android/README.md - Troubleshooting Gradle: troubleshooting/README.md - - Plugin Development: plugin-development/README.md + - Plugin Development: + - Summary: plugin-development/README.md + - Kotlin plugin development: plugin-development/kotlin-plugins.md # Theme theme: