-
Notifications
You must be signed in to change notification settings - Fork 3.2k
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 uses of term 'whitelist' #7782
Conversation
Thanks for taking the time to open a PR!
|
Test summaryRun details
View run in Cypress Dashboard ➡️ This comment has been generated by cypress-bot as a result of this project's GitHub integration settings. You can manage this integration in this project's settings in the Cypress Dashboard |
…N branch consistently
f2b0cea
to
55e8297
Compare
This comment has been minimized.
This comment has been minimized.
@Saibamen This was an unanimous decision by our team to implement in this way and goes along with many other breaking changes as part of 5.0.0 release. Please also keep in mind our code of conduct when commenting within our GitHub repo. Thank you. |
renamed 'whitelist' option to 'preserve' in README according to cypress-io/cypress#7782
renamed 'whitelist' option to 'preserve' in README according to cypress-io/cypress#7782
User facing changelog
Cypress.Cookies.defaults()
whitelist
option has been renamed topreserve
to more closely reflect its behavior.cy.server()
whitelist
option has been renamed toignore
to more closely reflect its behavior.Additional details
whitelist
in user-facing APIs, code, and tests.whitelist
typically means. I think this will be more explicit upfront about what the keys function is rather than a genericwhitelist
orallow
key.whitelist
.How has the user experience changed?
cy.server()
An error will now throw when defining
whitelist
function oncy.server()
.An error will now throw when defining
whitelist
option onCypress.Cookies.default()
.This change makes it more inclusive by replacing terms that can be perceived as offensive to more self-explanatory names (blacklist/whitelist can reinforce the association of black as bad and white as good).
Examples of projects that already made the change:
Rails
Golang
Graphite Web
HTML
PR Tasks
cypress-documentation
? Rename uses of whitelist for renamed options. cypress-documentation#2928cypress-example-kitchensink
? 5.0.0 Release cypress-example-kitchensink#430cypress.schema.json
?