feat(formats): adding custom file headers #572
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
Closed
chazzmoney
reviewed
Mar 18, 2021
|
|
||
| const myCustomFormat = ({ dictionary, file }) => { | ||
| return `${fileHeader(file, 'short')}${dictionary.allProperties.map(token => { | ||
| return `$${token.name}: ${token.value};` |
|
minus the single comment, which I believe is a typo, LGTM! |
nhoizey
reviewed
Mar 19, 2021
docs/api.md
Outdated
| | --- | --- | --- | | ||
| | options | <code>Object</code> | | | ||
| | options.name | <code>String</code> | Name of the format to be referenced in your config.json | | ||
| | options.fileHeader | <code>function</code> | Function that returns an array of strings, which will be mapped to comment lines. Takes a single which is the default message array. See [file headers](formats.md#file-headers) for more information. | |
There was a problem hiding this comment.
Takes a single which is
Missing a word in the middle?
There was a problem hiding this comment.
Good catch.
Takes a single which is the default message array
|
LGTM! |
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.
Issue #, if available: #566
Description of changes: Adding custom file headers to output files. You can add custom file headers with a register method,
.registerFileHeaderor directly on the Style Dictionary configuration, similar to custom formats. Custom file headers can be used in custom formats as well with theStyleDictionary.formatHelpers.fileHeader()method.By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.