Administration: Correct the message shown when build files are unavailable - #13365
Administration: Correct the message shown when build files are unavailable#13365i-am-chitti wants to merge 1 commit into
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 Core Committers: Use this line as a base for the props when committing in SVN: To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook. |
Test using WordPress PlaygroundThe changes in this pull request can previewed and tested using a WordPress Playground instance. WordPress Playground is an experimental project that creates a full WordPress instance entirely within the browser. Some things to be aware of
For more details about these limitations and more, check out the Limitations page in the WordPress Playground documentation. |
| '<p>' . sprintf( | ||
| /* translators: %s: npm run build */ | ||
| __( 'The Font Library requires build files. Please run %s to build the necessary files.' ), | ||
| '<code>npm run build</code>' |
There was a problem hiding this comment.
On my development environment, npm run build isn't enough and I have to run also npm run dev. Given this is a message for developers, what about entirely removing the command to use and just provide a more generic message? Developers know what to do. Thoughts?
There was a problem hiding this comment.
Ah, good catch.
I looked at dropping the command and linking to docs instead, like src/index.php does. That doesn't work: the handbook page it links has nothing about building, and the other mentions are old make/core posts using the older grunt build --dev form. The one accurate source is this repo's README. We could link that on GitHub, but core has no precedent for it, every user-facing doc link goes to the handbook, so I would rather not introduce that here.
So, three options:
A. Name the command that fits a dev environment:
The Font Library requires build files. Please run
npm run build:devto build the necessary files.
A caveat that this assumes npm install has already run.
B. Drop the command, as you suggested:
The Font Library requires build files. Please build WordPress and try again.
C. Generic wording plus the handbook link:
The Font Library requires build files. Please build WordPress and try again. Learn more about setting up your local development environment.
Last sentence will be hyperlinked to a doc about build toolchain. Currently, there is none.
|
@i-am-chitti thanks for exploring all the options. Personally, I'd suggest to just drop the command and use a generic sentence, because:
|
Trac ticket: https://core.trac.wordpress.org/ticket/66022
The Font Library and Connectors screens tell the user to run
npm installwhen build files are missing. That was correct when 61492 added apostinstallhook that built the assets; 62321 removed it and the messages were never updated. The two strings are also inconsistent — one says "Gutenberg build files", the other "build files".Changes
npm install→npm run buildin both messages.sprintf()placeholder with a translators comment, persrc/index.php.Screenshots
Font Library
Connectors
Use of AI
AI assistance: Yes
Tool(s): Claude Code
Model(s): Sonnet 5
Used for: Go through changesets