Skip to content

Add back needless disables to all stylelint comments #8657

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
Mar 14, 2023
Merged

Add back needless disables to all stylelint comments #8657

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
e179124
Update index.js
alex-page Mar 14, 2023
52b1675
Create fast-glasses-rhyme.md
alex-page Mar 14, 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/fast-glasses-rhyme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'@shopify/stylelint-polaris': major
---

Turn on reportNeedlessDisables for all comments
10 changes: 1 addition & 9 deletions stylelint-polaris/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -504,15 +504,7 @@ const stylelintPolarisCoverageOptions = {
module.exports = {
customSyntax: 'postcss-scss',
reportDescriptionlessDisables: true,
reportNeedlessDisables: [
true,
{
// Report needless disables for all rules except layout coverage rules
// Note: This doesn't affect the default Stylelint behavior/reporting
// and is only need because we dynamically create these rule names
except: ['all', /^polaris\/layout\/.+$/],
},
],
reportNeedlessDisables: true,
Copy link
Member Author

@alex-page alex-page Mar 14, 2023 •
edited
Loading

Choose a reason for hiding this comment

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

This shouldn't be an escape hatch for layout. Layout should not need comments at all.

Layout should be warnings. Warnings should not need a disable comment for CI to pass and ship.

reportInvalidScopeDisables: [
true,
{
Expand Down