KCL: New KCL type formatter and parser #8774
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
adamchalmers
force-pushed
the
achalmers/unit-tests
branch
from
57843cd to
ab0373f
Compare
adamchalmers
changed the title
The "clean up type string" logic [here](https://github.com/KittyCAD/modeling-app/blob/achalmers/array-of-unions/rust/kcl-lib/src/docs/gen_std_tests.rs#L517) is a bit complicated, and it doesn't support arrays of unions. IMO it's difficult to do both formatting and parsing of KCL types in the same function. A better approach would be to recursively parse the type into a tree structure (where arrays have a subtype, and unions have multiple subtypes), then format that tree. This PR just parses the type tree, and runs it through all the type names we generate while building KCL's docs. A follow-up PR will then traverse that tree to build the nicely-formatted type.
adamchalmers
force-pushed
the
achalmers/unit-tests
branch
from
08afb12 to
f200e37
Compare
![graphite-app[bot]](https://avatars.githubusercontent.com/in/158384?s=60&v=4){kind=small}
jtran
approved these changes
Nov 4, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The "clean up type string" logic here is a bit complicated, and it doesn't support arrays of unions. IMO it's difficult to do both formatting and parsing of KCL types in the same function. A better approach would be to recursively parse the type into a tree structure (where arrays have a subtype, and unions have multiple subtypes), then format that tree.
This PR:
cleanup_type_stringto use this parsed tree, rather than adhoc string processing. This includes changes to the unit tests added in the first commit.This has some very slight changes to the resulting Markdown, which should be easy to see. They're basically change how arrays are nested in their markdown links.
As a side-effect this should unblock Serena's PR which adds array of unions.
Old: the Markdown link contains a
[string]in its textNew: the Markdown link is just around
string, and the surrounding array braces are outside the link.