test: add getRenderFn utility
#1819
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ze-flo
commented
May 31, 2024
utils/test/garden-test-utils.tsx
Outdated
|
|
||
| const MODE_TO_RENDER_FN_MAP = { | ||
| dark: customDarkRender, | ||
| light: customRender |
Contributor
Author
There was a problem hiding this comment.
Using a map to better scale as we introduce more modes in the future.
utils/test/garden-test-utils.tsx
Outdated
| * @param mode {string} The color mode. | ||
| * @returns {Function} Render function associated with the mode. | ||
| */ | ||
| export function getRenderFn(mode: string) { |
Contributor
Author
There was a problem hiding this comment.
mode is loosely typed to avoid having to explicitly define the type for mode in tests.
With strict mode type 🙅
it.each<['light' | 'dark', string]>([
['light', PALETTE.grey[700]],
['dark', PALETTE.grey[500]]
])('applies the default colors in "%s mode', (mode, color) => {
const { container } = getRenderFn(mode)(<Component ... />);
...
})With loose mode type 🚀
Less verbose and replies on type inferences. ✅
it.each([
['light', PALETTE.grey[700]],
['dark', PALETTE.grey[500]]
])('applies the default colors in "%s mode', (mode, color) => {
const { container } = getRenderFn(mode)(<Component ... />);
...
})
7 tasks
jzempel
reviewed
Jun 3, 2024
utils/test/garden-test-utils.tsx
Outdated
| * @param mode {string} The color mode. | ||
| * @returns {Function} Render function associated with the mode. | ||
| */ | ||
| export function getRenderFn(mode: string) { |
Member
There was a problem hiding this comment.
Should renderRtl also be incorporated in this convenience function? Perhaps a getRenderFn({ mode, rtl }: { string, boolean }) type signature 🤷
Contributor
Author
There was a problem hiding this comment.
Good idea! 🔥
jzempel
approved these changes
Jun 3, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Adds a small utility fn to
garden-test-utilsto simplify testing across color modes.getRenderFnreturns the correctrenderfn for themode.Detail
getRenderFnaims to reduce boilerplate code when testing colors in multiple modes usingit.each().See this comment.