fix(docs): resolve TypeScript errors in docs build - #1046
Conversation
|
Note Currently processing new changes in this PR. This may take a few minutes, please wait... ⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Advanced Run ID: 📒 Files selected for processing (1)
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Advanced Run ID: 📒 Files selected for processing (2)
Included review availability: Your plan provides up to 2 included reviews per hour; 1 remains after this review. 📝 WalkthroughWalkthroughThe pull request adds a TypeScript configuration for TypeDoc and updates TypeDoc to use it. The configuration scopes compilation to ChangesTypeDoc configuration
Priority: ⬇️ Low Estimated code review effort: 1 (Trivial) | ~5 minutes Change: Bug fix Suggested reviewers: Merge Risk: ⚪ Minimal · up to TypeDoc is pointed to a scoped library configuration that avoids unrelated schematics compilation; no merge-blocking risk is identified. 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
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 |
Summary
Fixes
npm run docs, which was failing with TypeScript errors from@angular-devkit/schematics.The issue was introduced by #1018 during the Jest-to-Vitest migration. Removing the Jest configuration also removed an accidental dependency on Node.js types, exposing that TypeDoc was loading schematics alongside the SDK source.
Changes
src/**/*.ts.Testing
The following commands complete successfully:
npm run docsnpm run buildnpm run build:schematicsnpm run test:ciThe docs build now reports 0 errors and is successful.
Follow-up
npm run docsto CI to prevent future regressions.Summary by CodeRabbit