Sort routes by path before writing the output JSON in openapi-generator #925
Conversation
bitgopatmcl
force-pushed
the
bitgopatmcl/sort-routes-by-path
branch
3 times, most recently
from
821537e to
d0b9ac6
Compare
bitgopatmcl
force-pushed
the
bitgopatmcl/sort-routes-by-path
branch
from
d0b9ac6 to
32dab4d
Compare
| .sort((a, b) => a.localeCompare(b)) | ||
| .reduce( | ||
| (acc, key) => { | ||
| acc[key] = paths[key]!; |
There was a problem hiding this comment.
This works because insertion order is preserved for string keys
There was a problem hiding this comment.
Hmm, yes I see this in the comment you linked:
entries come in the order in which the properties were added
Followed immediately by:
Relying on object property ordering in JavaScript is a really bad idea, because it makes code extremely fragile. If you need an ordering, create an array with the properties in it in the order that works for your application.
😅
How do you feel about using a Map instead of an object? The overview of Map on MDN reads:
The Map object holds key-value pairs and remembers the original insertion order of the keys.
There was a problem hiding this comment.
I can try and see how it serializes.
There was a problem hiding this comment.
No luck:
YAMLException: unacceptable kind of an object to dump [object Map]
There was a problem hiding this comment.
js-yaml has a sortKeys option but that sorts all the keys and not just the ones under paths.
There was a problem hiding this comment.
All righty, well, so long as it's tested and deterministic!
bitgopatmcl
force-pushed
the
bitgopatmcl/sort-routes-by-path
branch
from
32dab4d to
74395e1
Compare
BREAKING CHANGE: Changing output order of routes may affect consumers
bitgopatmcl
force-pushed
the
bitgopatmcl/sort-routes-by-path
branch
from
74395e1 to
b014517
Compare
|
🎉 This PR is included in version @api-ts/[email protected] 🎉 The release is available on npm package (@latest dist-tag) Your semantic-release bot 📦🚀 |
|
🎉 This PR is included in version @api-ts/[email protected] 🎉 The release is available on npm package (@latest dist-tag) Your semantic-release bot 📦🚀 |
|
🎉 This PR is included in version @api-ts/[email protected] 🎉 The release is available on npm package (@latest dist-tag) Your semantic-release bot 📦🚀 |
|
🎉 This PR is included in version @api-ts/[email protected] 🎉 The release is available on npm package (@latest dist-tag) Your semantic-release bot 📦🚀 |
Sort routes by path before writing the output JSON in
openapi-generator.convertRoutesToOpenAPIfunction inpackages/openapi-generator/src/openapi.tsto sort routes by path before constructing thepathsobject.packages/openapi-generator/test/openapi/base.test.tsto verify routes are sorted by path in the output JSON.BREAKING CHANGE: Changing the sort order may affect consumers that review diffs of the generated JSON