Lodash: Refactor away from _.kebabCase() in generic template modal
#51910
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
tyxla
requested review from
Mamaduka,
sgomes,
aristath,
jsnajdr,
swissspidy,
flootr,
chad1008,
ntsekouras and
fabiankaegy
tyxla
commented
Jun 26, 2023
| @@ -1,7 +1,7 @@ | |||
| /** | |||
| * External dependencies | |||
| */ | |||
| import { kebabCase } from 'lodash'; | |||
| import { paramCase as kebabCase } from 'change-case'; | |||
There was a problem hiding this comment.
Alternatively, we could ditch the kebabCase() completely since passing a non-slugified title as a slug to the wp_insert_post() function will slugify it anyway.
There was a problem hiding this comment.
I actually suggested that approach for a similar kebabCase use case in #51911.
|
Size Change: -7 B (0%) Total Size: 1.44 MB
ℹ️ View Unchanged
|
tyxla
force-pushed
the
update/lodash-template-modal-kebabcase
branch
from
ce466ad
to
c937360
Compare
|
This is the last |
|
Flaky tests detected in c937360. 🔍 Workflow run URL: https://github.com/WordPress/gutenberg/actions/runs/5398908281
|
chad1008
approved these changes
Jun 28, 2023
sethrubenstein
pushed a commit
to pewresearch/gutenberg
that referenced
this pull request
Jul 13, 2023
…ordPress#51910) * Lodash: Refactor away from _.kebabCase() in generic template modal * Deprecate _.kebabCase()
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 Lodash's
_.kebabCase()from the generic template creation modal component.Since this is the last usage of
_.kebabCase(), we're also deprecating the function through ESLint.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 replacing the usage with
paramCasefrom thechange-casepackage, which we've already been utilizing for the general use cases. I think that's fine since a unique slug is being generated on the backend and used instead of the one generated on the client anyway:gutenberg/packages/edit-site/src/components/add-new-template/new-template.js
Lines 191 to 207 in 1464f18
plus, slugs with Unicode characters tend to be less readable anyway, so I personally see this as an improvement. For example, using
初島しじ下法ウ共旅もレあし重名どて暮園as the title would result in the template slug beingwp-custom-template-%25e5%2588%259d%25e5%25b3%25b6%25e3%2581%2597%25e3%2581%2598%25e4%25b8%258b%25e6%25b3%2595%25e3%2582%25a6%25e5%2585%25b1%25e6%2597%2585%25e3%2582%2582%25e3%2583%25ac%25e3%2581%2582%25e3%2581%2597%25e9%2587%258d%25e5%2590%258d%25e3%2581%25a9%25e3%2581%25a6%25e6%259a%25ae%25e5%259c%2592, which is quite terrible IMHO.Testing Instructions
/wp-admin/site-editor.php?path=%2Fwp_template