Strongly type all Quiz data types [refactor] #11992
Conversation
wackerow
requested review from
corwintines,
pettinarip,
minimalsm and
nhsz
as code owners
✅ Deploy Preview for ethereumorg ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
github-actions
bot
added
content 🖋️
There was a problem hiding this comment.
Looks good @wackerow good refactor. Left a couple of questions, thanks!
|
|
||
| export type QuestionBank = Record<string, RawQuestion> | ||
| export type QuestionKey = keyof typeof allQuestionData | ||
| export type AnswerKey = typeof allQuestionData[QuestionKey]["answers"][number]["id"] |
| @@ -887,6 +887,6 @@ const questionBank: QuestionBank = { | |||
| ], | |||
| correctAnswerId: "h005-b", | |||
| }, | |||
| } | |||
| } as const satisfies QuestionBank | |||
There was a problem hiding this comment.
Is there a benefit doing as const satisfies instead of just satisfies?
There was a problem hiding this comment.
I tried without, but had to add back as const (in this commit) after it wasn't casting the typeof as literals to perform keyof on... instead it was just simplified to string (IIRC)...
The other place satisfies is used didn't give me that problem, so I kept as const off of that one.
| quizKey || | ||
| Object.keys(allQuizzesData).filter((quizUri) => | ||
| window?.location.href.includes(quizUri) | ||
| )[0] || |
There was a problem hiding this comment.
I did a search and it seems that we always pass a quizKey, this default is never used. I'm ok with removing it if not used, but just curious about its original purpose, do you know it?
There was a problem hiding this comment.
I'm honestly not sure... but that was my same reasoning... there was no circumstance where the fallback would be used since a valid key is required.
There was a problem hiding this comment.
Thinking a little here, it may have simply been a product of not having proper typing, so any string could be used which may-or-may-not be available. This shouldn't be an issue now.
| const showConfetti = useMemo<boolean>( | ||
| () => !!quizData && showResults && isPassingScore, | ||
| [quizData, showResults, isPassingScore] | ||
| ) |
Description
interfaces totypes; migrate frominterfaces.tstotypes.tsQuizKey,QuestionKey, andAnswerKeytypesQuizKey,QuestionKey, andAnswerKeytypes: Implemented usingsatisfiesandkeyof typepattern to both quiz and question banks. Allows us to create these types based on the strings chosen in each data mapping (keyof typeofpattern), while maintaining type-checking for child object structure (usingsatisfies)