Restricted API for helpers #1889
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
ijlee2
added
breaking
ijlee2
force-pushed
the
feature-restrict-helpers-api
branch
from
3994846
to
6f0f345
Compare
2 tasks
ijlee2
force-pushed
the
feature-restrict-helpers-api
branch
from
6f0f345
to
f8cda95
Compare
ijlee2
commented
May 20, 2024
Comment on lines
-20
to
-23
| assert( | ||
| 'To use `addTranslations()`, make sure to call `setupTest()`, `setupRenderingTest()`, or `setupApplicationTest()`.', | ||
| context, | ||
| ); |
There was a problem hiding this comment.
I decided to remove assert(), as it's unlikely that developers can run a test without setupTest(), setupRenderingTest(), or setupApplicationTest().
Note, the assert() had provided a more user-friendly error message.
ijlee2
commented
May 20, 2024
| Named?: Options & { allowEmpty?: boolean }; | ||
| Positional: [Value] | [Value, Options]; | ||
| Named?: Options; | ||
| Positional: [Value]; |
There was a problem hiding this comment.
Due to the use of inheritance (addon/helpers/-format-base.js), #1633 had accidentally increased the API of {{format-*}} helpers.
This was referenced May 20, 2024
Merged
Closed
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.
Why?
Closes #1735.
Before, the helpers had used the internal state
allowEmpty, the user preferenceoptions.allowEmpty, andisEmpty()from@ember/utils, to handle an input that isn't well-defined.isEmpty()had made maintenance especially difficult, because it returnstruefor many JavaScript values.Solution?
From now on, the
intlservice'sformat*()andt()methods form the source of truth. The helpers simply call these methods.