Version Packages (#31)

Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
divriots · Sep 15, 2022 · dc178bd · dc178bd
1 parent ab01a1e
commit dc178bd
Show file tree

Hide file tree

Showing 4 changed files with 80 additions and 80 deletions.
diff --git a/.changeset/four-bulldogs-protect.md b/.changeset/four-bulldogs-protect.md
diff --git a/.changeset/spicy-sloths-rescue.md b/.changeset/spicy-sloths-rescue.md
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,84 @@
 # @divriots/style-dictionary-to-figma
 
+## 0.4.0
+
+### Minor Changes
+
+- ab01a1e: BREAKING: if an upper token group does not have a tokenset property, it will get placed in a "global" tokenset by default. This means that no action is required by the user of the transformer to get a working JSON for Figma Tokens Plugin, but this change is potentially breaking because of how it changes the JSON output.
+
+  ### Before
+
+  ```json
+  {
+    "core": {
+      "color": {
+        "primary": {
+          "base": {
+            "type": "color",
+            "value": "#14b8a6"
+          },
+          "secondary": {
+            "type": "color",
+            "value": "#ff0000"
+          }
+        }
+      }
+    }
+  }
+  ```
+
+  Nothing is changed in the output. However, if you have references, they might be broken because the plugin will interpret this as `"color"` being the upper property in a tokenset called `"core"`.
+
+  ### After
+
+  ```json
+  {
+    "core": {
+      "color": {
+        "primary": {
+          "base": {
+            "type": "color",
+            "value": "#14b8a6"
+          },
+          "secondary": {
+            "type": "color",
+            "value": "#ff0000"
+          }
+        }
+      }
+    }
+  }
+  ```
+
+  turns into
+
+  ```json
+  {
+    "global": {
+      "core": {
+        "color": {
+          "primary": {
+            "base": {
+              "type": "color",
+              "value": "#14b8a6"
+            },
+            "secondary": {
+              "type": "color",
+              "value": "#ff0000"
+            }
+          }
+        }
+      }
+    }
+  }
+  ```
+
+  Your reference, for example `{core.color.primary.base}` will now work properly because `"core"` is not interpreted as the tokenset, `"global"` is.
+
+### Patch Changes
+
+- ab01a1e: Fix clean-meta utility by using a proper isObject check which excludes arrays (values can be arrays).
+
 ## 0.3.3
 
 ### Patch Changes

diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@divriots/style-dictionary-to-figma",
-  "version": "0.3.3",
+  "version": "0.4.0",
   "description": "A utility that transforms a style-dictionary object into something Figma Tokens plugin understands",
   "license": "MIT",
   "author": "divRiots <[email protected]>",