Add a zero-tolerance TypeDoc documentation gate#436
Draft
leynos wants to merge 2 commits into
Draft
Conversation
added 2 commits
July 18, 2026 00:45
Prepare for a zero-tolerance TypeDoc documentation gate across the JavaScript/TypeScript workspaces: document the fetch mutators and query keys in `frontend-pwa/src/api`, the root `App` component, the zod user schema fields in `@app/types` (field-site comments so the inferred output types carry them), the token-reference resolver in `@app/tokens`, and the contrast validator's `PackageJson` typedef (converted to `@property` form so each field can carry a description).
Add `docs-check` to `make all` (and a root `docs:check` script) covering three surfaces, each with its own configuration beside its tsconfig: `frontend-pwa` (`src`, `expand`, excluding the generated Orval client under `src/api/generated` and tests), `packages/types` (`src`, `expand`), and `packages/tokens` (JavaScript via a dedicated `tsconfig.typedoc.json` with `allowJs`, `checkJs: false`). Each runs TypeDoc's `notDocumented` validation with `emit: "none"` and validation warnings treated as errors: 100% documentation of the selected surfaces, qualified names reported for any omission, and no documentation artefacts written. TypeDoc and TypeScript 5.9.2 are added at the workspace root with pnpm.
![sourcery-ai[bot]](https://avatars.githubusercontent.com/in/48477?s=60&v=4){kind=small}
Contributor
|
Important Review skippedDraft detected. Please check the settings in the CodeRabbit UI or the ⚙️ Run configurationConfiguration used: Organization UI Review profile: ASSERTIVE Plan: Pro Plus Run ID: You can disable this status message by setting the Use the checkbox below for a quick retry:
✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
![codescene-access[bot]](https://avatars.githubusercontent.com/in/3755875?s=60&v=4){kind=small}
This comment was marked as outdated.
This comment was marked as outdated.
Sorry, something went wrong.
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
1 participant
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
This branch adds a zero-tolerance TypeDoc documentation gate to
make all, covering the three JavaScript/TypeScript surfaces of theworkspace:
frontend-pwa(src, expanded, excluding the generatedOrval client and tests),
packages/types, andpackages/tokens(plainJavaScript via a dedicated
tsconfig.typedoc.jsonwithallowJsandcheckJs: false). Each surface has its own TypeDoc configurationbeside its tsconfig; a root
docs:checkscript chains them andmake docs-checkruns it insidemake all. Every run usesemit: "none"with validation warnings treated as errors: 100%documentation of the selected surfaces, qualified names reported for
any omission, and no documentation artefacts written. Generated Orval
output and generated declaration files are not inspected.
Review walkthrough
frontend-pwa/typedoc.json,
packages/types/typedoc.json,
and packages/tokens/typedoc.json
with packages/tokens/tsconfig.typedoc.json.
package.json
(
docs:checkscript; TypeDoc and TypeScript 5.9.2 added withpnpm add --workspace-root) and theMakefile
(
docs-checkinmake all).frontend-pwa/src/api/fetcher.ts,
packages/types/src/user.ts
(zod field-site comments so the inferred output types carry them),
and
packages/tokens/build/validate-contrast.js
(the
PackageJsontypedef converted to@propertyform).Validation
make check-fmt,make lint,make docs-check,make test-frontend, and the spelling gates: all green.make test-scriptsfails only on the twolocal_k8ssmoke tests,which require a
kind-wildside-previewcluster context that does notexist on the build machine — pre-existing environmental dependence,
unrelated to this change (93 of 95 script tests pass).
docs:checkrun emits no files.Notes
Replace docstring-coverage with a zero-tolerance TypeDoc gate df12-build#62, Replace the docstring audit with a zero-tolerance TypeDoc gate dakar#5, Add a zero-tolerance TypeDoc documentation gate digitalpuddle#47,
Add a zero-tolerance TypeDoc documentation gate simulacat-core#58, Add a zero-tolerance TypeDoc documentation gate vibe-coder#110, and
Add a frontend zero-tolerance TypeDoc documentation gate corbusier#156).