Skip to content

Update stylelint-polaris config to address out of memory issues #7954

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

Jump to bottom
Merged
merged 4 commits into from
Jan 3, 2023
Merged

Update stylelint-polaris config to address out of memory issues #7954

merged 4 commits into from
Jan 3, 2023

Conversation

@aaronccasanova
Copy link
Member

@aaronccasanova aaronccasanova commented Dec 19, 2022 •
edited
Loading

Note: The out of memory issue only occurs when using Stylelint programmatically to lint multiple repositories within the same process, such as on a coverage site. It does not occur when using Stylelint in a "regular" way, like running it from the CLI or within VS Code.

While moving from an array of string literal rule names to a regular expression pattern may result in a slight loss of accuracy, the consistent coverage rule naming conventions we have established should mitigate any potential issues.

@aaronccasanova
Copy link
Member Author

aaronccasanova commented Dec 19, 2022

/snapit

@aaronccasanova
Copy link
Member Author

aaronccasanova commented Dec 19, 2022

/snapit

@github-actions
Copy link
Contributor

github-actions bot commented Dec 19, 2022

🫰✨ 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/plugin-polaris@0.0.0-snapshot-release-20221219191640
yarn add @shopify/polaris-migrator@0.0.0-snapshot-release-20221219191640
yarn add @shopify/polaris@0.0.0-snapshot-release-20221219191640
yarn add @shopify/stylelint-polaris@0.0.0-snapshot-release-20221219191640

@github-actions
Copy link
Contributor

github-actions bot commented Dec 19, 2022

🫰✨ 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/plugin-polaris@0.0.0-snapshot-release-20221219192108
yarn add @shopify/polaris-migrator@0.0.0-snapshot-release-20221219192108
yarn add @shopify/polaris@0.0.0-snapshot-release-20221219192108
yarn add @shopify/stylelint-polaris@0.0.0-snapshot-release-20221219192108

aaronccasanova
aaronccasanova commented Jan 3, 2023
View reviewed changes
@aaronccasanova aaronccasanova changed the title Explore RegExp pattern for addressing out of memory issue Use RegExp pattern in stylelint-polaris config to address out of memory issues Jan 3, 2023
@aaronccasanova aaronccasanova changed the title Use RegExp pattern in stylelint-polaris config to address out of memory issues Update stylelint-polaris config to address out of memory issues Jan 3, 2023
@aaronccasanova aaronccasanova self-assigned this Jan 3, 2023
@aaronccasanova aaronccasanova marked this pull request as ready for review January 3, 2023 18:43
sophschneider
sophschneider approved these changes Jan 3, 2023
View reviewed changes
Copy link
Contributor

@sophschneider sophschneider left a comment

Choose a reason for hiding this comment

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

I'm curious why this fixes the memory issues but the change itself looks fine to me :)

@aaronccasanova
Copy link
Member Author

aaronccasanova commented Jan 3, 2023

Likewise! I explored the "why" a bit with memory and cpu profiles, but it started to become a time sink. Would be happy to revisit after unblocking the stylelint-polaris integration in the coverage site. However, I'm not sure how important it is to have exact rule names as Stylelint will still error for things like typos with the reportNeedlessDisables option.

@aaronccasanova aaronccasanova merged commit af0ceb8 into main Jan 3, 2023
@aaronccasanova aaronccasanova deleted the stylelint-out-of-memory branch January 3, 2023 22:08
@shopify-github-actions-access shopify-github-actions-access bot mentioned this pull request Jan 3, 2023
Merged
aveline pushed a commit that referenced this pull request Jan 4, 2023
@shopify-github-actions-access @github-actions
Version Packages (#7923)
359b8a2 
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/polaris@10.17.0

### Minor Changes

- [#7408](#7408)
[`7ffd87f7d`](7ffd87f)
Thanks [@laurkim](https://github.com/laurkim)! - - Refactored
`ChoiceList` to use primitive Layout components
    -   Added support for `legend` element to `Box`
    -   Added support for `fieldset` element to `AlphaStack`


- [#7978](#7978)
[`fb0ed3805`](fb0ed38)
Thanks [@kyledurand](https://github.com/kyledurand)! - Added
`printHidden` prop to `Box`


- [#7408](#7408)
[`7ffd87f7d`](7ffd87f)
Thanks [@laurkim](https://github.com/laurkim)! - Updated `Banner`
component to use new layout primitives


- [#7408](#7408)
[`7ffd87f7d`](7ffd87f)
Thanks [@laurkim](https://github.com/laurkim)! - Refactored `Modal` and
its children components to use layout primitives


- [#7963](#7963)
[`f94cf1496`](f94cf14)
Thanks [@aveline](https://github.com/aveline)! - Updated `AlphaStack`
docs for `align` prop


- [#7408](#7408)
[`7ffd87f7d`](7ffd87f)
Thanks [@laurkim](https://github.com/laurkim)! - Refactored
`AccountConnection` to use new layout primitives


- [#7915](#7915)
[`81fd3fd5b`](81fd3fd)
Thanks [@melaniedamilig](https://github.com/melaniedamilig)! - - Added
the `onAnimationEnd` prop to `Collapsible`
- Fixed a bug in `Filters` where focus was moved to collapsed filter
contents before the `Collapsible` animation ended


- [#7956](#7956)
[`30cdd2e23`](30cdd2e)
Thanks [@aveline](https://github.com/aveline)! - Updated `Box` allowable
aria roles


- [#7939](#7939)
[`8b31e3983`](8b31e39)
Thanks [@acidio](https://github.com/acidio)! - Added support for
`spacing` prop to List component allowing for a more compact list

### Patch Changes

- [#7925](#7925)
[`4e33e1ced`](4e33e1c)
Thanks [@jas7457](https://github.com/jas7457)! - Updated `IndexTable`
and `ProgressBar` to no longer log errors about deprecated
`React.findDOMNode`

## @shopify/plugin-polaris@0.0.23

### Patch Changes

- Updated dependencies
\[[`bfb537780`](bfb5377)]:
    -   @shopify/polaris-migrator@0.10.2

## @shopify/polaris-migrator@0.10.2

### Patch Changes

- [#7979](#7979)
[`bfb537780`](bfb5377)
Thanks [@samrose3](https://github.com/samrose3)! - Early exit if target
function isn't present for the scss-replace-duration and
scss-replace-easing migrations

- Updated dependencies
\[[`af0ceb8c6`](af0ceb8),
[`e7712e7a5`](e7712e7)]:
    -   @shopify/stylelint-polaris@5.0.2

## @shopify/stylelint-polaris@5.0.2

### Patch Changes

- [#7954](#7954)
[`af0ceb8c6`](af0ceb8)
Thanks [@aaronccasanova](https://github.com/aaronccasanova)! - Use
RegExp pattern to exclude reporting invalid scope disables and address
memory issues


- [#7919](#7919)
[`e7712e7a5`](e7712e7)
Thanks [@qt314](https://github.com/qt314)! - Deduped converage rules
that were in multiple categories

## polaris.shopify.com@0.28.0

### Minor Changes

- [#7963](#7963)
[`f94cf1496`](f94cf14)
Thanks [@aveline](https://github.com/aveline)! - Updated `AlphaStack`
docs for `align` prop

### Patch Changes

- [#7921](#7921)
[`502530597`](5025305)
Thanks [@martenbjork](https://github.com/martenbjork)! - Fixed border
radius of component images in the overview page.

- Updated dependencies
\[[`7ffd87f7d`](7ffd87f),
[`fb0ed3805`](fb0ed38),
[`7ffd87f7d`](7ffd87f),
[`7ffd87f7d`](7ffd87f),
[`f94cf1496`](f94cf14),
[`4e33e1ced`](4e33e1c),
[`7ffd87f7d`](7ffd87f),
[`81fd3fd5b`](81fd3fd),
[`30cdd2e23`](30cdd2e),
[`8b31e3983`](8b31e39)]:
    -   @shopify/polaris@10.17.0

Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
This was referenced Jan 6, 2023
Closed
Merged
@gwyneplaine gwyneplaine mentioned this pull request Feb 14, 2023
Merged
juzser pushed a commit to juzser/polaris that referenced this pull request Jul 27, 2023
@aaronccasanova @juzser
Update stylelint-polaris config to address out of memory issues (Sh…
fb01c81 
…opify#7954)
juzser pushed a commit to juzser/polaris that referenced this pull request Jul 27, 2023
@shopify-github-actions-access @github-actions @juzser
Version Packages (Shopify#7923)
db75de6 
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/polaris@10.17.0

### Minor Changes

- [Shopify#7408](Shopify#7408)
[`7ffd87f7d`](Shopify@7ffd87f)
Thanks [@laurkim](https://github.com/laurkim)! - - Refactored
`ChoiceList` to use primitive Layout components
    -   Added support for `legend` element to `Box`
    -   Added support for `fieldset` element to `AlphaStack`


- [Shopify#7978](Shopify#7978)
[`fb0ed3805`](Shopify@fb0ed38)
Thanks [@kyledurand](https://github.com/kyledurand)! - Added
`printHidden` prop to `Box`


- [Shopify#7408](Shopify#7408)
[`7ffd87f7d`](Shopify@7ffd87f)
Thanks [@laurkim](https://github.com/laurkim)! - Updated `Banner`
component to use new layout primitives


- [Shopify#7408](Shopify#7408)
[`7ffd87f7d`](Shopify@7ffd87f)
Thanks [@laurkim](https://github.com/laurkim)! - Refactored `Modal` and
its children components to use layout primitives


- [Shopify#7963](Shopify#7963)
[`f94cf1496`](Shopify@f94cf14)
Thanks [@aveline](https://github.com/aveline)! - Updated `AlphaStack`
docs for `align` prop


- [Shopify#7408](Shopify#7408)
[`7ffd87f7d`](Shopify@7ffd87f)
Thanks [@laurkim](https://github.com/laurkim)! - Refactored
`AccountConnection` to use new layout primitives


- [Shopify#7915](Shopify#7915)
[`81fd3fd5b`](Shopify@81fd3fd)
Thanks [@melaniedamilig](https://github.com/melaniedamilig)! - - Added
the `onAnimationEnd` prop to `Collapsible`
- Fixed a bug in `Filters` where focus was moved to collapsed filter
contents before the `Collapsible` animation ended


- [Shopify#7956](Shopify#7956)
[`30cdd2e23`](Shopify@30cdd2e)
Thanks [@aveline](https://github.com/aveline)! - Updated `Box` allowable
aria roles


- [Shopify#7939](Shopify#7939)
[`8b31e3983`](Shopify@8b31e39)
Thanks [@acidio](https://github.com/acidio)! - Added support for
`spacing` prop to List component allowing for a more compact list

### Patch Changes

- [Shopify#7925](Shopify#7925)
[`4e33e1ced`](Shopify@4e33e1c)
Thanks [@jas7457](https://github.com/jas7457)! - Updated `IndexTable`
and `ProgressBar` to no longer log errors about deprecated
`React.findDOMNode`

## @shopify/plugin-polaris@0.0.23

### Patch Changes

- Updated dependencies
\[[`bfb537780`](Shopify@bfb5377)]:
    -   @shopify/polaris-migrator@0.10.2

## @shopify/polaris-migrator@0.10.2

### Patch Changes

- [Shopify#7979](Shopify#7979)
[`bfb537780`](Shopify@bfb5377)
Thanks [@samrose3](https://github.com/samrose3)! - Early exit if target
function isn't present for the scss-replace-duration and
scss-replace-easing migrations

- Updated dependencies
\[[`af0ceb8c6`](Shopify@af0ceb8),
[`e7712e7a5`](Shopify@e7712e7)]:
    -   @shopify/stylelint-polaris@5.0.2

## @shopify/stylelint-polaris@5.0.2

### Patch Changes

- [Shopify#7954](Shopify#7954)
[`af0ceb8c6`](Shopify@af0ceb8)
Thanks [@aaronccasanova](https://github.com/aaronccasanova)! - Use
RegExp pattern to exclude reporting invalid scope disables and address
memory issues


- [Shopify#7919](Shopify#7919)
[`e7712e7a5`](Shopify@e7712e7)
Thanks [@qt314](https://github.com/qt314)! - Deduped converage rules
that were in multiple categories

## polaris.shopify.com@0.28.0

### Minor Changes

- [Shopify#7963](Shopify#7963)
[`f94cf1496`](Shopify@f94cf14)
Thanks [@aveline](https://github.com/aveline)! - Updated `AlphaStack`
docs for `align` prop

### Patch Changes

- [Shopify#7921](Shopify#7921)
[`502530597`](Shopify@5025305)
Thanks [@martenbjork](https://github.com/martenbjork)! - Fixed border
radius of component images in the overview page.

- Updated dependencies
\[[`7ffd87f7d`](Shopify@7ffd87f),
[`fb0ed3805`](Shopify@fb0ed38),
[`7ffd87f7d`](Shopify@7ffd87f),
[`7ffd87f7d`](Shopify@7ffd87f),
[`f94cf1496`](Shopify@f94cf14),
[`4e33e1ced`](Shopify@4e33e1c),
[`7ffd87f7d`](Shopify@7ffd87f),
[`81fd3fd5b`](Shopify@81fd3fd),
[`30cdd2e23`](Shopify@30cdd2e),
[`8b31e3983`](Shopify@8b31e39)]:
    -   @shopify/polaris@10.17.0

Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@sam-b-rose sam-b-rose sam-b-rose approved these changes

@sophschneider sophschneider sophschneider approved these changes

@chloerice chloerice Awaiting requested review from chloerice

Assignees

@aaronccasanova aaronccasanova

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@aaronccasanova @sam-b-rose @sophschneider