Update smithy-docgen to consume shared snippet files to render examples #2894
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
This makes `DefaultBuilderRef` public so that it can be sued for nested collections outside of smithy-utils. Nested collections can be quite tricky to handle properly, and having to re-write all the safe borrowing code for them shouldn't be necessary.
This adds a shared file definition for sharing generated snippets for things like the examples trait. These shared definitions will be consumed by smithy-docgen when generating docs.
This updates smithy-docgen to load snippets from either shared snippet files or explicitly configured snippet files. These are used to fill out the examples from the examples trait.
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
.changes/next-release/feature-3c70351cce599e85b810d4418fee8e5ca661436e.json
Show resolved
Hide resolved
.changes/next-release/feature-df6f8fb30971b29b76010e7143df11affcb9618f.json
Show resolved
Hide resolved
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
JordonPhillips
force-pushed
the
read-snippets
branch
from
0976ed9 to
dfc75de
Compare
yasmewad
reviewed
Dec 17, 2025
| * @return Returns a SnippetConfig based on the given file. | ||
| */ | ||
| public static SnippetConfig load(Path path) { | ||
| return fromNode(Node.parse(IoUtils.readUtf8File(path))); |
Contributor
There was a problem hiding this comment.
Question: Do we need to add some failure checking here with a more elegant message in terms of what went wrong exactly, was it incorrect path, or the file had parsing errors? Or is it just handled in the fromNode and Node.parse
Comment on lines
+157
to
+163
| LinkedHashMap<ShapeId, Map<ShapeId, List<Snippet>>> copy = new LinkedHashMap<>(); | ||
| for (Map.Entry<ShapeId, Map<ShapeId, List<Snippet>>> entry : snippets.entrySet()) { | ||
| LinkedHashMap<ShapeId, List<Snippet>> serviceCopy = new LinkedHashMap<>(); | ||
| for (Map.Entry<ShapeId, List<Snippet>> serviceEntry : entry.getValue().entrySet()) { | ||
| serviceCopy.put(serviceEntry.getKey(), new ArrayList<>(serviceEntry.getValue())); | ||
| } | ||
| copy.put(entry.getKey(), serviceCopy); |
Contributor
There was a problem hiding this comment.
This and the immutableWrapSnippetMap share same logic other than the last part. Let's move them out to a new method and use it instead?
|
|
||
| @Test | ||
| public void roundTrips() throws Exception { | ||
| Node expected = Node.parse(getClass().getResource("snippet-config.json").openStream()); |
Contributor
There was a problem hiding this comment.
Question for my learning: Since we open this as a stream do we need to close the stream too?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
This updates smithy-docgen to pull examples from shared snippet files generated by other build plugins. It pulls these from both explicit configuration as well as from the projection-local shared space.
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.