tokens-studio / sd-transforms

Custom transforms for Style-Dictionary, to work with Design Tokens that are exported from Tokens Studio
MIT License
198 stars 29 forks source link

chore: add TransformOptions type to `init` in integration tests #312

Closed adamstankiewicz closed 1 month ago

adamstankiewicz commented 2 months ago

While exploring some of the transforms and their associated tests, I noticed the init function used to initialize style-dictionary (i.e., register sd-transforms and dict.buildAllPlatforms()) accepts an untyped function argument transformOpts.

This PR associates the TransformOptions type to this transformOpts argument.

In doing so, TypeScript began throwing an error within cross-file-refs.test.ts that the existing expand option passed to init isn't valid per the TransformOptions type. The tests pass regardless of whether expand is present or not in the provided options, which seems to indicate nothing consumes the property value. As such, I've removed expand from this test suite.

changeset-bot[bot] commented 2 months ago

⚠️ No Changeset found

Latest commit: 3220935818d7f01405bbd6cd28bc36c97cd5059a

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

adamstankiewicz commented 2 months ago

[inform] The changes in this PR are also included in a related proposed change: https://github.com/tokens-studio/sd-transforms/pull/313

If that one merges, this one may be closed. Otherwise, this can be its own standalone contribution, too :)

jorenbroekema commented 1 month ago

Thanks :)!