Enforce TSDoc linting #2293
Description
Describe what should be investigated or refactored
Enable and standardize TSDoc usage across UDS Core by adding linting via eslint-plugin-tsdoc.
We currently have partial and inconsistent TSDoc coverage on functions and parameters. Several folks find these comments helpful when tracing code and during reviews, and AI tooling makes generating them relatively low-effort. Introducing linting would help us:
- Establish a consistent documentation standard
- Catch missing or malformed TSDoc comments
- Improve readability and reviewability as we approach 1.0
This would likely require a one-time pass to document any existing gaps once linting is enabled.
Links to any relevant code
- TSDoc ESLint plugin: https://tsdoc.org/pages/packages/eslint-plugin-tsdoc/
- example of undocumented function: https://github.com/defenseunicorns/uds-core/blob/v0.59.1/src/pepr/operator/controllers/keycloak/client-sync.ts#L216-L237
Additional context
Discussion in Slack showed general support or making this a standard and potentially tackling the resulting cleanup in a single larger PR. This may also surface additional tech debt, which could be a net positive pre-1.0.