Uh oh!
There was an error while loading. Please reload this page.
chore: add type definition generation to publish process - #460
Conversation
WalkthroughAdded TypeScript declaration generation: tsconfig and npm scripts to emit declarations into a Changes
Sequence Diagram(s)sequenceDiagram
autonumber
participant Dev as Developer
participant NPM as npm
participant Shell as Shell
participant TSC as tsc
participant FS as filesystem
Dev->>NPM: npm publish
NPM->>Shell: run prepublishOnly
Shell->>Shell: rm -rf types
Shell->>NPM: npm run build:types
NPM->>TSC: invoke tsc (declaration emit)
TSC->>FS: write `types/`/*.d.ts and maps
TSC-->>NPM: exit (success)
NPM->>Dev: continue publish (with types included)
note right of FS #D3F6DB: Generated declarations now live in `types/`
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Pre-merge checks (3 passed)✅ Passed checks (3 passed)
Poem
Tip 👮 Agentic pre-merge checks are now available in preview!Pro plan users can now enable pre-merge checks in their settings to enforce checklists before merging PRs.
Please see the documentation for more information. Example: reviews:
pre_merge_checks:
custom_checks:
- name: "Undocumented Breaking Changes"mode: "warning"instructions: | Pass/fail criteria: All breaking changes to public APIs, CLI flags, environment variables, configuration keys, database schemas, or HTTP/GraphQL endpoints must be documented in the "Breaking Change" section of the PR description and in CHANGELOG.md. Exclude purely internal or private changes (e.g., code not exported from package entry points or explicitly marked as internal).Please share your feedback with us on this Discord post. ✨ 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 |
There was a problem hiding this comment.
Actionable comments posted: 2
🧹 Nitpick comments (2)
tsconfig.json (2)
10-13: Drop sourceMap; only declaration maps are emitted.With "emitDeclarationOnly": true, JS source maps are not produced. Keep "declarationMap": true, remove "sourceMap" to avoid confusion.
- "sourceMap": true, "declaration": true, "declarationMap": true,
4-5: Prefer declarationDir for clarity (optional).When emitting only .d.ts, using "declarationDir" communicates intent better than "outDir". Functionally equivalent here.
- "rootDir": "./src",- "outDir": "./types",+ "rootDir": "./src",+ "declarationDir": "./types",
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (1)
package-lock.jsonis excluded by!**/package-lock.json
📒 Files selected for processing (3)
.gitignore(1 hunks)package.json(2 hunks)tsconfig.json(1 hunks)
🔇 Additional comments (1)
.gitignore (1)
136-137: Ignoring generated types is fine, but ensure they’re published to npm.Since package.json uses a restrictive "files" whitelist, "types/**" won’t be published unless explicitly added, and consumers still won’t get typings without a top-level "types" entry. Add both in package.json (see my comment on package.json).
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Actionable comments posted: 0
♻️ Duplicate comments (1)
package.json (1)
21-21: Optional: map deep imports to declarations for better DX.If consumers import subpaths (e.g., @trojs/openapi-server/src/router.js), add a minimal typesVersions map.
"types": "types/server.d.ts", + "typesVersions": {+ "*": {+ "src/*": ["types/*"],+ "*": ["types/*"]+ }+ },
🧹 Nitpick comments (1)
package.json (1)
16-18: Make the publish step cross‑platform and idempotent (no extra deps).rm -rf breaks on Windows shells. Use a Node one‑liner to delete the folder portably before rebuilding.
Apply:
- "prepublishOnly": "rm -rf types && npm run build:types"+ "prepublishOnly": "node -e \"require('fs').rmSync('types',{recursive:true,force:true})\" && npm run build:types"
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
package.json(3 hunks)tsconfig.json(1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
- tsconfig.json
🔇 Additional comments (3)
package.json (3)
47-48: Dev deps aligned with the new flow.typescript and @types/* additions look right for JSDoc‑to‑d.ts generation.
35-36: Includingtypes/in published files — re-run pack to confirm (capture stderr).Previous run redirected stderr so only
trojs-openapi-server-3.3.1.tgzprinted; run:
npm pack --dry-run 2>&1 | sed -n '1,200p'
and confirmpackage/types/**or*.d.tsfiles appear under "Tarball Contents".
21-21: Types entry wired — confirm emitted file exists.tsc isn't available in this environment; package.json points to "types/server.d.ts", tsconfig emits declarations to ./types and prepublishOnly runs build:types. Run locally: npm ci && npm run build:types && test -f types/server.d.ts && head -n 20 types/server.d.ts to verify the declaration file will be produced and included.
Uh oh!
There was an error while loading. Please reload this page.
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!
Summary by CodeRabbit
New Features
Chores