Big honkin‘ refactor, OpenAPI 3.1 features

[drwpow]

Changes

Refactors app, accomplishes many goals outlined in #961.

🧹 Codebase changes

• Drops Prettier for 3× faster builds 🚀🚀🚀
• Performance improvements across the board 🔥 (benchmarks are tricky but it’s objectively, noticably faster)
• Overall reduction & simplification of codebase, while improving OpenAPI support
• Updates target from ES2018 to ESNext (which most Node versions support)
• Hardened TypeScript types to improve stability and reduce unnecessary null checks (valid schemas are still required)

📖 OpenAPI changes

• Improvements to oneOf, anyOf, and allOf (finishes undone work outlined in anyOf should not result in intersection type #894 where anyOf was fixed but left oneOf broken)
• Updates TypeScript types from latest OpenAPI 3.1 spec
• Addition of path.default type
• Fixes [string, null] definition is converted to unknown #969
• Fixes Support nullable as type arrays for OpenAPI 3.1 #898
• Fixes Generates & { property: unknown; } with allOf union #958
• Fixes Map oneOf with discriminator to sum type #953

🤖 CLI changes

• --immutable-types has a new -t alias

🔨 Breaking changes

• Dropped Swagger 2.0 support
• Dropped Node 14 support (it still works for now, but Node 14 bugs won’t be fixed if any arise)
• --version was changed to return the version of this library (also by dropping Swagger 2.0 support the old usage was no longer needed)
• Dropped --raw-schema and support for partial schemas. Your entry schema MUST be valid and complete (however, your $refs to subschemas may be partials).
• Dropped Prettier support, so all formatting options have been dropped. But you are free to format the output however you’d like (or leave as-is)
• Dropped --make-paths-enum because it was incompatible with --path-params-as-types
• Dropped the CLI aliases -it and -ap (specify the full --immutable-types or --additional-properties flag)
• Empty content: {} now returns never. Dropped the --content-never flag as this is now the default behavior.
• Renamed and upgraded the Node API’s formatter() function to transform() and postTransform(). It’s an overall improvement on the original concept with even more power than before.

[codecov]

Codecov Report

Base: 93.62% // Head: 86.66% // Decreases project coverage by -6.96% ⚠️

Coverage data is based on head (1473cec) compared to base (16c25c6).
Patch coverage: 88.10% of modified lines in pull request are covered.

❗ Current head 1473cec differs from pull request most recent head 76d70a4. Consider uploading reports for the commit 76d70a4 to get more accurate results

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #968      +/-   ##
==========================================
- Coverage   93.62%   86.66%   -6.97%     
==========================================
  Files           1       12      +11     
  Lines         204     1102     +898     
  Branches       29      211     +182     
==========================================
+ Hits          191      955     +764     
- Misses         13      147     +134     

Impacted Files	Coverage Δ
src/transform/response-object.ts	71.02% <71.02%> (ø)
src/transform/components-object.ts	80.97% <80.97%> (ø)
src/transform/header-object.ts	83.33% <83.33%> (ø)
src/transform/paths-object.ts	85.41% <85.41%> (ø)
src/utils.ts	80.93% <88.49%> (ø)
src/transform/schema-object.ts	92.38% <92.38%> (ø)
src/transform/path-item-object.ts	92.85% <92.85%> (ø)
src/transform/operation-object.ts	98.00% <98.00%> (ø)
src/transform/link-object.ts	100.00% <100.00%> (ø)
src/transform/media-type-object.ts	100.00% <100.00%> (ø)
... and 4 more

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report at Codecov.
📢 Do you have feedback about the report comment? Let us know in this issue.

[leppaott]

Just out of curiosity were those test/v3 files deleted deliberately? Made me think when I saw there were test/v2 files indeed deleted.

[drwpow]

v6 drops support for Swagger 2.0 so the v2 folder was dropped and v3 just became test. And the tests were cleaned up and deduplicated to be easier to manage (the refactor required they all had to change anyway).