feat: pass dictionary options to preprocessors (#1224)

Author: jorenbroekema

.changeset/stupid-mangos-explode.md

@@ -0,0 +1,5 @@
+---
+'style-dictionary': patch
+---
+
+Pass dictionary options to preprocessor functions.

__tests__/register/preprocessor.test.js

@@ -139,4 +139,28 @@ describe('register/transformGroup', async () => {
       },
     });
   });
+
+  it('should pass options to preprocessor function as second argument', async () => {
+    let opts;
+    StyleDictionary.registerPreprocessor({
+      name: 'foo-processor',
+      preprocessor: async (dict, options) => {
+        opts = options;
+        return dict;
+      },
+    });
+
+    StyleDictionaryExtended = new StyleDictionary({
+      preprocessors: ['foo-processor'],
+      tokens: {
+        foo: {
+          $value: '4px',
+          $type: 'dimension',
+          $description: 'Foo description',
+        },
+      },
+    });
+    await StyleDictionaryExtended.hasInitialized;
+    expect(opts.usesDtcg).to.be.true;
+  });
 });

lib/StyleDictionary.js

@@ -335,8 +335,13 @@ export default class StyleDictionary extends Register {
     if (this.shouldRunExpansion(this.expand)) {
       tokens = expandTokens(tokens, this.options);
     }
-    this.tokens = await preprocess(tokens, this.preprocessors, this.hooks.preprocessors);
     this.options = { ...this.options, usesDtcg: this.usesDtcg };
+    this.tokens = await preprocess(
+      tokens,
+      this.preprocessors,
+      this.hooks.preprocessors,
+      this.options,
+    );
     this.hasInitializedResolve(null);
 
     // For chaining

lib/utils/preprocess.js

@@ -13,6 +13,7 @@
 
 /**
  * @typedef {import('../../types/DesignToken.d.ts').DesignTokens} DesignTokens
+ * @typedef {import('../../types/Config.d.ts').Config} Config
  * @typedef {import('../../types/Preprocessor.d.ts').Preprocessor} Preprocessor
  */
 
@@ -23,16 +24,22 @@
  * @param {DesignTokens} tokens
  * @param {string[]} [appliedPreprocessors]
  * @param {Record<string, Preprocessor['preprocessor']>} [preprocessorObj]
+ * @param {Config} [options]
  * @returns {Promise<DesignTokens>}
  */
-export async function preprocess(tokens, appliedPreprocessors = [], preprocessorObj = {}) {
+export async function preprocess(
+  tokens,
+  appliedPreprocessors = [],
+  preprocessorObj = {},
+  options = {},
+) {
   let processedTokens = tokens;
 
   const preprocessors = Object.entries(preprocessorObj);
   if (preprocessors.length > 0) {
     for (const [key, preprocessor] of preprocessors) {
       if (appliedPreprocessors.includes(key)) {
-        processedTokens = await preprocessor(processedTokens);
+        processedTokens = await preprocessor(processedTokens, options);
       }
     }
   }

types/Preprocessor.d.ts

@@ -12,8 +12,9 @@
  */
 
 import type { DesignTokens } from './DesignToken.d.ts';
+import type { Config } from './Config.d.ts';
 
 export type Preprocessor = {
   name: string;
-  preprocessor: (dictionary: DesignTokens) => DesignTokens | Promise<DesignTokens>;
+  preprocessor: (dictionary: DesignTokens, options: Config) => DesignTokens | Promise<DesignTokens>;
 };