TypeScript TSDoc

This documentation was generated with the assistance of AI. Please report any inaccuracies.

Audit given TypeScript file(s)/scope for complete TSDoc coverage on every exported function, class, interface, type alias, and enum — React components' props interfaces and hooks, Angular components/services/inputs/outputs, NestJS controllers/services/DTOs/modules/guards/pipes, and Next.js components/pages/server actions/route handlers included — generate any missing or incomplete TSDoc grounded in the actual code and current changes, then run the project’s own doc-build tooling (TypeDoc or Compodoc) to confirm the result builds without warnings/errors.

Purpose

iru-typescript-tsdoc closes TypeScript documentation gaps without assuming a fixed house style or framework: it first detects the project’s flavor (library, React, Angular, React Native, Ionic, a Vaadin Hilla frontend, NestJS, or Next.js) to know which symbols count as "exported" and which tool verifies the result, discovers this project’s own TSDoc bar (contributor guide, typedoc.json/.compodocrc.json settings, ESLint JSDoc/TSDoc rules, or observed practice), audits every in-scope symbol, fills in what’s missing, and proves the result actually builds via TypeDoc or Compodoc — mirroring how iru-java-javadoc runs a Javadoc build rather than generating generic, possibly non-conforming comments. For NestJS (Compodoc preferred, else TypeDoc) and Next.js (TypeDoc), where neither tool is guaranteed to be installed, it never fetches one on the fly: it verifies with whichever the project configured and reports the run as audit-only ("doc build not verified") when neither is. The Next.js TypeDoc run needs npx next typegen first and --validation.notExported false.

React Native follows the Next.js rule for both toolchains (expo when expo is a dependency, otherwise metro): TypeDoc only when typedoc is a devDependency or a typedoc.json exists, since neither the React Native CLI template nor create-expo-app ships one, else audit-only. Screens, hooks, services and Turbo Module/Codegen Native*.ts specs (the only shared contract between JS and the Kotlin/Obj-C++ sides) are in scope; android/, ios/, .expo/, tooling config files and the root AppRegistry/registerRootComponent entry are dropped from scope and reported. TypeDoc runs with one --entryPoints per in-scope file and type-checks the whole tsconfig.json first, so a type error elsewhere (for example missing "types": ["jest"]) is reported as "TypeDoc blocked by type errors", not as a doc gap.

Purpose group

TypeScript Development Tooling

Plugin

Shipped by the iru-typescript plugin of the ai-catalog marketplace (install with /plugin install iru-typescript@ai-catalog; see Plugins).

Invocation

/iru-typescript-tsdoc
/iru-typescript-tsdoc <path-or-glob>

Inputs

Argument Required Description Default

Argument	Required	Description	Default
`<path-or-glob>`	No	Comma-separated paths/globs to audit. Resolved via `find`/`ls`; any resolved file that is a test file (`.test.ts(x)`, `.spec.ts(x)`, or anything under `test/`, `tests/`, `tests/`, `e2e/`) is dropped from scope and called out in the final report, since test files carry no TSDoc requirement here.	None — defaults to every non-test `.ts`/`.tsx` file touched by uncommitted changes plus commits on the current branch not yet on the base branch, filtering out `node_modules/`, `dist/`, `build/`, generated files, and `.d.ts` files. If that default scope is empty, the skill tells the user there’s nothing to document and stops.

<path-or-glob>

Comma-separated paths/globs to audit. Resolved via find/ls; any resolved file that is a test file (.test.ts(x), .spec.ts(x), or anything under test/, tests/, tests/, e2e/) is dropped from scope and called out in the final report, since test files carry no TSDoc requirement here.

None — defaults to every non-test .ts/.tsx file touched by uncommitted changes plus commits on the current branch not yet on the base branch, filtering out node_modules/, dist/, build/, generated files, and .d.ts files. If that default scope is empty, the skill tells the user there’s nothing to document and stops.

Outputs

Edits (via the Edit tool) to the in-scope files, adding or completing TSDoc comments — no logic, signatures, formatting outside the added comments, or member ordering is changed.
A confirmed, warning-free doc-build pass: npx typedoc --emit none --treatWarningsAsErrors --validation.notDocumented true for library/react/ionic/hilla-frontend (and NestJS/Next.js/React Native when TypeDoc is configured), or npx compodoc -p tsconfig.json --silent --coverageTest <threshold> --coverageMinimumPerFile <threshold> --coverageTestShowOnlyFailed for angular (and NestJS when Compodoc is configured). With neither tool configured on NestJS/Next.js/React Native, the run is audit-only and the report says the doc build was not verified.
A plain-text report: per file, how many exported symbols were already documented vs. gaps found and filled (named, with kind); the final doc-build result (TypeDoc pass/fail detail, or Compodoc’s coverage percentages vs. threshold); any excluded test-file argument; any out-of-scope pre-existing doc-build failure noted as a follow-up.
No full docs-site build, no lint/static-analysis fixes unrelated to TSDoc, and no test changes — those are left to other skills.

Execution flow

flowchart TD A["Start /iru-typescript-tsdoc\n(optional path-or-glob)"] --> B["Detect project flavor:\nhilla-frontend, react-native, ionic,\nnestjs, nextjs, angular, react, or library"] B --> C{Argument given?} C -- yes --> D["Resolve paths/globs;\ndrop test files from scope"] C -- no --> E["Scope to non-test .ts/.tsx files touched\nby uncommitted changes + branch commits\nnot on base"] D --> F{Scope empty?} E --> F F -- yes --> G["Tell user: nothing to document, stop"] F -- no --> H["Discover this project's TSDoc bar:\ncontributor guide, typedoc.json/.compodocrc.json,\nESLint JSDoc/TSDoc rules, or observed practice"] H --> I["Skim existing documented exports\nfor phrasing and tag conventions"] I --> J["Audit each in-scope file's exported\nsymbols per flavor's export definition"] J --> K["Record every gap: symbol, kind,\nwhat's missing"] K --> L["Generate missing TSDoc grounded in\nimplementation + git diff + Step 2 conventions"] L --> M["Apply edits with the Edit tool"] M --> N{Doc tool for flavor?} N -- "angular, or nestjs with Compodoc" --> O["Run npx compodoc with\ncoverageTest thresholds"] N -- "other, or nestjs/nextjs/react-native with TypeDoc" --> P["Run npx typedoc --emit none\n--treatWarningsAsErrors\n--validation.notDocumented true"] N -- "nestjs/nextjs/react-native with neither tool" --> U["Audit-only: skip doc build,\nreport it as not verified"] U --> S O --> Q{Fails or warns\non in-scope files?} P --> Q Q -- yes --> R["Fix offending comments,\nre-run until clean"] Q -- no --> S["Report: per-file gaps filled,\ndoc-build result, excluded test files"] R --> S

Dependencies

Invokes

None — iru-typescript-tsdoc is a leaf skill; it only runs npx typedoc/npx compodoc, reads/edits TypeScript source, and reports, it does not call any other skill in this catalog.

Invoked by

TypeScript Code One Task Group — Step 3.2, once per task group, via the iru-gate-runner agent, to update TSDoc for every file the group touched and confirm the project’s doc-build tooling passes.
NestJS Code One Task Group — Step 3.2, TSDoc for touched source files, via the iru-gate-runner agent.
Next.js Code One Task Group — Step 3.2, TSDoc for touched files, via the iru-gate-runner agent.
React Native Code One Task Group — Step 3.2, TSDoc for the bucket’s TS/TSX source files (native trees and config excluded), via the iru-gate-runner agent.

Related agents

None — this skill spawns no agents itself; callers run it inside an iru-gate-runner sub-agent.

Source

SKILL.md on GitHub — the file this page was generated from.