@tokens-studio/sd-transforms - npm Package Compare versions

Comparing version 0.8.1 to 0.8.2

dist/index.d.ts

 export { registerTransforms } from './registerTransforms.js';
 export { expandComposites } from './parsers/expand-composites.js';
+export { excludeParentKeys } from './parsers/exclude-parent-keys.js';
 export { mapDescriptionToComment } from './mapDescriptionToComment.js';
@@ -4,0 +5,0 @@ export { checkAndEvaluateMath } from './checkAndEvaluateMath.js';

dist/index.js

 export { registerTransforms } from './registerTransforms.js';
 export { expandComposites } from './parsers/expand-composites.js';
+export { excludeParentKeys } from './parsers/exclude-parent-keys.js';
 export { mapDescriptionToComment } from './mapDescriptionToComment.js';
@@ -4,0 +5,0 @@ export { checkAndEvaluateMath } from './checkAndEvaluateMath.js';

dist/registerTransforms.js

@@ -14,2 +14,3 @@ import { transformDimension } from './transformDimension.js';
 import { expandComposites } from './parsers/expand-composites.js';
+import { excludeParentKeys } from './parsers/exclude-parent-keys.js';
 import { transformOpacity } from './transformOpacity.js';
@@ -39,3 +40,4 @@ const isBrowser = typeof window === 'object';
                 const obj = JSON.parse(contents);
-                const expanded = expandComposites(obj, filePath, transformOpts);
+                const excluded = excludeParentKeys(obj, transformOpts);
+                const expanded = expandComposites(excluded, filePath, transformOpts);
                 return expanded;
@@ -42,0 +44,0 @@ },

dist/TransformOptions.d.ts

@@ -14,2 +14,3 @@ import { SingleBorderToken, SingleBoxShadowToken, SingleCompositionToken, SingleToken, SingleTypographyToken } from '@tokens-studio/types';
     expand?: ExpandOptions | false;
+    excludeParentKeys?: boolean;
 }

package.json

 {
   "name": "@tokens-studio/sd-transforms",
-  "version": "0.8.1",
+  "version": "0.8.2",
   "description": "Custom transforms for Style-Dictionary, to work with Design Tokens that are exported from Tokens Studio",
@@ -5,0 +5,0 @@ "license": "MIT",

README.md

@@ -13,2 +13,3 @@ # Style Dictionary Transforms for Tokens Studio
 - Expands composition tokens into multiple, optionally also does so for typography, border and shadow tokens -> parser
+- Optionally excludes parent keys from your tokens file, e.g. when using single-file export from Tokens Studio Figma plugin -> parser
 - Maps token descriptions to comments -> `ts/descriptionToComment`
@@ -109,2 +110,3 @@ - Check and evaluate Math expressions (transitive) -> `ts/resolveMath`
   },
+  excludeParentKeys: true,
 });
@@ -117,2 +119,3 @@ ```
 | ------------------ | ------------------------ | -------- | --------------- | ------------------------------------------------------------------------------------------------------------------------------------- |
+| excludeParentKeys  | boolean                  | ❌       | `false`         | Whether or not to exclude parent keys from your token files                                                                           |
 | expand             | boolean \| ExpandOptions | ❌       | See props below | `false` to not register the parser at all. By default, expands composition tokens. Optionally, border, shadow and typography as well. |
@@ -123,2 +126,3 @@ | expand.composition | boolean \| ExpandFilter  | ❌       | `true`          | Whether or not to expand compositions. Also allows a filter callback function to conditionally expand per token/filePath              |
 | expand.border      | boolean \| ExpandFilter  | ❌       | `false`         | Whether or not to expand borders. Also allows a filter callback function to conditionally expand per token/filePath                   |
+|                    |
 
@@ -186,3 +190,3 @@ > Note: you can also import and use the `expandComposites` function to run the expansion on your token object manually.
 
-> Note: make sure to choose either the full transformGroup, **OR** its separate transforms, so you can adjust or add your own.
+> Note: make sure to choose either the full transformGroup, **OR** its separate transforms so you can adjust or add your own.
 > [Combining a transformGroup with a transforms array can give unexpected results](https://github.com/amzn/style-dictionary/issues/813).

No alert changes

Improved metrics

Total package byte prevSize

172190

increased by1.19%

Number of package files

78

increased by4%

Lines of code

4882

increased by0.78%

Number of lines in readme file

188

increased by2.17%

No dependency changes