chore: add type definition generation to publish process (v1.x) #461
Conversation
There was a problem hiding this comment.
Pull Request Overview
This PR adds TypeScript declaration file generation to enable better type support for users importing the @trojs/openapi-server package. It addresses module declaration issues by generating .d.ts files from JSDoc comments during the publish process.
- Added TypeScript as a dependency and configured build:types script to generate declaration files
- Updated publish process to automatically generate types before publishing via prepublishOnly hook
- Added types field to package.json to specify the main declaration file entry point
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
|
Important Review skippedAuto reviews are disabled on base/target branches other than the default branch. Please check the settings in the CodeRabbit UI or the You can disable this status message by setting the ✨ Finishing touches🧪 Generate unit tests
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
What
Users are having module declaration issues when importing @trojs/openapi-server:
This PR enhances JSDoc documentation and adds declaration file generation to improve type support. The
npm run build:typesruns onnpm run publish.typescripttsc cli only to convert JSDoc comment into.d.tsfiles.tsc --init.How to test
To generate the declaration files from JSDoc, run:
npm run build:typesCheck that types folder is created with .d.ts files
Let me know if you have any questions!