Update @embroider/macros examples in the readme #554
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
simonihmig
reviewed
Sep 26, 2020
|
|
||
| ### getOwnConfig, getConfig, and getGlobalConfig | ||
|
|
||
| A common pattern is to have a set of configuration properties that you define (or a consumer defines for you) which you base certain build time conditions around. This is achieved via the `getOwnConfig`, `getConfig`, and `getGlobalConfig` macros (depending on which config you want to read). |
There was a problem hiding this comment.
Should we explain those in a bit more detail? Like getGlobalConfig was new to me, and not mentioned in the RFC, so it's not obvious what a global config is.
Co-authored-by: Simon Ihmig <ihmig@kaliber5.de>
acorncom
reviewed
Oct 1, 2020
| @@ -8,61 +8,180 @@ Traditionally, Ember addons have a lot of power to run arbitrary code during the | |||
|
|
|||
| The [Embroider package spec](../../SPEC.md) proposes fixing this by making Ember addons much more static. But they will still need the ability to change themselves in certain ways at app compilation time. Hence this package. | |||
|
|
|||
| This package works in both Embroider builds and normal ember-cli builds, so that addon authors can switch to this newer pattern without disruption. | |||
| This package works in both Embroider and Classical builds, so that addon authors can switch to this newer pattern without disruption. | |||
There was a problem hiding this comment.
Might read more consistently across the ecosystem to call these Classic builds?
|
|
||
| ## The Macros | ||
|
|
||
| ### macroCondition | ||
|
|
||
| The `macroCondition` macro allows branch level code isolation (and deletion in the case of production builds). Generally macroConditions are viewed as a foundation macro and are combined with others marcos (detailed below) to create more complex scenarios. `macroCondition` takes a single argument which must be statically known or another macro which will compile down to a static value. |
There was a problem hiding this comment.
combined with other macros
rwjblue
approved these changes
Oct 21, 2020
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.
Not the full list of macros but a first pass on the big ones