Skip to content

Conversation

@lgriffee
Copy link
Contributor

@lgriffee lgriffee commented Sep 22, 2022

WHY are these changes introduced?

Part of #7212

WHAT is this pull request doing?

Adding a replace-sass-lengths migration script.

Running npx @shopify/polaris-migrator replace-sass-lengths "**/*.scss" will target the following padding and margin properties and replace any px, rem or rem() values that align with our spacing tokens.

  • padding
  • padding-top
  • padding-right
  • padding-bottom
  • padding-left
  • padding-inline
  • padding-inline-start
  • padding-inline-end
  • padding-block
  • padding-block-start
  • padding-block-end
  • margin
  • margin-top
  • margin-right
  • margin-bottom
  • margin-left
  • margin-inline
  • margin-inline-start
  • margin-inline-end
  • margin-block
  • margin-block-start
  • margin-block-end

@lgriffee
Copy link
Contributor Author

/snapit

@github-actions
Copy link
Contributor

🫰✨ Thanks @lgriffee! Your snapshots have been published to npm.

Test the snapshots by updating your package.json with the newly published versions:

yarn add @shopify/[email protected]
yarn add @shopify/[email protected]
yarn add @shopify/[email protected]
yarn add @shopify/[email protected]

@lgriffee lgriffee self-assigned this Sep 22, 2022
@lgriffee
Copy link
Contributor Author

/snapit

@github-actions
Copy link
Contributor

🫰✨ Thanks @lgriffee! Your snapshots have been published to npm.

Test the snapshots by updating your package.json with the newly published versions:

yarn add @shopify/[email protected]
yarn add @shopify/[email protected]

lgriffee and others added 3 commits September 26, 2022 12:06
Co-Authored-By: Aaron Casanova <[email protected]>
Co-Authored-By: Aaron Casanova <[email protected]>
@lgriffee
Copy link
Contributor Author

/snapit

@github-actions
Copy link
Contributor

🫰✨ Thanks @lgriffee! Your snapshots have been published to npm.

Test the snapshots by updating your package.json with the newly published versions:

yarn add @shopify/[email protected]
yarn add @shopify/[email protected]

@lgriffee lgriffee changed the title Replace sass padding Replace sass padding and margin Sep 27, 2022
@lgriffee lgriffee marked this pull request as ready for review September 27, 2022 17:08
@lgriffee lgriffee changed the title Replace sass padding and margin Migrate sass padding and margin length values Sep 27, 2022
@lgriffee lgriffee changed the title Migrate sass padding and margin length values Add migration for sass padding and margin length values Sep 27, 2022
Copy link
Member

@sam-b-rose sam-b-rose left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice, migration is looking great! I like the more generic approach of replace-sass-lengths rather than just replace-sass-padding. Just a few comments and "thank yous" in the review 👍

@lgriffee lgriffee requested a review from chloerice September 27, 2022 20:46
@aaronccasanova
Copy link
Member

/snapit

@github-actions
Copy link
Contributor

🫰✨ Thanks @aaronccasanova! Your snapshots have been published to npm.

Test the snapshots by updating your package.json with the newly published versions:

yarn add @shopify/[email protected]
yarn add @shopify/[email protected]

Copy link
Member

@sam-b-rose sam-b-rose left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks 💯 the migration PR in web is excellent, what a refactor! 👏

@lgriffee lgriffee merged commit 5a1f45f into main Sep 30, 2022
@lgriffee lgriffee deleted the replace-sass-padding branch September 30, 2022 15:53
@github-actions github-actions bot mentioned this pull request Sep 30, 2022
@itwasmattgregg
Copy link
Contributor

Why was it decided to replace 0 with var(--p-space-0)?

mattkubej pushed a commit that referenced this pull request Oct 5, 2022
This PR was opened by the [Changesets
release](https://github.com/changesets/action) GitHub action. When
you're ready to do a release, you can merge this and the packages will
be published to npm automatically. If you're not ready to do a release
yet, that's fine, whenever you add more changesets to main, this PR will
be updated.


# Releases
## @shopify/[email protected]

### Minor Changes

- [#7264](#7264)
[`5a1f45f7a`](5a1f45f)
Thanks [@lgriffee](https://github.com/lgriffee)! - Add sass padding and
margin migration

### Patch Changes

- [#7315](#7315)
[`c958899c7`](c958899)
Thanks [@lgriffee](https://github.com/lgriffee)! - Remove `0` and `0px`
length values from `replace-sass-lengths` migration

- Updated dependencies
\[[`0be40aa94`](0be40aa)]:
    -   @shopify/[email protected]

## @shopify/[email protected]

### Minor Changes

- [#7056](#7056)
[`0be40aa94`](0be40aa)
Thanks [@laurkim](https://github.com/laurkim)! - Added alpha `Inline`
component


- [#7056](#7056)
[`0be40aa94`](0be40aa)
Thanks [@laurkim](https://github.com/laurkim)! - Added `AlphaStack`
component


- [#7056](#7056)
[`0be40aa94`](0be40aa)
Thanks [@laurkim](https://github.com/laurkim)! - Added `Columns`
component


- [#7056](#7056)
[`0be40aa94`](0be40aa)
Thanks [@laurkim](https://github.com/laurkim)! - Added `Box` component


- [#7056](#7056)
[`0be40aa94`](0be40aa)
Thanks [@laurkim](https://github.com/laurkim)! - Added `AlphaCard`
component


- [#7056](#7056)
[`0be40aa94`](0be40aa)
Thanks [@laurkim](https://github.com/laurkim)! - Added `fullWidth` prop
to `AlphaStack` and updated styleguide docs


- [#7056](#7056)
[`0be40aa94`](0be40aa)
Thanks [@laurkim](https://github.com/laurkim)! - Added alpha
`ContentBlock` component

### Patch Changes

- [#7056](#7056)
[`0be40aa94`](0be40aa)
Thanks [@laurkim](https://github.com/laurkim)! - Updated `AlphaCard`
border radius to a boolean


- [#7056](#7056)
[`0be40aa94`](0be40aa)
Thanks [@laurkim](https://github.com/laurkim)! - Renamed `Columns`
spacing


- [#7056](#7056)
[`0be40aa94`](0be40aa)
Thanks [@laurkim](https://github.com/laurkim)! - Renamed `background`
prop on `AlphaCard` for consistency


- [#7056](#7056)
[`0be40aa94`](0be40aa)
Thanks [@laurkim](https://github.com/laurkim)! - Rename `Tiles`
component


- [#7056](#7056)
[`0be40aa94`](0be40aa)
Thanks [@laurkim](https://github.com/laurkim)! - Renamed `AlphaCard`
`shadow` prop


- [#7056](#7056)
[`0be40aa94`](0be40aa)
Thanks [@laurkim](https://github.com/laurkim)! - Refactored token types
in primitive Layout components
    Exposed `DepthShadowAlias` type


- [#7291](#7291)
[`3941f5281`](3941f52)
Thanks [@atesgoral](https://github.com/atesgoral)! - Improve default
style class selection of `Avatar` by using the entire name instead of
just the first letter


- [#7332](#7332)
[`2ee5c5d74`](2ee5c5d)
Thanks [@mattkubej](https://github.com/mattkubej)! - `PopoverOverlay`
closes focused `Popover` when pressing `Escape`

- Updated dependencies
\[[`0be40aa94`](0be40aa)]:
    -   @shopify/[email protected]

## @shopify/[email protected]

### Minor Changes

- [#7056](#7056)
[`0be40aa94`](0be40aa)
Thanks [@laurkim](https://github.com/laurkim)! - Refactored token types
in primitive Layout components
    Exposed `DepthShadowAlias` type

## @shopify/[email protected]

### Patch Changes

- Updated dependencies
\[[`5a1f45f7a`](5a1f45f),
[`c958899c7`](c958899)]:
    -   @shopify/[email protected]

## @shopify/[email protected]

### Patch Changes

- Updated dependencies
\[[`0be40aa94`](0be40aa)]:
    -   @shopify/[email protected]

## [email protected]

### Minor Changes

- [#7056](#7056)
[`0be40aa94`](0be40aa)
Thanks [@laurkim](https://github.com/laurkim)! - Added alpha pages for
`AlphaStack`, `Box`, `Columns`, `Inline`, and `Tile` components. Updated
`StatusBanner` to capitalize status value.


- [#7353](#7353)
[`558b1cfae`](558b1cf)
Thanks [@kyledurand](https://github.com/kyledurand)! - Ported
codesandbox init code to React 18


- [#7056](#7056)
[`0be40aa94`](0be40aa)
Thanks [@laurkim](https://github.com/laurkim)! - Added alpha page for
`ContentBlock`

### Patch Changes

- [#7056](#7056)
[`0be40aa94`](0be40aa)
Thanks [@laurkim](https://github.com/laurkim)! - Updated `AlphaCard`
border radius to a boolean


- [#7056](#7056)
[`0be40aa94`](0be40aa)
Thanks [@laurkim](https://github.com/laurkim)! - Renamed `Columns`
spacing


- [#7056](#7056)
[`0be40aa94`](0be40aa)
Thanks [@laurkim](https://github.com/laurkim)! - Renamed `background`
prop on `AlphaCard` for consistency


- [#7056](#7056)
[`0be40aa94`](0be40aa)
Thanks [@laurkim](https://github.com/laurkim)! - Rename `Tiles`
component


- [#7312](#7312)
[`2349db304`](2349db3)
Thanks [@martenbjork](https://github.com/martenbjork)! - Added a
redirect pointing to the Polaris license on Github


- [#7343](#7343)
[`7ced95bfb`](7ced95b)
Thanks [@laurkim](https://github.com/laurkim)! - Updated alpha `Box`
page to remove sentence regarding usage in existing components


- [#7056](#7056)
[`0be40aa94`](0be40aa)
Thanks [@laurkim](https://github.com/laurkim)! - Renamed `AlphaCard`
`shadow` prop


- [#7056](#7056)
[`0be40aa94`](0be40aa)
Thanks [@laurkim](https://github.com/laurkim)! - Added `fullWidth` prop
to `AlphaStack` and updated styleguide docs


- [#7311](#7311)
[`fc05e3152`](fc05e31)
Thanks [@martenbjork](https://github.com/martenbjork)! - Improved the
layout on mobile

- Updated dependencies
\[[`0be40aa94`](0be40aa),
[`0be40aa94`](0be40aa),
[`0be40aa94`](0be40aa),
[`0be40aa94`](0be40aa),
[`0be40aa94`](0be40aa),
[`0be40aa94`](0be40aa),
[`0be40aa94`](0be40aa),
[`0be40aa94`](0be40aa),
[`0be40aa94`](0be40aa),
[`0be40aa94`](0be40aa),
[`0be40aa94`](0be40aa),
[`0be40aa94`](0be40aa),
[`0be40aa94`](0be40aa),
[`3941f5281`](3941f52),
[`2ee5c5d74`](2ee5c5d)]:
    -   @shopify/[email protected]
    -   @shopify/[email protected]

## [email protected]

### Patch Changes

- Updated dependencies
\[[`0be40aa94`](0be40aa),
[`0be40aa94`](0be40aa),
[`0be40aa94`](0be40aa),
[`0be40aa94`](0be40aa),
[`0be40aa94`](0be40aa),
[`0be40aa94`](0be40aa),
[`0be40aa94`](0be40aa),
[`0be40aa94`](0be40aa),
[`0be40aa94`](0be40aa),
[`0be40aa94`](0be40aa),
[`0be40aa94`](0be40aa),
[`0be40aa94`](0be40aa),
[`0be40aa94`](0be40aa),
[`3941f5281`](3941f52),
[`2ee5c5d74`](2ee5c5d)]:
    -   @shopify/[email protected]

Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
@jesstelford
Copy link
Contributor

@itwasmattgregg That's a fantastic question, and one which sparked a Discussion culminating in our decision to stick with literal 0 instead of --p-space-0!

That simplification will come in future migrations 👍

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants