Output deprecation warning when use dollar prefix in global directive #183
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
yhatt
commented
Aug 11, 2019
| const globalKey = key.startsWith('$') ? key.slice(1) : key | ||
| const globalKey = key.startsWith('$') | ||
| ? (() => { | ||
| if (marpit.customDirectives.global[key]) return key |
There was a problem hiding this comment.
We use an original directive key without warning if the dollar-prefixed custom global directive was defined.
|
|
||
| for (const prop of Object.keys(newProps)) { | ||
| if (builtinDirectives[prop]) { | ||
| ret = { ...ret, ...builtinDirectives[prop](newProps[prop], marpit) } |
There was a problem hiding this comment.
When aliasing from custom directive to built-in directive, we will re-apply function of built-in directives to allow only valid value.
- Remove an example of global directive with dollar prefix - Add advanced section to explain about custom directives
yhatt
changed the title
|
A usage of custom directives was well-organized by the change of this PR. Thus, I've updated document of directives to explain about custom directives. |
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.
Marpit will output deprecation warning when using dollar-prefixed global directive. See also #182.
It would be hard to notice this warning if user is using GUI tool like Marp Web and Marp for VS Code. Marp CLI user can see this warning in console.
Prefix removal will do step by step to avoid confusion. We are planning to provide (optional) prefixed custom directives in Marp Core. We have to remove meta filter, to override built-in meta by using custom defined directive for Marp Core.
ToDo