Skip to content
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.

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

Rename react_material_ui to unify_ui #308

Conversation

sourcegraph-wk
Copy link

@sourcegraph-wk sourcegraph-wk commented Nov 2, 2024

The Unify team has renamed the react_material_ui Dart package to unify_ui 🎉

This migration is an effort to more clearly associate our Dart package with the Unify Design System that it houses. The two packages can be consumed side-by-side, but we intend to migrate all consumers to unify_ui and then stop releasing react_material_ui.

This PR migrates your repo to the new unify_ui package. See the migration guide for the full list of changes made by this sourcegraph batch.

Summary of Changes

Refer to the migration guide for full information on these changes, but there are a few specific changes to note:

  • Dependencies
    • Adds unify_ui and removes react_material_ui from dependencies
  • Entrypoints
    • Updates JS bundle references from react-material-ui to unify-ui
    • Updates imports from react_material_ui => unify_ui (a couple paths changed slightly as well)
    • Adds new unify_ui/components/wsd.dart entrypoint which separates out old WSD-related components and prop options that will eventually be deprecated.
    • Import namespaces were left alone to reduce diffs, but namespacing Unify entrypoints is no longer necessary unless the file contains WSD components.
  • Prop Objects
    • Replaces references to renamed prop objects (see list)
    • Button props: Updates wsd prefixed color options to come from components/wsd.dart entrypoint
  • Components
    • List: Renames MuiList => UnifyList
    • LinkButton: Replaces LinkButton => unify_wsd.WsdLinkButton
      • This component is residual from the WSD Button migration (ThemeProvider()..theme = wkTheme) and we don't currently have a use case for it within the Unify theme. If you have a Unify use case for LinkButton that cannot be resolved by using Link, please reach out to us in #unify-design-system-support.
    • Badge, LinearProgress, Alert: Adds FIXMEs to manually migrate and QA these components based on what ThemeProvider they are wrapped in. See the FIXME or migration guide for instructions.

QA Instructions

  • CI passes (there might be a couple edge cases to fix that the codemod didn't catch)
  • Make sure all FIXME(unify_package_rename) comments have been addressed and all usages of Alert, LinearProgress, and Badge have been manually QAed.
  • Ensure the new unify_ui dependency is at least as high as the react_material_ui version used to be at the time of merge

If these QA steps are done, feel free to merge without approval from the Unify team.

If you have any questions, please reach out to us in #unify-design-system-support!

Created by Sourcegraph batch change Workiva/unify_package_rename.

@sydneyjodon-wk
Copy link
Contributor

Going to close this because we might want to keep these test fixtures on RMUI for the time being to test the rename codemod

@sydneyjodon-wk sydneyjodon-wk deleted the batch/front_end_design/unify_package_rename_over_react_codemod branch November 8, 2024 16:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants