Update @tannin/sprintf to resolve CommonJS error#70799
Merged
Merged
Conversation
|
The following accounts have interacted with this PR and/or linked issues. I will continue to update these lists as activity occurs. You can also manually ask me to refresh this list by adding the If you're merging code through a pull request on GitHub, copy and paste the following into the bottom of the merge commit message. To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook. |
aduth
added
[Type] Bug
aduth
commented
Jul 19, 2025
Member
Author
There was a problem hiding this comment.
There are more changes here than I would have expected. Running npm install on trunk resulted in the changes not related to @tannin/sprintf. I'm using the latest version of NPM (v11.4.2).
Member
There was a problem hiding this comment.
I've noticed the lockfile seems out of date on trunk lately, npm ci frequently fails. It would be nice if the unrelated changes were pulled out into their own PR to update the lockfile.
|
Size Change: 0 B Total Size: 1.89 MB ℹ️ View Unchanged
|
|
Flaky tests detected in cf10792. 🔍 Workflow run URL: https://github.com/WordPress/gutenberg/actions/runs/16391077100
|
Member
Author
|
The lint error is likely due to the removal of the This is related to lack of support for There are a few ways to resolve this:
|
Member
Author
There's at least one instance we have already: gutenberg/packages/vips/src/index.ts Lines 7 to 8 in 362e12d |
Member
Author
|
I pushed the quick fix of disabling the rule via code comment, with an explanation. I think the better long-term solution is to use |
sirreal
approved these changes
Jul 22, 2025
Member
sirreal
left a comment
sirreal
left a comment
There was a problem hiding this comment.
I'd prefer to have the lockfile update in its own PR, but these changes seem fine.
If you do extract those changes to another PR, I'll give both a priority review.
Member
There was a problem hiding this comment.
I've noticed the lockfile seems out of date on trunk lately, npm ci frequently fails. It would be nice if the unrelated changes were pulled out into their own PR to update the lockfile.
Member
Author
Sure. Extracted to #70839 . I'll rebase this one when that's merged. |
Contributor
|
hi @aduth, I found another issue related to typings that being exported in If the type is imported in a typescript file it works as expected but when the gutenberg builds the i18n package the type.d.ts fails to find declaration hence the typings fails. Adding this fixes the issue "exports": {
".": {
"import": "./src/index.js",
"require": "./build/index.js",
"types": "./src/index.d.ts"
},
"./types": {
"types": "./types/index.d.ts",
"default": "./types/index.d.ts"
}
},
"types": "./src/index.d.ts"Screenshotstypes.ts
types.d.ts
|
Member
Author
|
That's a good catch @USERSATOSHI . Personally I wouldn't expect that we should need a separate Alternatively, I wonder if there's a way Gutenberg could avoid relying on the internal type and use |
Contributor
Yeah made it work with Thank you. Updated typeexport type DistributeSprintfArgs< T extends string > = T extends any
? Parameters< typeof sprintf< T > >[ 1 ]
: never; |
aduth
force-pushed
the
aduth-update-sprintf
branch
from
288b8ea to
045bab4
Compare
Member
Author
|
Rebased after merging #70839. The changes are much more reasonable now! |
USERSATOSHI
pushed a commit
to USERSATOSHI/gutenberg
that referenced
this pull request
Jul 23, 2025
* Update tannin sprintf to resolve CommonJS error * Disable lint error
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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?
Updates
@tannin/sprintfdependency from v1.3.0 to v1.3.1 to incorporate a bug fix which causes errors when importing the module in CommonJS contexts in the current version.See: aduth/tannin#20
Changelog: https://github.com/aduth/tannin/blob/master/packages/sprintf/CHANGELOG.md#131-2025-07-19
Full diff: https://my.diffend.io/npm/@tannin/sprintf/1.3.0/1.3.1
Follow-up to #70434
Why?
Fixes an error when importing any Gutenberg package that depends on
@tannin/sprintf, if imported in a CommonJS project.Example: Automattic/jetpack#44376 (comment)
How?
See changes in aduth/tannin@ee0b6ff
The root of the issue is that because the package is marked as ESM (
"type": "module") and the CommonJS build uses the.jsfile, it is interpreted as ESM, rather than as CommonJS. This is addressed by renaming the built output as.cjsinstead of.js.Testing Instructions
Repeat Testing Instructions from #70434