Skip to content

migrate korro to K2#14

Merged
devcrocod merged 15 commits intomasterfrom
K2
Apr 18, 2026
Merged

migrate korro to K2#14
devcrocod merged 15 commits intomasterfrom
K2

Conversation

@devcrocod
Copy link
Copy Markdown
Owner

  • remove dokka
  • add kotlin analysis api
  • add support mdx for mintlify

closes #9 #10

…ndencies.

- Removed `SamplesTransformer.kt` in `korro-gradle-plugin` and introduced `korro-analysis` subproject for sample extraction and transformation logic.
- Added new modular components: `SampleExtractor`, `SamplesTransformer`, and `FqnResolver` in `korro-analysis`.
- Updated Kotlin to version 2.3.20 and aligned Gradle scripts with the latest changes.
- Enhanced `integration-tests`: added `commonTestFixture`, updated test setup, and improved golden-file comparison logic.
- Adjusted build configuration: updated Gradle plugin versions, improved shadow JAR handling, and introduced resource generation (`korro-gradle-plugin`).
- Added `commonTest` fixture with example test and documentation expectations.
…ystem

- Introduced `funs` and `strictErrors` integration test fixtures, verifying sample extraction and strict error handling scenarios.
- Enhanced diagnostics with detailed reporting for unresolved directives (`FUN` and `FUNS`) and hints for potential matches.
- Expanded `SamplesTransformer`: added glob matching (`matchGlob`) and Levenshtein-based suggestions (`suggestShortNames`).
- Extended `KorroAction`, handling diagnostics and formatting detailed error tables.
- Updated fixture Gradle scripts for `ignoreMissing` and added `korro` configurations.
…ecture overview

- Introduced `CLAUDE.md` providing guidance for contributors, including repository structure, build commands, and version wiring.
- Clarified Korro's `korro-gradle-plugin` and `korro-analysis` subproject responsibilities.
- Detailed directive parsing, sample extraction, and markdown rewriter behavior.
- Documented caching strategy, configuration properties, and consumer project usage.
- Covered package dependencies, runtime classpath isolation, and design considerations for future refactoring.
…adle version catalog, modularize scripts with aliases, and enhance consistency across subprojects
…korro` for improved caching and clarity

- Deprecated `korroApply` in favor of a streamlined task structure with `korroGenerate` and `korro`.
- Introduced `korroGenerate` (cacheable) for isolated markdown generation into `build/korro/docs/` without mutating sources.
- Updated `korro` to depend on `korroGenerate` and handle applying generated docs onto the source tree.
- Updated documentation, integration tests, and example commands to reflect task changes.
- Enhanced task descriptions, clarified CI usage, and ensured safe regeneration workflows.
- Introduced support for MDX (`.mdx`) files using JSX-expression-style directives (`{/*---...--*/}`) for compatibility with MDX parsers like Mintlify and Docusaurus. Updated README, CLAUDE.md, and MIGRATION.md with usage documentation.
- Refactored directive parsing to support syntax selection by file extension via a new `DirectiveSyntax` enum.
- Extended directive validation and handling in `korro` to ensure consistency across `.md` and `.mdx` files.
- Added MDX-specific integration tests, fixtures, and example Kotlin samples.
- Updated Gradle scripts and integration test setup to include `.mdx` support.
@devcrocod devcrocod merged commit ebb0c4f into master Apr 18, 2026
1 check passed
@devcrocod devcrocod deleted the K2 branch April 18, 2026 18:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Use Kotlin Analysis directly instead of dokka

1 participant