fix: deprecate axe.commons.utils namespace #1330
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
stephenmathieson
previously approved these changes
Jan 23, 2019
WilcoFiers
previously requested changes
Jan 24, 2019
lib/commons/utils/index.js
Outdated
| * @memberof axe.commons | ||
| */ | ||
|
|
||
| var utils = (commons.utils = axe.utils); |
There was a problem hiding this comment.
We need to keep this around. Removing this would be a breaking change.
There was a problem hiding this comment.
What would this break?
There was a problem hiding this comment.
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.
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? |
WilcoFiers
approved these changes
Jan 25, 2019
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR does the below:
axe.commons.utilsnamespace toaxe.utilsWhy?
var utils = (commons.utils = axe.utils);Closes issue: NA
Reviewer checks
Required fields, to be filled out by PR reviewer(s)