New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Bugfix/fix for correctly generating additional properties, added types for typescript #18491
base: master
Are you sure you want to change the base?
Conversation
… itself for parent
…rator into bugfix/typescript-fix-for-correctly-set-parent-when-additional-properties-exist
…rator into bugfix/typescript-fix-for-correctly-set-parent-when-additional-properties-exist
…nown as known primitive in selializer
@@ -12,7 +12,7 @@ | |||
*/ | |||
export type {{classname}} = { | |||
{{#additionalPropertiesType}} | |||
[key: string]: {{{additionalPropertiesType}}}{{#hasVars}} | any{{/hasVars}}; | |||
[key: string]: {{{additionalPropertiesType}}}{{#hasVars}} | unknown{{/hasVars}}; |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I wonder if its a good idea to use unknown
instead of any
, since this probably breaks a lot of client code that accesses these values
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
From the typescript perspective (ECMA standarts etc) it is better to use unknown, as it is exactly describe its state/type, which is unknown and you must check/know the type of it. IMO it make the code more error-free/robust in runtime as you will be forced to check the type.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I can put it back to any but my linter and strict tsconfig settings do not like it, which is sign of not best typing.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Or maybe, make use of config switch supportsES6
that when it would be true, it would use unknown
instead of any
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
i would suggest to switch it back to any
, in order not to break existing use cases.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Consider using unknown
instead of any
here. The unknown
type is safer because it requires us to perform explicit type checking before performing any operations on the value. This approach enhances type safety by ensuring we explicitly handle the variable's type before using it, thereby reducing the risk of runtime errors. Using unknown
also improves code readability, as it clearly indicates that the type needs to be determined and handled carefully. This is especially beneficial in maintaining strict type safety practices across our TypeScript codebase.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
to avoid a breaking change, i.e. to preserve backwards compatibility, I would argue we should keep using any
and not change it to unknown
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I also think preserving backwards compatibility is really important. @mvarchdev , could you make the change so we can merge the fix?
Followup for PR #18164 - Optimising fix for additional properties. Added missing types in typescript. Updated tests for Java.
FYI: @TiFu (2017/07) @taxpon (2017/07) @sebastianhaas (2017/07) @kenisteward (2017/07) @Vrolijkx (2017/09) @macjohnny (2018/01) @topce (2018/10) @akehir (2019/07) @petejohansonxo (2019/11) @amakhrov (2020/02) @davidgamero (2022/03) @mkusaka (2022/04)
PR checklist
Commit all changed files.
This is important, as CI jobs will verify all generator outputs of your HEAD commit as it would merge with master.
These must match the expectations made by your contribution.
You may regenerate an individual generator by passing the relevant config(s) as an argument to the script, for example
./bin/generate-samples.sh bin/configs/java*
.IMPORTANT: Do NOT purge/delete any folders/files (e.g. tests) when regenerating the samples as manually written tests may be removed.
master
(upcoming 7.1.0 minor release - breaking changes with fallbacks),8.0.x
(breaking changes without fallbacks)