-
Notifications
You must be signed in to change notification settings - Fork 4.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
Lodash: Refactor away from _.snakeCase()
#42427
Merged
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] Performance
Related to performance efforts
[Type] Code Quality
Issues or PRs that relate to code quality
[Tool] E2E Test Utils
/packages/e2e-test-utils
[Tool] Create Block
/packages/create-block
labels
Jul 14, 2022
tyxla
requested review from
aristath,
swissspidy,
chad1008,
andrewserong,
ntsekouras and
fabiankaegy
July 14, 2022 11:53
tyxla
requested review from
ntwb,
nerrad,
ajitbohra,
gziolo and
ryanwelcher
as code owners
July 14, 2022 11:53
tyxla
force-pushed
the
refactor/lodash-snake-case
branch
from
July 14, 2022 11:57
191a717
to
6688587
Compare
Size Change: 0 B Total Size: 1.25 MB ℹ️ View Unchanged
|
jorgefilipecosta
approved these changes
Jul 14, 2022
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.
LGTM 👍
This was referenced Jul 15, 2022
This was referenced Aug 15, 2022
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Labels
[Tool] Create Block
/packages/create-block
[Tool] E2E Test Utils
/packages/e2e-test-utils
[Type] Code Quality
Issues or PRs that relate to code quality
[Type] Performance
Related to performance efforts
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
_.snakeCase()
usage completely and deprecates the function. It also uses the opportunity to remove a couple other Lodash usages in the same files.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-fetch
package haslodash
as a dependency #39495How?
We're suggesting to use the
change-case
library, which offers modular functions for all the casing functions we use from Lodash (likesnakeCase
,capitalize
,startCase
,camelCase
,kebabCase
), at a small price (the methods are small themselves), and has TS support. The benefit of using that external library for all those case conversion functions is that we won't have to maintain our own versions of them, and those are already broadly used and tested.In particular, we replace the couple of
snakeCase()
Lodash usages in favor of thechange-case
ones, and we replace a siblingcamelCase
use with thechange-case
method. Furthermore, we replace theupperFirst
with a custom implementation, because it's simple enough (a short one-liner).Testing Instructions
npx @wordpress/create-block test-block
still works well.