Skip Schema prefix trimmin if --enum is used with --root-types-no-schema-prefix #2206
Conversation
❌ Deploy Preview for openapi-ts failed.
|
|
sultaniman
force-pushed
the
sultaniman/fix/skip-schema-trim-when-enum
branch
from
ba8e5ef to
31054dc
Compare
gzm0
left a comment
gzm0
left a comment
There was a problem hiding this comment.
Nice! Some comments about behavior / comments. The code itself looks great!
|
Thanks for taking a look at this, I will address your comments. |
sultaniman
force-pushed
the
sultaniman/fix/skip-schema-trim-when-enum
branch
2 times, most recently
from
91394c2 to
cf6d0a1
Compare
sultaniman
force-pushed
the
sultaniman/fix/skip-schema-trim-when-enum
branch
from
cf6d0a1 to
3392361
Compare
There was a problem hiding this comment.
Thanks for taking the time to fix this @sultaniman!
Please see my suggestion
| // Skipping --root-types generation only for enums if --enum is set | ||
| // while still applying --root-types-no-schema-prefix to other types. | ||
| if (!(ctx.enum && item.enum !== undefined)) { | ||
| aliasName = aliasName.replace(componentKey, ""); | ||
| } |
There was a problem hiding this comment.
@sultaniman While this fixes the issue, it introduces an inconsistency in the generated types. Everything else will have the Schema prefix removed, but for enums, we’ll end up with both EnumName (the enum itself) and an unnecessary SchemaEnumName.
Since EnumName already serves as both a value and a TypeScript type due to the nature of enums, SchemaEnumName seems redundant. Wouldn't it make more sense to omit the root type for enums entirely when --root-types-no-schema-prefix is used? (That was my suggestion in the original PR.)
There was a problem hiding this comment.
@sultaniman did you have a chance to look at this?
|
Regarding the flag consistency, @duncanbeevers do you think you could take a look here? I think you have much more knowledge of how this is done right now. |
3 participants
Changes
This PR is a follow up to #1958 and as a result disables
--root-types-no-schema-prefixwhen--enumflag passed.More on why this is necessary: #1958 (comment)
How to Review
Check out the mentioned PR and review this one.
Checklist
docs/updated (if necessary)pnpm run update:examplesrun (only applicable for openapi-typescript)