Skip to content

[Layout foundations] Add documentation for react-rename-component codemod #8986

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 2 commits into from
Apr 17, 2023
Merged

[Layout foundations] Add documentation for react-rename-component codemod #8986

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ddd79ab
[Layout foundations] Add documentation for react-rename-component cod…
laurkim Apr 17, 2023
1901ca7
Add changeset
laurkim Apr 17, 2023
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/popular-papayas-breathe.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'polaris.shopify.com': minor
---

Added documentation for the `react-rename-component` codemod
19 changes: 19 additions & 0 deletions polaris.shopify.com/content/tools/polaris-migrator.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -691,6 +691,25 @@ npx @shopify/polaris-migrator styles-insert-stylelint-disable <path>

<br />

#### `react-rename-component`

A generic codemod to rename any component and its prop type.

```diff
- <MyComponent prop />
+ <MyRenamedComponent prop />
- export interface MyComponentPropType {}
+ export interface MyRenamedComponentPropType {}
```

<br />

```sh
npx @shopify/polaris-migrator react-rename-component <path> --renameFrom="MyComponent" --renameTo="MyRenamedComponent" --renamePropsFrom="MyComponentPropType" --renamePropsTo="MyRenamedComponentPropType"
```

<br />

#### `react-rename-component-prop`

A generic codemod to rename any component prop.
Expand Down