docs(router-plugin): add JSDoc-backed configuration input types
Open
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 15.1k
- Forks
- 1.9k
- Avg merge
- 1d 20h
- Merged PRs (30d)
- 143
Description
Goal
Expose configuration input types with accurate JSDoc so editor tooling can show option descriptions and defaults for Router generator and bundler-plugin configuration.
Scope
- Define documented configuration input types from the current schemas.
- Keep validated output types separate from untrusted configuration input.
- Accept
unknownat parsing boundaries and validate with the existing schemas. - Keep generator and plugin configuration types aligned with their current public APIs.
- Add exact type assertions for the exported input and output types.
- Preserve current documentation as the source for option descriptions and defaults.
Related Work
This continues the work started in #4644
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reviewing the current generator and bundler-plugin schemas, their public configuration APIs, and the related work in #4644. Compare the documented options and defaults with the input and output types; done means the exported types have exact assertions, accept unknown at parsing boundaries, and preserve current documentation accurately.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- developer-experience, documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 50/100