stories: fix type loader signature and safety #104307
Conversation
github-actions
bot
added
the
Scope: Frontend
![sentry[bot]](https://avatars.githubusercontent.com/u/1396951?s=60&v=4){kind=small}
| declare module '!!type-loader!*' { | ||
| const TypeLoaderResult: { | ||
| props: Record<string, TypeLoader.ComponentDocWithFilename>; | ||
| exports: Record<string, {name: string; typeOnly: boolean}[]>; | ||
| }; | ||
| const TypeLoaderResult: | ||
| | { | ||
| props: Record<string, TypeLoader.ComponentDocWithFilename>; | ||
| exports: Record<string, {name: string; typeOnly: boolean}[]>; | ||
| } | ||
| // If the type loader is not enabled, the return value is an empty module | ||
| | undefined; | ||
|
|
||
| export default TypeLoaderResult; | ||
| } |
This comment was marked as outdated.
This comment was marked as outdated.
Sorry, something went wrong.
There was a problem hiding this comment.
I thought this was legit? The noopTypeLoader would bypass the check here and story.exports.documentation.props would be undefined. The typecasts are obscuring the runtime error.
There was a problem hiding this comment.
The noop loader returns an empty record, so you get Object.entries({}). The type is wonky because both are records, one just never has values. I used undefined because it is more restrictive as a proxy, so it forces you to handle the missing key, but it's an excessive check
natemoo-re
left a comment
natemoo-re
left a comment
There was a problem hiding this comment.
Looks good! I think the Seer bug might be legit though?
| declare module '!!type-loader!*' { | ||
| const TypeLoaderResult: { | ||
| props: Record<string, TypeLoader.ComponentDocWithFilename>; | ||
| exports: Record<string, {name: string; typeOnly: boolean}[]>; | ||
| }; | ||
| const TypeLoaderResult: | ||
| | { | ||
| props: Record<string, TypeLoader.ComponentDocWithFilename>; | ||
| exports: Record<string, {name: string; typeOnly: boolean}[]>; | ||
| } | ||
| // If the type loader is not enabled, the return value is an empty module | ||
| | undefined; | ||
|
|
||
| export default TypeLoaderResult; | ||
| } |
There was a problem hiding this comment.
I thought this was legit? The noopTypeLoader would bypass the check here and story.exports.documentation.props would be undefined. The typecasts are obscuring the runtime error.
| declare module '!!type-loader!*' { | ||
| const TypeLoaderResult: { | ||
| props: Record<string, TypeLoader.ComponentDocWithFilename>; | ||
| exports: Record<string, {name: string; typeOnly: boolean}[]>; | ||
| }; | ||
| const TypeLoaderResult: | ||
| | { | ||
| props: Record<string, TypeLoader.ComponentDocWithFilename>; | ||
| exports: Record<string, {name: string; typeOnly: boolean}[]>; | ||
| } | ||
| // If the type loader is not enabled, the return value is an empty module | ||
| | Record<string, undefined>; | ||
|
|
||
| export default TypeLoaderResult; | ||
| } |
This comment was marked as outdated.
This comment was marked as outdated.
Sorry, something went wrong.
Fixes the type loader signature and uses optional chaining to avoid attempting to access documentation values when the type loader is not enabled.
Fixes the type loader signature and uses optional chaining to avoid attempting to access documentation values when the type loader is not enabled.