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 rules to use inclusive language #958

Merged
merged 4 commits into from Mar 2, 2024

Conversation

01taylop
Copy link
Contributor

As well as using inclusive language, this change aligns with similar improvements made in Stylelint: https://stylelint.io/CHANGELOG#1370.

  • at-import-partial-extension-whitelist -> at-import-partial-extension-allowed-list
  • at-import-partial-extension-blacklist -> at-import-partial-extension-disallowed-list

Resolves #571

As well as using inclusive language, this change aligns with similar
improvements made in Stylelint: https://stylelint.io/CHANGELOG#1370.

- `at-import-partial-extension-whitelist` -> `at-import-partial-extension-allowed-list`
- `at-import-partial-extension-blacklist` -> `at-import-partial-extension-disallowed-list`

Resolves stylelint-scss#571
@kristerkari
Copy link
Collaborator

Thanks @01taylop !

The changes look otherwise good, but the problem is that renaming a rule is a breaking change.

Instead of just renaming a rule, the correct way would be to first deprecate the rule and add the same rule with the new name to a minor release to give people time to migrate to the new name. Then after some time the old rules could be removed in a major release.

@kristerkari
Copy link
Collaborator

There's actually a quite "recent" example of deprecating a rule in this repo: #867

@01taylop
Copy link
Contributor Author

Thank you for the feedback @kristerkari ! I will checkout that PR and make the necessary changes to re-introduce the existing rules with a deprecation notice.

At least it was good to review the changes required to rename the rules :)

@01taylop
Copy link
Contributor Author

@kristerkari Just got back from a long-haul flight, but I think this iteration is what you hoping for?

@kristerkari
Copy link
Collaborator

Thanks! I'll try to get this re-review this weekend 👍

@kristerkari
Copy link
Collaborator

Sorry for the delay, but I'll review this tonight 👍

Copy link
Collaborator

@kristerkari kristerkari left a comment

Choose a reason for hiding this comment

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

Looks good 👍 Thanks!

@kristerkari kristerkari merged commit c85a034 into stylelint-scss:master Mar 2, 2024
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

Rename rules for blacklist and whitelist
2 participants