feat: add API reference links to generated TypeScript comments #559
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
…enhance the ts comments before writing to index.d.ts Also updated the eslintrc to ecmaVersion 2020 and node engine minimum version to 14.8.0 to ensure support for dynamic import syntax
✅ Deploy Preview for open-api ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
CalebBarnes
commented
Jan 18, 2025
| @@ -56,7 +56,7 @@ | |||
| "start": "run-s lint build", | |||
| "bundle": "redocly bundle external@latest --output external.yml", | |||
| "build": "run-s convert bundle redoc", | |||
| "postbuild": "swagger2openapi external.yml -o dist/openapi.json && openapi-typescript dist/openapi.json -o dist/index.d.ts --alphabetize --empty-objects-unknown", | |||
There was a problem hiding this comment.
--alphabetize --empty-objects-unknown
These flags didn't actually do anything in this version of openapi-typescript cli so this doesn't matter.
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.
Summary
This PR introduces API reference links to the generated TypeScript comments for each method, enhancing developer experience with more context-rich documentation.
Changes
postbuild openapi-typescriptcommand with a custom script,src/typegen.js, allowing for enhanced TypeScript comments without affecting the docs site, including API reference links for each method, in the generatedindex.d.tsfile..eslintrcto useecmaVersion: 2020, enabling support for dynamic imports.14to14.8.0to ensure compatibility with dynamic import syntax used in the type generation process.Example of Changes:
Generated comments now include API reference links like this:
When these types are used in the
js-client, it adds helpful API reference links like this: