-
Notifications
You must be signed in to change notification settings - Fork 776
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
fix: deprecate axe.commons.utils namespace #1330
Conversation
lib/commons/utils/index.js
Outdated
* @memberof axe.commons | ||
*/ | ||
|
||
var utils = (commons.utils = axe.utils); |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We need to keep this around. Removing this would be a breaking change.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
What would this break?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Commons are pseudo-public. They are used in custom rules which clients use. We have to be careful about changing commons.
test/commons/utils/index.js
Outdated
it('should be a function', function() { | ||
assert.isFunction(axe.commons.utils.clone); | ||
}); | ||
}); |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Same here, we don't want to make a breaking change. Just check that assert.equal(axe.utils, axe.commons.utils)
.
@WilcoFiers I don't understand why removing the aliased namespace would be a breaking change. From what I can tell, it's not part of any public API. Can you please clarify? |
This PR does the below:
axe.commons.utils
namespace toaxe.utils
Why?
var utils = (commons.utils = axe.utils);
Closes issue: NA
Reviewer checks
Required fields, to be filled out by PR reviewer(s)