Repository navigation
fix: escape comment delimiters in generated SDK JSDoc - #1252
Merged
Merged
Conversation
OpenAPI info metadata copied into JSDoc tags could close the comment and run as TypeScript when the generated SDK is imported. Co-authored-by: Cursor <cursoragent@cursor.com>
🦋 Changeset detectedLatest commit: 2297c3c The changes in this PR will be included in the next version bump. This PR includes changesets to release 1 package
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
Escape comment delimiters to ensure proper JSDoc generation.
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.
🧰 Changes
The TypeScript generator copies OpenAPI
infometadata into JSDoc tags on the generatedsrc/index.ts. Title, description, operation summaries, and response descriptions already went throughdocblockEscape(). Contact name, contact URL, terms of service, license name, and license URL did not. A value containing a comment terminator closed the docblock, and the rest of the value was emitted as TypeScript that runs when the generated SDK is imported.#addTagToDocblock()now escapes string tag text before adding it, so every tag is covered. Escaping text that was already escaped does not change it.🧬 QA & Testing
npx vitest run packages/api/test/codegen/languages/typescript/index.test.ts@author,@see, and@license.