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

[stylelint-polaris] Fix custom property allowed list plugin #7877

Merged
merged 9 commits into from
Feb 17, 2023

Conversation

chloerice
Copy link
Member

@chloerice chloerice commented Dec 9, 2022

WHY are these changes introduced?

The polaris/custom-property-allowed-list plugin is currently reporting a single problem for what should be two different problems that can potentially exist in the same decl (--p-test: var(--p-unknown);):

  • one problem for definition of custom property name with disallowed prefix
    • --p-test: var(--p-space-1);
  • one problem for definition of custom property value with invalid Polaris token or private Polaris component token
    • color: var(--p-unknown);

WHAT is this pull request doing?

This PR:

  • Removes remnants of internal vs external configs
  • Reports problems with specific error messages for each of the two rule configuration options
  • Clarifies the intentions and configuration of the rule
  • Fixes the metadata URLs of custom rules

🎩 checklist

@chloerice chloerice force-pushed the fix-custom-property-allowed-list-plugin branch from 27a8b35 to cec64ab Compare December 9, 2022 19:49
@sam-b-rose sam-b-rose added the stylelint-polaris Related to the the @shopify/stylelint-polaris package label Dec 11, 2022
@sam-b-rose
Copy link
Member

@chloerice this seems to be outdated. Is this still an issue we should prioritize?

@chloerice chloerice force-pushed the fix-custom-property-allowed-list-plugin branch from cec64ab to 45b8fe6 Compare February 9, 2023 21:57
@chloerice chloerice marked this pull request as ready for review February 17, 2023 03:42
@chloerice chloerice merged commit 065df23 into main Feb 17, 2023
@chloerice chloerice deleted the fix-custom-property-allowed-list-plugin branch February 17, 2023 20:23
juzser pushed a commit to juzser/polaris that referenced this pull request Jul 27, 2023
…7877)

### WHY are these changes introduced?

The `polaris/custom-property-allowed-list` plugin is currently reporting
a single problem for what should be two different problems that can
potentially exist in the same decl (`--p-test: var(--p-unknown);`):
- one problem for definition of custom property name with disallowed
prefix
  - `--p-test: var(--p-space-1);`
- one problem for definition of custom property value with invalid
Polaris token or private Polaris component token
  - `color: var(--p-unknown);`

<!--
  Context about the problem that’s being addressed.
-->

### WHAT is this pull request doing?

This PR:
- Removes remnants of internal vs external configs
- Reports problems with specific error messages for each of the two rule
configuration options
- Clarifies the intentions and configuration of the rule
- Fixes the metadata URLs of custom rules

### 🎩 checklist

- [x] Tested in VS Code
(https://github.com/Shopify/polaris/blob/main/documentation/Tophatting%20documentation.md)
changes in the style guide
- [x] Tested in terminal
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
stylelint-polaris Related to the the @shopify/stylelint-polaris package
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants