Skip to content

fix(docs): silence TS5101 baseUrl deprecation in docusaurus tsconfig#475

Open
bindsi wants to merge 1 commit intomainfrom
bug/tsconfig-baseurl-deprecation
Open

fix(docs): silence TS5101 baseUrl deprecation in docusaurus tsconfig#475
bindsi wants to merge 1 commit intomainfrom
bug/tsconfig-baseurl-deprecation

Conversation

@bindsi
Copy link
Copy Markdown
Member

@bindsi bindsi commented May 5, 2026

IMPORTANT: Before submitting, please remove all sensitive data, secrets, tokens, or confidential information. Ensure you've redacted any NDA-covered information, IP addresses, resource names, or security-related details that shouldn't be publicly disclosed.

Description

Unblocks the npm run typecheck job in CI, which started failing with TS5101 because TypeScript now treats baseUrl in docs/docusaurus/tsconfig.json as deprecated. Added "ignoreDeprecations": "6.0" to the compilerOptions block so the existing baseUrl: "." setting continues to compile cleanly without changing module resolution behavior.

This is a deliberately minimal, temporary workaround. The proper migration (removing baseUrl entirely, or moving to paths-based resolution before TypeScript 7) is tracked separately in #474.

Related Issue

Relates to #474

Type of Change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Blueprint modification or addition
  • Component modification or addition
  • Documentation update
  • CI/CD pipeline change
  • Other (please describe):

Implementation Details

Edited docs/docusaurus/tsconfig.json to add ignoreDeprecations: "6.0" alongside the existing baseUrl: "." value. No other compiler options or files were touched, and the Docusaurus base config (@docusaurus/tsconfig) is still extended unchanged.

Testing Performed

  • Terraform plan/apply
  • Blueprint deployment test
  • Unit tests
  • Integration tests
  • Bug fix includes regression test (see Test Policy)
  • Manual validation
  • Other:

Validation Steps

  1. From the repo root, run npm run typecheck inside docs/docusaurus/ (or the workspace command that invokes it).
  2. Confirm the build completes without the TS5101 error on baseUrl.

Checklist

  • I have updated the documentation accordingly
  • I have added tests to cover my changes
  • All new and existing tests passed
  • I have run terraform fmt on all Terraform code
  • I have run terraform validate on all Terraform code
  • I have run az bicep format on all Bicep code
  • I have run az bicep build to validate all Bicep code
  • I have checked for any sensitive data/tokens that should not be committed
  • Lint checks pass (run applicable linters for changed file types)

Security Review

  • No credentials, secrets, or tokens are hardcoded or logged
  • RBAC and identity changes follow least-privilege principles
  • No new network exposure or public endpoints introduced without justification
  • Dependency additions or updates have been reviewed for known vulnerabilities
  • Container image changes use pinned digests or SHA references

Additional Notes

The ignoreDeprecations: "6.0" flag is explicitly time-boxed: it stops working in TypeScript 7. Issue #474 captures the follow-up to remove baseUrl (and this flag) before the TS 7 upgrade.

Adds ignoreDeprecations: 6.0 as a temporary workaround.
Tracked for removal in #474.
@bindsi bindsi requested a review from a team as a code owner May 5, 2026 15:49
@github-actions
Copy link
Copy Markdown

github-actions Bot commented May 5, 2026

📚 Documentation Health Report

Generated on: 2026-05-05 16:01:46 UTC

📈 Documentation Statistics

Category File Count
Main Documentation 217
Infrastructure Components 196
Blueprints 39
GitHub Resources 43
AI Assistant Guides (Copilot) 17
Total 512

🏗️ Three-Tree Architecture Status

  • ✅ Bicep Documentation Tree: Auto-generated navigation
  • ✅ Terraform Documentation Tree: Auto-generated navigation
  • ✅ README Documentation Tree: Manual README organization

🔍 Quality Metrics

  • Frontmatter Validation:
    success
  • Link Validation: success

This report is automatically generated by the Documentation Automation workflow.

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.

1 participant