Skip to content

Releases: kotools/samples

0.1.0

17 Nov 10:20
@LVMVRQUXL LVMVRQUXL
0.1.0
208e6c7
This commit was signed with the committer’s verified signature.
LVMVRQUXL Loïc Lamarque
SSH Key Fingerprint: sv5/9UPv88hiq5LiXg5i8xk+lrG2UFM4YKWU3l62F0o Learn about vigilant mode.
Compare
Choose a tag to compare
0.1.0 Latest
Latest

✨ Added

  • org.kotools.samples.jvm Gradle plugin for Kotlin/JVM projects, supporting Kotlin 1.8.22 and Dokka 1.8.20. The following bullet points refer to changes made to this Gradle plugin.
  • sample Kotlin source set dedicated to code samples written in Kotlin or Java. By default, the test source set depends on the sample one, which depends on the main one. This configuration allows to execute code samples alongside unit tests, ensuring their correctness.
  • checkSampleSources task for checking the content of sample sources. This task fails if a sample source doesn't have a single class.
  • extractSamples task that extracts samples from sources as Markdown for KDoc.
  • checkSampleReferences task for checking that KDoc sample references targets existing code samples.
  • backupMainSources task for saving main sources before inlining samples.
  • inlineSamples task that inlines samples in KDoc as Markdown code blocks.
  • restoreMainSources task for restoring main sources after inlining samples.

Thanks to @LVMVRQUXL for contributing to this new release. 🙏

Contributors

LVMVRQUXL
Assets 2
Loading