Fix requestBodies that use hypenated naming #550
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
If a request body's name is hypenated it breaks when prettier formats the code as it is an invalid object. Wrapping the request body's name in quotes resolves the issue, and prettier will strip the quotes when they're not required. Example for reproducing: ``` npx openapi-typescript https://github.com/raw/ashsmith/api-specs/fix-invalid-examples/reference/channels.v3.yml --output channels.v3.ts ```
Codecov Report
@@ Coverage Diff @@
## main #550 +/- ##
==========================================
+ Coverage 85.20% 85.50% +0.29%
==========================================
Files 9 9
Lines 338 338
Branches 112 112
==========================================
+ Hits 288 289 +1
+ Misses 46 45 -1
Partials 4 4
Continue to review full report at Codecov.
|
drwpow
reviewed
Apr 7, 2021
| @@ -68,7 +68,7 @@ export function transformRequestBodies(requestBodies: Record<string, RequestBody | |||
|
|
|||
| Object.entries(requestBodies).forEach(([bodyName, requestBody]) => { | |||
| if (requestBody && requestBody.description) output += ` ${comment(requestBody.description)}`; | |||
| output += ` ${bodyName}: {`; | |||
| output += ` "${bodyName}": {`; | |||
drwpow
reviewed
Apr 7, 2021
| }; | ||
| };`) | ||
| ); | ||
| }); |
drwpow
approved these changes
Apr 7, 2021
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
If a request body's name is hypenated it breaks when prettier formats the code as it is an invalid object.
Wrapping the request body's name in quotes resolves the issue, and prettier will strip the quotes when they're not required.
Example for reproducing:
Current result: