Lodash: Refactor away from _.escapeRegExp()
#43629
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
tyxla
added
[Type] Build Tooling
tyxla
requested review from
sgomes,
mirka,
aristath,
gziolo,
swissspidy,
ciampo,
jorgefilipecosta,
chad1008,
ntsekouras and
fabiankaegy
|
Size Change: +29 B (0%) Total Size: 1.24 MB
ℹ️ View Unchanged
|
ciampo
approved these changes
Aug 29, 2022
There was a problem hiding this comment.
Code changes LGTM 🚀
The only difference I can see with respect to the lodash function is that the lodash function will return '' if the original string is undefined, while the new version from this PR will just error.
Should we add that fallback too?
Good spot - however, I intentionally didn't add that fallback. First - I didn't notice the need for that, since we always had strings passed. If I was creating an exported utility function, maybe we would have handled that scenario, but I think it's unnecessary here. But most importantly - I believe handling unexpected types in combination with the untyped codebase makes it the ultimate hell for following through code and ensuring no bugs occur. By removing the extra ambiguity that the handling of the non-string values was adding, we solve part of the problem, and then we can hope to type the entire codebase to fully get rid of such cases. |
|
I agree with your views — was just flagging it for review completeness' sake :) Thank you! |
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.
What?
This PR removes the
_.escapeRegExp()usage completely and deprecates the function.Why?
Lodash is known to unnecessarily inflate the bundle size of packages, and in most cases, it can be replaced with native language functionality. See these for more information and rationale:
@wordpress/api-fetchpackage haslodashas a dependency #39495How?
Usages are just a few, so we're either creating a custom inline function that we reuse or directly running the replacement when it's more convenient to do it inline. It might feel repetitive to do this a few times throughout the codebase, but for a one-liner function, it's definitely better to do it that way rather than introducing yet another helper function into yet another dependency package.
Testing Instructions
npm run other:changelog