Throw a clear error when a callback is passed as the first argument of configureImageRule()/configureFontRule()#1519
Open
Amoifr wants to merge 1 commit into
Open
Conversation
…f configureImageRule()/configureFontRule()
Amoifr
force-pushed
the
fix-1221-callback-as-first-arg
branch
from
July 17, 2026 08:42
98cf44b to
1e0cb73
Compare
stof
approved these changes
Jul 17, 2026
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
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.
configureImageRule()andconfigureFontRule()take(options, ruleCallback). When a callback is passed as the first argument, for example:the function lands in the
optionsparameter.Object.keys(aFunction)is empty, so no option validation fails, and the callback is silently dropped: the rule is never customized. This is a common mistake because several otherEncore.configure*()methods take a single callback.This PR turns that silent no-op into a helpful error pointing at the correct 2-argument form:
Only broken calls are affected (a function is never a valid
optionsvalue), so there is no BC impact on working code.This addresses the most surprising part of #1221 (the callback being ignored without any feedback). Note that overriding the filename does work today through the documented 2-argument callback by modifying the nested
rule.oneOf[1].generator; settingrule.generatorat the top level has no effect because Encore wraps the asset rule in aoneOf. Happy to follow up on that ergonomics point separately if you think it is worth improving.