fix(extend): use given file path for token data #499
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
|
Tested this on our codebase and works nicely. Just a note that the documentation at https://github.com/amzn/style-dictionary/blob/main/docs/version_3.md#adding-filepath-and-issource-entries-on-tokens will likely need updating to something like follows. - filePath: A string representing the absolute path of the file that defines the token. This will help with debugging and if you want to output files based on the source files.
+ filePath: A string representing the path of the file that defines the token, will be relative or absolute based on the source or includes entry which picked up the file. This will help with debugging and if you want to output files based on the source files. |
chazzmoney
reviewed
Dec 17, 2020
| @@ -28,7 +28,7 @@ There are 3 types of transforms: attribute, name, and value. | |||
| **Value:** The value transform is the most important as this is the one that changes the representation of the value. Colors can be turned into hex values, rgb, hsl, hsv, etc. Value transforms have a matcher function that filter which properties that transform runs on. This allows us to only run a color transform on only the colors and not every property. | |||
|
|
|||
| ## Defining Custom Transforms | |||
| You can define custom transforms with the [`registerTransform`](api.md#registertransform). | |||
| You can define custom transforms with the [`registerTransform`](api.md#registertransform). Style Dictionary adds some [default metadata](properties.md?id=default-property-metadata) to each property/token to help with transforms. | |||
There was a problem hiding this comment.
to help with transforms
to provide context that may be useful for some transforms.
chazzmoney
reviewed
Dec 17, 2020
docs/transforms.md
Outdated
| @@ -32,7 +32,7 @@ There are 3 types of transforms: attribute, name, and value. | |||
| **Value:** The value transform is the most important as this is the one that changes the representation of the value. Colors can be turned into hex values, rgb, hsl, hsv, etc. Value transforms have a matcher function that filter which properties that transform runs on. This allows us to only run a color transform on only the colors and not every property. | |||
|
|
|||
| ## Defining Custom Transforms | |||
| You can define custom transforms with the [`registerTransform`](api.md#registertransform). | |||
| You can define custom transforms with the [`registerTransform`](api.md#registertransform). Style Dictionary adds some [default metadata](properties.md?id=default-property-metadata) to each property/token to help with transforms. | |||
There was a problem hiding this comment.
to help with transforms
to provide context that may be useful for some transforms.
chazzmoney
reviewed
Dec 17, 2020
| @@ -71,6 +71,8 @@ A special file configuration is `filter`, which will filter the tokens before th | |||
| } | |||
| ``` | |||
|
|
|||
| The token/property that is passed to the filter function has already been [transformed](transforms.md) and has [default metadata](properties.md?id=default-property-metadata) added by Style Dictionary. | |||
There was a problem hiding this comment.
not sure default is the right adjective. as opposed to optional metadata? might be worth considering the wording here.
|
LGTM |
dbanksdesign
added a commit
that referenced
this pull request
Jan 25, 2021
* fix(extend): use given file path for token data * docs(properties): update properties doc to reflect new additions * docs(property): adding default metadata to property docs * docs(properties): adding more context to default metadata * docs(properties): cleaning up default metadata docs
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: #498
Description of changes: Changed the
filePathattribute Style Dictionary adds to all tokens to be the filePath provided by 'source' or 'includes'. If you provide a relative file path like["tokens/**/*.json"]then filePath will now be "tokens/color/core.json" rather than "/Users/djb/dev/my-style-dictionary/tokens/color/core.json" for example.By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.