Skip to content

Add the (missing) case for migrating DisplayText to Text when size is not specified #7679

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.

Sign up for GitHub

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

Merged
merged 5 commits into from
Nov 9, 2022
Merged

Add the (missing) case for migrating DisplayText to Text when size is not specified #7679

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
024e610
consider that DisplayText's `size` attribute is optional
isaacbowen Nov 9, 2022
d40deb5
bump the cla check
isaacbowen Nov 9, 2022
4c47887
add a test case
isaacbowen Nov 9, 2022
788c3ae
changeset + patch version bump
isaacbowen Nov 9, 2022
5588079
Remove modified polaris-migrator/package.json
sam-b-rose Nov 9, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/twelve-turkeys-exist.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'@shopify/polaris-migrator': patch
---

Add the (missing) case for migrating DisplayText to Text when size is not specified
2 changes: 1 addition & 1 deletion polaris-migrator/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@shopify/polaris-migrator",
"version": "0.8.0",
"version": "0.8.1",
"description": "Codemod transformations to help upgrade your Polaris codebase",
"license": "SEE LICENSE IN LICENSE.md",
"author": "Shopify <[email protected]>",
Expand Down
7 changes: 7 additions & 0 deletions polaris-migrator/src/migrations/react-replace-text-components/steps/replace-display-text.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,8 @@ const displayTextSizeMap = {
extraLarge: 'heading4xl',
};

const defaultDisplayTextSize = 'medium';

/**
* Replace <DisplayText> with the <Text> component
*/
Expand Down Expand Up @@ -51,6 +53,11 @@ export function replaceDisplayText<NodeType = ASTNode>(

source.findJSXElements(localElementName).forEach((element) => {
replaceJSXElement(j, element, 'Text');

if (!hasJSXAttribute(j, element, 'size')) {
insertJSXAttribute(j, element, 'size', defaultDisplayTextSize);
}

replaceJSXAttributes(j, element, 'size', 'variant', displayTextSizeMap);

if (hasJSXAttribute(j, element, 'element')) {
Expand Down
1 change: 1 addition & 0 deletions ...rc/migrations/react-replace-text-components/tests/react-replace-text-components.input.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ export function App() {
<DisplayText size="extraLarge">Display text</DisplayText>
<DisplayText size="large">Display text</DisplayText>
<DisplayText size="medium">Display text</DisplayText>
<DisplayText>Display text</DisplayText>
<DisplayText size="small">Display text</DisplayText>
<Heading element="h1">Heading</Heading>
<Heading>Heading</Heading>
Expand Down
3 changes: 3 additions & 0 deletions ...c/migrations/react-replace-text-components/tests/react-replace-text-components.output.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,9 @@ export function App() {
<Text variant="headingXl" as="p">
Display text
</Text>
<Text variant="headingXl" as="p">
Display text
</Text>
<Text variant="headingLg" as="p">
Display text
</Text>
Expand Down