style-dictionary 3.7.2 → 3.8.0

package/lib/register/filter.js

@@ -29,13 +29,13 @@
  * })
  * ```
  */
-function registerFilter(options) {
-  if (typeof options.name !== 'string')
+function registerFilter(filter) {
+  if (typeof filter.name !== 'string')
     throw new Error('Can\'t register filter; filter.name must be a string');
-  if (typeof options.matcher !== 'function')
+  if (typeof filter.matcher !== 'function')
     throw new Error('Can\'t register filter; filter.matcher must be a function');
 
-  this.filter[options.name] = options.matcher;
+  this.filter[filter.name] = filter.matcher;
 
   return this;
 }

package/lib/register/format.js

@@ -60,13 +60,13 @@
  * })
  * ```
  */
-function registerFormat(options) {
-  if (typeof options.name !== 'string')
+function registerFormat(format) {
+  if (typeof format.name !== 'string')
     throw new Error('Can\'t register format; format.name must be a string');
-  if (typeof options.formatter !== 'function')
+  if (typeof format.formatter !== 'function')
     throw new Error('Can\'t register format; format.formatter must be a function');
 
-  this.format[options.name] = options.formatter;
+  this.format[format.name] = format.formatter;
 
   return this;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "style-dictionary",
-  "version": "3.7.2",
+  "version": "3.8.0",
   "description": "Style once, use everywhere. A build system for creating cross-platform styles.",
   "keywords": [
     "style dictionary",
@@ -123,7 +123,7 @@
     "commander": "^8.3.0",
     "fs-extra": "^10.0.0",
     "glob": "^7.2.0",
-    "json5": "^2.2.0",
+    "json5": "^2.2.2",
     "jsonc-parser": "^3.0.0",
     "lodash": "^4.17.15",
     "tinycolor2": "^1.4.1"

package/types/FormatHelpers.d.ts

@@ -11,10 +11,10 @@
  * and limitations under the License.
  */
 
-import { Dictionary } from './Dictionary';
-import { DesignToken } from './DesignToken';
-import { TransformedToken } from './TransformedToken';
-import { File } from './File';
+import { Dictionary } from "./Dictionary";
+import { DesignToken } from "./DesignToken";
+import { TransformedToken } from "./TransformedToken";
+import { File } from "./File";
 
 export interface LineFormatting {
   prefix?: string;
@@ -29,7 +29,7 @@ export type TokenFormatterArgs = {
   dictionary: Dictionary;
   format?: "css" | "sass" | "less" | "stylus";
   formatting?: LineFormatting;
-}
+};
 
 export interface CommentFormatting {
   prefix: string;
@@ -46,7 +46,7 @@ export interface FileHeaderArgs {
 
 export interface FormattedVariablesArgs {
   format: "css" | "sass";
-  dictionary: Dictionary
+  dictionary: Dictionary;
   outputReferences?: boolean;
   formatting?: LineFormatting;
 }
@@ -59,8 +59,18 @@ export interface FormatHelpers {
   formattedVariables: (args: FormattedVariablesArgs) => string;
   minifyDictionary: (dictionary: object) => object;
   getTypeScriptType: (value: unknown) => string;
-  iconsWithPrefix: (prefix: string, allTokens: DesignToken[], options: object) => string;
-  sortByReference: (dictionary: Dictionary) => string;
+  iconsWithPrefix: (
+    prefix: string,
+    allTokens: DesignToken[],
+    options: object
+  ) => string;
+  sortByReference: (
+    dictionary: Dictionary
+  ) => (a: TransformedToken, b: TransformedToken) => number;
   sortByName: (a: DesignToken, b: DesignToken) => number;
-  setSwiftFileProperties: (options: object, objectType: string, transformGroup: string) => string;
-}
+  setSwiftFileProperties: (
+    options: object,
+    objectType: string,
+    transformGroup: string
+  ) => string;
+}

package/types/Platform.d.ts

@@ -14,7 +14,7 @@
 import { Options } from './Options';
 import { File } from './File';
 
-export interface Platform {
+export type Platform<PlatformType = Record<string, any>> = {
   transformGroup?: string;
   transforms?: string[];
   basePxFontSize?: number;
@@ -23,4 +23,4 @@ export interface Platform {
   files?: File[];
   actions?: string[];
   options?: Options;
-}
+} & PlatformType;

package/types/Transform.d.ts

@@ -15,32 +15,35 @@ import { Matcher } from './Matcher';
 import { TransformedToken } from './TransformedToken';
 import { Platform } from './Platform';
 
-export interface NameTransform {
+export interface NameTransform<PlatformType = Record<string,any>> {
   type: "name";
   matcher?: Matcher;
   transformer: (
     token: TransformedToken,
-    options?: Platform
+    options: Platform<PlatformType>
   ) => string;
 }
 
-export interface ValueTransform {
+export interface ValueTransform<PlatformType = Record<string,any>> {
   type: "value";
   transitive?: boolean;
   matcher?: Matcher;
   transformer: (
     token: TransformedToken,
-    options?: Platform
+    options: Platform<PlatformType>
   ) => any;
 }
 
-export interface AttributeTransform {
+export interface AttributeTransform<PlatformType = Record<string,any>> {
   type: "attribute";
   matcher?: Matcher;
   transformer: (
     token: TransformedToken,
-    options?: Platform
+    options: Platform<PlatformType>
   ) => { [key: string]: any };
 }
 
-export type Transform = NameTransform | ValueTransform | AttributeTransform;
+export type Transform<PlatformType = Record<string,any>> =
+  | NameTransform<PlatformType>
+  | ValueTransform<PlatformType>
+  | AttributeTransform<PlatformType>;

package/types/index.d.ts

@@ -49,8 +49,8 @@ declare namespace StyleDictionary {
   type Matcher = _Matcher;
   type Options = _Options;
   type Parser = _Parser;
-  type Platform = _Platform;
-  type Transform = _Transform;
+  type Platform<PlatformType = Record<string,any>> = _Platform<PlatformType>;
+  type Transform<PlatformType = Record<string,any>> = _Transform<PlatformType>;
   type TransformedToken = _TransformedToken;
   type TransformedTokens = _TransformedTokens;
   type TransformGroup = _TransformGroup;
@@ -97,7 +97,7 @@ declare namespace StyleDictionary {
      * });
      * ```
      */
-    registerTransform(transform: Named<Transform>): this;
+    registerTransform<PlatformType>(transform: Named<Transform<PlatformType>>): this;
 
     /**
      * Add a custom transformGroup to the Style Dictionary, which is a

package/types/index.test-d.ts

@@ -101,6 +101,29 @@ expectType<StyleDictionary.Core>(
   })
 );
 
+type CustomPlatform = {
+  colorMode: 'light' | 'dark';
+}
+
+expectType<StyleDictionary.Core>(
+  StyleDictionary.registerTransform<CustomPlatform>({
+    name: "colormode",
+    type: "value",
+    matcher: function (token) {
+      return token.attributes?.category === "color";
+    },
+    transformer: function (token, platform) {
+      expectType<StyleDictionary.TransformedToken>(token);
+      expectType<StyleDictionary.Platform<CustomPlatform>>(platform);
+      if (platform.colorMode === 'light') {
+        return 'light'
+      } else {
+        return 'dark'
+      }
+    },
+  })
+);
+
 expectType<StyleDictionary.Core>(
   StyleDictionary.registerTransformGroup({
     name: "Swift",
@@ -154,6 +177,12 @@ expectAssignable<StyleDictionary.Platform>({
   transforms: [`attribute/cti`],
 });
 
+expectAssignable<StyleDictionary.Platform>({
+  colorMode: 'dark',
+  files: [],
+  transformGroup: 'scss',
+});
+
 expectAssignable<StyleDictionary.Platform>({
   transforms: [`attribute/cti`],
   files: [{