Lodash: Refactor away from _.sortBy()
#43479
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,
gziolo,
swissspidy,
ntsekouras and
fabiankaegy
tyxla
requested review from
ntwb,
nerrad,
ajitbohra,
draganescu,
talldan,
tellthemachines,
adamziel,
kevin940726 and
getdave
as code owners
|
Size Change: +165 B (0%) Total Size: 1.24 MB
ℹ️ View Unchanged
|
getdave
reviewed
Aug 22, 2022
sgomes
approved these changes
Aug 22, 2022
This was referenced Sep 2, 2022
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
_.sortBy()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?
We're using the native
Array.prototype.sort()function with some custom comparison functions which are pretty straightforward to write.In Lodash, this is one one of the useful functions, as it saves a little boilerplate necessary for the sorting, which is especially handy for multiple criteria. Here, we only have a single use for that, and refactoring it is pretty straightforward.
However, the function is also pretty complex, as it supports objects (which we don't need here and is confusing since it grabs an object and returns an array), and flattens the input collection, which we also don't need.
We can totally abstract this to a helper function, but given the usages here I just think it's not necessary.
Testing Instructions
npm run other:changelogand verify changelog is still built correctly. Specifically, verify the list of contributors is still sorted by the username alphabetically.@wordpress/babel-plugin-makepot- cc @swisspidy - what's a good way to test this one nowadays?