chore(maintenance): make the root tsconfig an options base with no program - #5646
Merged
Conversation
2 tasks
dreamorosi
approved these changes
Sep 5, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
The root
tsconfig.jsoncarried areferencesarray that had drifted to eleven of fifteen packages. The root is only an options base: every project extends it and lists its own files, and TypeDoc inpackagesmode readscompilerOptionsfrom it while taking file lists from each package's own tsconfig. The array existed solely to keep the root loadable, since TypeScript rejects a barefiles: []with noincludeorreferences. This PR replaces the list with the minimal shape TypeScript and TypeDoc accept for a config with no inputs, so there is nothing left to drift.Changes
tsconfig.json: dropreferences; keepfiles: []and add emptyincludeandreferencesarrays with a comment explaining why both are needed. The root compiles nothing, so a baretscat the root stays a no-op.tsconfig.cjs.json: addfiles: []so the CommonJS base stays valid on its own now that it no longer inherits the list.CODING_STANDARDS.md: the verification section pointed atnpm run tsc, which no workspace defines. Since everytests/tsconfig.jsonincludes../src, thebuild:testsbullet now states it type-checks source and tests, and notesnpm run buildalso compiles the CommonJS target.Verified with the real docs build,
mkdocs buildon Python 3.12 as CI uses it: exit 0, TypeDoc runs through the mkdocs-typedoc plugin without a config error, andsite/apihas the same 134 module pages as before. Alsotsc -pon both root configs is valid and compiles nothing; a package build, a packagebuild:testsand the snippets type-check all pass. Removing the list without the empty arrays fails TypeDoc withTS18002and would have published an empty API Reference, since the docs build runs mkdocs in non-strict mode.Issue number: closes #5644
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.
Disclaimer: We value your time and bandwidth. As such, any pull requests created on non-triaged issues might not be successful.