Add Kotlin DSL examples in docs #1306
Conversation
Goooler
commented
Mar 5, 2025
Goooler
commented
- Closes Provide Gradle Kotlin DSL examples in documentation #417.
- Closes Support Kotlin Script Gradle DSL #533.
- Refs Kotlin DSL support #317.
- Refs using Kotlin DSL #440.
- Refs "inheritFrom" not directly accessible in kotlin dsl #1260.
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request adds Kotlin DSL examples to the documentation, which is a great way to improve the usability and accessibility of the plugin. The changes are well-structured and easy to follow. However, there are a few minor suggestions for improvement.
Merge Readiness
The code changes are well-structured and easy to follow. I would recommend addressing the comments before merging. I am unable to directly approve this pull request, and recommend that others review and approve this code before merging.
Goooler
force-pushed
the
g/20250305/kotlin-dsl-in-docs
branch
from
01ea081 to
c2ffc3d
Compare
Goooler
force-pushed
the
g/20250305/kotlin-dsl-in-docs
branch
from
ab1d225 to
772f7f3
Compare
…-in-docs // Conflicts: // docs/application-plugin/README.md // docs/configuration/README.md // docs/configuration/dependencies/README.md // docs/configuration/filtering/README.md // docs/configuration/merging/README.md // docs/configuration/minimizing/README.md // docs/configuration/relocation/README.md // docs/configuration/reproducible-builds/README.md // docs/custom-tasks/README.md // docs/getting-started/README.md // docs/kmp-plugin/README.md // docs/multi-project/README.md // docs/plugins/README.md // docs/publishing/README.md
Goooler
force-pushed
the
g/20250305/kotlin-dsl-in-docs
branch
2 times, most recently
from
ec8c76b to
7520e81
Compare
Goooler
force-pushed
the
g/20250305/kotlin-dsl-in-docs
branch
4 times, most recently
from
b157a05 to
aa068a8
Compare
Goooler
force-pushed
the
g/20250305/kotlin-dsl-in-docs
branch
from
aa068a8 to
fc1a72d
Compare
…-in-docs // Conflicts: // src/integrationTest/kotlin/com/github/jengelman/gradle/plugins/shadow/DocCodeSnippetTest.kt // src/integrationTest/kotlin/com/github/jengelman/gradle/plugins/shadow/snippet/CodeSnippetExtractor.kt // src/integrationTest/kotlin/com/github/jengelman/gradle/plugins/shadow/snippet/DslLang.kt // src/integrationTest/kotlin/com/github/jengelman/gradle/plugins/shadow/snippet/KotlinBuildExecutable.kt // src/integrationTest/kotlin/com/github/jengelman/gradle/plugins/shadow/snippet/SnippetExecutable.kt
|
/gemini review |
There was a problem hiding this comment.
Code Review
The pull request adds Kotlin DSL examples to the documentation, which improves the user experience for Kotlin developers. The changes are well-structured and cover various aspects of the Shadow plugin. However, there are a few areas that could be improved for clarity and consistency.
Summary of Findings
- Inconsistent code block indentation: The indentation of code blocks within the documentation is inconsistent. Some code blocks have 4 spaces of indentation, while others do not. Consistent indentation improves readability.
- Missing Kotlin DSL examples in some sections: While most sections now include Kotlin DSL examples, some sections are still missing them. Providing examples for both Groovy and Kotlin in all relevant sections ensures comprehensive documentation.
- Inaccurate regex pattern: The regex pattern in
CodeSnippetExtractor.ktis not correctly extracting the Kotlin code snippets.
Merge Readiness
The pull request is a valuable addition to the documentation. However, before merging, the identified issues should be addressed to ensure consistency and accuracy. I am unable to approve this pull request, and recommend that others review and approve this code before merging.
...rationTest/kotlin/com/github/jengelman/gradle/plugins/shadow/snippet/CodeSnippetExtractor.kt
Show resolved
Hide resolved
Goooler
force-pushed
the
g/20250305/kotlin-dsl-in-docs
branch
from
8b74b86 to
de3e82d
Compare
Goooler
force-pushed
the
g/20250305/kotlin-dsl-in-docs
branch
3 times, most recently
from
e8a936b to
d94e30c
Compare
Goooler
force-pushed
the
g/20250305/kotlin-dsl-in-docs
branch
from
d94e30c to
8637301
Compare
