Incorrect type definition in Config.d.ts

[yunhao]

What happened

When using the NPM Module and Typescript to write a build script, the following code compiles successfully. It passes TypeScript's type system.

StyleDictionary.extend({
  transformGroup: {
    "custom/ios-swift": {
      transforms: [
        "category/normalize",
        'attribute/cti',
        // ...
      ]
    }
  },
  platforms: {
    // ...
  }
})

However, when you run the code, you will see an error:

to_ret.transforms = transforms.map(function(name) {
                                 ^

TypeError: transforms.map is not a function

Expect

After looking at the source code, I found that the correct code should be:

StyleDictionary.extend({
  transformGroup: {
    "custom/ios-swift": [
      "category/normalize",
      'attribute/cti',
      // ...
    ]
  },
  platforms: {
    // ...
  }
})

Unfortunately, the code will not compile because of type mismatches. However, if you make some changes to make the code compilable (e.g. using any type) and then run it, it will work fine.

How to fix it

style-dictionary/types/Config.d.ts

Line 27 in 3b520d2

transformGroup?: Record<string, TransformGroup>;

I think we should change this line of code to:

transformGroup?: Record<string, TransformGroup['transform']>;

[jorenbroekema]

Fixed in v4 branch