mnahkies / mnahkies/openapi-code-generator
Docs: clarify typescript compiler options requirements
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 34
- Forks
- 8
- Avg merge
- 20h 27m
- Merged PRs (30d)
- 7
Description
The runtime packages require specific typescript compiler options for the exports to be resolved correctly. Specifically a "moduleResolution": "Node16" or "bundler"
This is already the default if using the base for node22
Make sure this is clearly documented, as the error messages from tsc can be obtuse
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
No file or test is named. Start by locating the documentation for configuring generated runtime packages and read the TypeScript setup guidance. Document that moduleResolution must be Node16 or bundler, including the node22 base configuration, and consider the work done when the requirement and its purpose are clear to users.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 42/100