feat(codegen): strip HTML tags from documentation traits in generated JSDoc#1908
Open
TrevorBurnham wants to merge 1 commit intosmithy-lang:mainfrom
Open
Conversation
… JSDoc Adds a DocumentationConverter utility that converts HTML documentation strings from Smithy @documentation traits into plain text before they are emitted as JSDoc comments. This makes hover docs in editors (VS Code, Neovim, etc.) significantly more readable by removing raw HTML tags like <p>, <a>, <code>, <ul>/<li>, and others. Fixes aws/aws-sdk-js-v3#6876
c449627 to
c11e1a8
Compare
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
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.
Issue #, if available:
Resolves aws/aws-sdk-js-v3#6876
Description of changes:
Smithy model
@documentationtrait values often contain raw HTML markup (<p>,<a href="...">,<code>,<ul>/<li>, etc.). The TypeScript codegen currently passes this HTML through verbatim into JSDoc comments, making hover docs in editors like VS Code and Neovim very hard to read.For example, generated code ends up with comments like:
After this change, the same ECS example renders as:
Implementation details
Added a
DocumentationConverterutility class insmithy-typescript-codegenwith anhtmlToPlainText(String html)method that converts HTML documentation into clean plaintext suitable for JSDoc. The converter:<a>tags (drops URLs)<code>/<pre>content in backticks<li>items to dash-prefixed lines<dt>/<dd>definition list elements to readable format<p>,<br>,<h1>–<h6>,<div>, etc.) with paragraph breaks<b>,<i>,<strong>,<em>,<span>, etc.)&,<,>,",', , numeric/hex entities)By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.