feat: Add descriptions and deprecations to SDK - #947
Merged
Conversation
razor-x
force-pushed
the
codex/generate-tsdoc-or-jsdoc-annotations
branch
from
July 28, 2026 03:46
9a83ddd to
a3a82f9
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.
Motivation
Description
docto the codegen helpers atcodegen/lib/handlebars-helpers.tsthat escapes*/, emits@deprecatedwhen appropriate, and returns a TSDoc comment block. (doc,escapeComment)description,isDeprecated,deprecationMessage) incodegen/lib/layouts/route.tsand use it when rendering endpoints.codegen/layouts/partials/*andcodegen/layouts/*).src/lib/seam/connect/*now includes the new TSDoc comments for resource types, routes, request/response types, and many route implementations.Testing
npm_config_force=true npm run generateto run the codegen and regenerate sources (used--forcedue to dev engine constraints), and the generation completed successfully.npm_config_force=true npm run typecheck(tsc) and the TypeScript type check completed successfully under the forced install.npm_config_force=true npm run docs:build; Typedoc completed and produced./docswith pre-existing warnings about some cross-references (non-fatal).npm_config_force=true npm test; automated tests could not fully run in this environment because the installedEmitteryrelies on iterator helpers not present in the runtime Node 20 used here (project requires Node >= 22.11), so tests did not complete in this environment;git diff --checkproduced no whitespace/comment issues.Codex Task