Skip to content

fix(docs): resolve TypeScript errors in docs build - #1046

Merged
gyaneshgouraw merged 2 commits into
mainfrom
fix/docs-build
Sep 17, 2026
Merged

gyaneshgouraw merged 2 commits into
mainfrom
fix/docs-build

Conversation

@gyaneshgouraw

@gyaneshgouraw gyaneshgouraw commented Sep 17, 2026

Copy link
Copy Markdown
Contributor

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

  • Added a docs-specific TypeScript config scoped to src/**/*.ts.
  • Updated TypeDoc to use the new config.
  • Kept the library, build, and test configurations unchanged.

Testing

The following commands complete successfully:

  • npm run docs
  • npm run build
  • npm run build:schematics
  • npm run test:ci

The docs build now reports 0 errors and is successful.

Follow-up

  • Discuss mechanics and add npm run docs to CI to prevent future regressions.

Summary by CodeRabbit

  • Documentation
    • Updated API documentation generation to use a dedicated TypeScript configuration.
    • Documentation builds now include library source files while excluding test files, helping keep generated reference material focused and relevant.
    • Existing library compilation settings remain the basis for documentation generation, with documentation-specific file selection applied separately.

@gyaneshgouraw
gyaneshgouraw requested a review from a team as a code owner September 17, 2026 13:18
@coderabbitai

coderabbitai Bot commented Sep 17, 2026

Copy link
Copy Markdown

Review Change StackReview Change Stack

Note

Currently processing new changes in this PR. This may take a few minutes, please wait...

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Advanced

Run ID: 71bcc661-24fb-4f90-9c5b-a037c4cd4dcc

📥 Commits

Reviewing files that changed from the base of the PR and between 9404569 and 9d8f412.

📒 Files selected for processing (1)
  • projects/auth0-angular/tsconfig.doc.json
 _____________________________________________
< Assembling the Avengers to fight your bugs. >
 ---------------------------------------------
  \
   \   \
        \ /\
        ( )
      .( o ).

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Advanced

Run ID: 28b9b5e4-255d-4d8d-a796-7f310f97abe4

📥 Commits

Reviewing files that changed from the base of the PR and between 44a885f and 9404569.

📒 Files selected for processing (2)
  • projects/auth0-angular/tsconfig.doc.json
  • typedoc.json

Included review availability: Your plan provides up to 2 included reviews per hour; 1 remains after this review.


📝 Walkthrough

Walkthrough

The pull request adds a TypeScript configuration for TypeDoc and updates TypeDoc to use it. The configuration scopes compilation to src/**/*.ts and excludes specification files and the schematics/ directory.

Changes

TypeDoc configuration

Layer / File(s) Summary
Scoped documentation configuration
projects/auth0-angular/tsconfig.doc.json, typedoc.json
The new configuration extends tsconfig.lib.json, includes only library source files, and excludes specification files. typedoc.json now references this configuration.

Priority: ⬇️ Low

Estimated code review effort: 1 (Trivial) | ~5 minutes

Change: Bug fix

Suggested reviewers: frederikprijck

Merge Risk: ⚪ Minimal · up to 94045

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)
Check name Status Explanation
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly and concisely describes the main change: fixing TypeScript errors in the documentation build through a docs-specific TypeScript configuration.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Commit to this branch
  • Create a new PR

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@gyaneshgouraw gyaneshgouraw changed the title fix: update TypeDoc configuration to use docs-only tsconfig fix(docs): resolve TypeScript errors in docs build Sep 17, 2026
@gyaneshgouraw
gyaneshgouraw merged commit 3ce0922 into main Sep 17, 2026
13 of 14 checks passed
@gyaneshgouraw
gyaneshgouraw deleted the fix/docs-build branch September 17, 2026 13:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants