fix: Properly append a $ suffix to reserved words in index files #384
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.
Problem
See #383.
Long story short, exports that use reserved keywords (e.g.
import) inindex.tsfiles (when"indexFile": true) do not have the$prefix used everywhere else in the emitted code. As a result, theindex.tswould referenceimportwhich isimport$everywhere else. This leads to TS code that does not compile.Solution
The
ensureNotReservedhelper applies the$suffix. It's already applieds on themethodNameto produceimportName. However, theindex.tstemplate referencesmethodNameand not theimportName.This change switches the template to
importName.Also wrote a test for the problematic case, that fails without the current fix. To use the generated
functionsin the test, I had to expose them fromng-openapi-gen.ts.