feat: turn off generated timestamp by default in file headers (#1174)

amzn · May 1, 2024 · 7b82150 · 7b82150
1 parent 2f80da2
commit 7b82150
Show file tree

Hide file tree

Showing 39 changed files with 1,229 additions and 308 deletions.
diff --git a/.changeset/four-fireants-try.md b/.changeset/four-fireants-try.md
@@ -2,4 +2,4 @@
 'style-dictionary': patch
 ---
 
-Pass outputReferencesFallback option to the relevant utilities, so the option actually works.
+Pass outputReferenceFallbacks option to the relevant utilities, so the option actually works.
diff --git a/.changeset/young-cameras-grin.md b/.changeset/young-cameras-grin.md
@@ -0,0 +1,33 @@
+---
+'style-dictionary': major
+---
+
+BREAKING: For formats using the `fileHeader` `formatHelpers` utility, it will no longer display a timestamp in the fileHeader output by default. This is now an opt-in by setting `file.formatting.fileHeaderTimestamp` to `true`. The reason for making this opt-in now is that using Style Dictionary in the context of a CI (continuous integration) pipeline is a common use-case, and when running on pull request event, output files always show a diff in git due to the timestamp changing, which often just means that the diff is bloated by redundancy.
+
+New:
+
+```json
+{
+  "platforms": {
+    "css": {
+      "files": [{
+        "destination": "variables.css",
+        "format": "css/variables",
+        "options": {
+          "formatting": {
+            "fileHeaderTimestamp": true
+          }
+        }
+      }]
+    }
+  }
+}
+```
+
+or:
+
+```js
+import { fileHeader } from 'style-dictionary/utils';
+
+const headerContent = await fileHeader({ formatting: { fileHeaderTimestamp: true } });
+```
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -294,7 +294,7 @@
 
 ### Patch Changes
 
-- 72f020d: Pass outputReferencesFallback option to the relevant utilities, so the option actually works.
+- 72f020d: Pass outputReferenceFallbacks option to the relevant utilities, so the option actually works.
 - d008c67: Fix a couple of spots where DTCG option wasn't properly taken into account, more tests added.
 
 ## 4.0.0-prerelease.15

diff --git a/__integration__/__snapshots__/android.test.snap.js b/__integration__/__snapshots__/android.test.snap.js
@@ -5,8 +5,7 @@ snapshots["integration android android/resources should match snapshot"] =
 `<?xml version="1.0" encoding="UTF-8"?>
 
 <!--
-  Do not edit directly
-  Generated on Sat, 01 Jan 2000 00:00:00 GMT
+  Do not edit directly, this file was auto-generated.
 -->
 <resources>
   <color name="color_background_primary">#ffffffff</color>
@@ -178,8 +177,7 @@ snapshots["integration android android/resources with references should match sn
 `<?xml version="1.0" encoding="UTF-8"?>
 
 <!--
-  Do not edit directly
-  Generated on Sat, 01 Jan 2000 00:00:00 GMT
+  Do not edit directly, this file was auto-generated.
 -->
 <resources>
   <color name="color_background_primary">@color/color_core_neutral_0</color>
@@ -351,8 +349,7 @@ snapshots["integration android android/resources with filter should match snapsh
 `<?xml version="1.0" encoding="UTF-8"?>
 
 <!--
-  Do not edit directly
-  Generated on Sat, 01 Jan 2000 00:00:00 GMT
+  Do not edit directly, this file was auto-generated.
 -->
 <resources>
   <color name="color_background_primary">#ffffffff</color>

diff --git a/__integration__/__snapshots__/compose.test.snap.js b/__integration__/__snapshots__/compose.test.snap.js
@@ -4,8 +4,7 @@ export const snapshots = {};
 snapshots["integration compose compose/object should match snapshot"] = 
 `
 
-// Do not edit directly
-// Generated on Sat, 01 Jan 2000 00:00:00 GMT
+// Do not edit directly, this file was auto-generated.
 
 
 
@@ -183,8 +182,7 @@ object StyleDictionary {
 snapshots["integration compose compose/object with references should match snapshot"] = 
 `
 
-// Do not edit directly
-// Generated on Sat, 01 Jan 2000 00:00:00 GMT
+// Do not edit directly, this file was auto-generated.
 
 
 

diff --git a/__integration__/__snapshots__/css.test.snap.js b/__integration__/__snapshots__/css.test.snap.js
@@ -3,8 +3,7 @@ export const snapshots = {};
 
 snapshots["integration css css/variables should match snapshot"] = 
 `/**
- * Do not edit directly
- * Generated on Sat, 01 Jan 2000 00:00:00 GMT
+ * Do not edit directly, this file was auto-generated.
  */
 
 :root {
@@ -179,8 +178,7 @@ snapshots["integration css css/variables should match snapshot"] =
 
 snapshots["integration css css/variables with references should match snapshot"] = 
 `/**
- * Do not edit directly
- * Generated on Sat, 01 Jan 2000 00:00:00 GMT
+ * Do not edit directly, this file was auto-generated.
  */
 
 :root {
@@ -355,8 +353,7 @@ snapshots["integration css css/variables with references should match snapshot"]
 
 snapshots["integration css css/variables with selector should match snapshot"] = 
 `/**
- * Do not edit directly
- * Generated on Sat, 01 Jan 2000 00:00:00 GMT
+ * Do not edit directly, this file was auto-generated.
  */
 
 .test {
@@ -531,8 +528,7 @@ snapshots["integration css css/variables with selector should match snapshot"] =
 
 snapshots["integration css css/variables with referenceFallbacks should match snapshot"] = 
 `/**
- * Do not edit directly
- * Generated on Sat, 01 Jan 2000 00:00:00 GMT
+ * Do not edit directly, this file was auto-generated.
  */
 
 :root {

diff --git a/__integration__/__snapshots__/customFileHeader.test.snap.js b/__integration__/__snapshots__/customFileHeader.test.snap.js
@@ -4,8 +4,7 @@ export const snapshots = {};
 snapshots["integration valid custom file headers file options registered file header should match snapshot"] = 
 `/**
  * hello
- * Do not edit directly
- * Generated on Sat, 01 Jan 2000 00:00:00 GMT
+ * Do not edit directly, this file was auto-generated.
  */
 
 :root {
@@ -16,8 +15,7 @@ snapshots["integration valid custom file headers file options registered file he
 
 snapshots["integration valid custom file headers file options config file header should match snapshot"] = 
 `/**
- * Do not edit directly
- * Generated on Sat, 01 Jan 2000 00:00:00 GMT
+ * Do not edit directly, this file was auto-generated.
  * hello, world!
  */
 
@@ -40,8 +38,7 @@ snapshots["integration valid custom file headers file options inline file header
 
 snapshots["integration valid custom file headers platform options no file options should match snapshot"] = 
 `/**
- * Do not edit directly
- * Generated on Sat, 01 Jan 2000 00:00:00 GMT
+ * Do not edit directly, this file was auto-generated.
  * hello, world!
  */
 

diff --git a/__integration__/__snapshots__/flutter.test.snap.js b/__integration__/__snapshots__/flutter.test.snap.js
@@ -7,8 +7,7 @@ snapshots["integration flutter flutter/class.dart should match snapshot"] =
 // style_dictionary.dart
 //
 
-// Do not edit directly
-// Generated on Sat, 01 Jan 2000 00:00:00 GMT
+// Do not edit directly, this file was auto-generated.
 
 
 
@@ -188,8 +187,7 @@ snapshots["integration flutter flutter/class.dart with references should match s
 // style_dictionary_with_references.dart
 //
 
-// Do not edit directly
-// Generated on Sat, 01 Jan 2000 00:00:00 GMT
+// Do not edit directly, this file was auto-generated.
 
 
 
@@ -369,8 +367,7 @@ snapshots["integration flutter flutter/class.dart separate should match snapshot
 // style_dictionary_color.dart
 //
 
-// Do not edit directly
-// Generated on Sat, 01 Jan 2000 00:00:00 GMT
+// Do not edit directly, this file was auto-generated.
 
 
 

diff --git a/__integration__/__snapshots__/iOSObjectiveC.test.snap.js b/__integration__/__snapshots__/iOSObjectiveC.test.snap.js
@@ -7,8 +7,7 @@ snapshots["integration ios objective-c ios/singleton.m should match snapshot"] =
 // singleton.m
 //
 
-// Do not edit directly
-// Generated on Sat, 01 Jan 2000 00:00:00 GMT
+// Do not edit directly, this file was auto-generated.
 
 
 #import "StyleDictionary.h"
@@ -1367,8 +1366,7 @@ snapshots["integration ios objective-c ios/singleton.h should match snapshot"] =
 // singleton.h
 //
 
-// Do not edit directly
-// Generated on Sat, 01 Jan 2000 00:00:00 GMT
+// Do not edit directly, this file was auto-generated.
 
 
 #import <Foundation/Foundation.h>
@@ -1389,8 +1387,7 @@ snapshots["integration ios objective-c ios/color.m should match snapshot"] =
 // color.m
 //
 
-// Do not edit directly
-// Generated on Sat, 01 Jan 2000 00:00:00 GMT
+// Do not edit directly, this file was auto-generated.
 
 
 #import "StyleDictionaryColor.h"
@@ -1575,8 +1572,7 @@ snapshots["integration ios objective-c ios/color.h should match snapshot"] =
 // color.h
 //
 
-// Do not edit directly
-// Generated on Sat, 01 Jan 2000 00:00:00 GMT
+// Do not edit directly, this file was auto-generated.
 
 
 #import <UIKit/UIKit.h>
@@ -1749,8 +1745,7 @@ snapshots["integration ios objective-c ios/macros.h should match snapshot"] =
 // macros.h
 //
 
-// Do not edit directly
-// Generated on Sat, 01 Jan 2000 00:00:00 GMT
+// Do not edit directly, this file was auto-generated.
 
 
 #import <Foundation/Foundation.h>
@@ -1926,8 +1921,7 @@ snapshots["integration ios objective-c ios/static.h should match snapshot"] =
 // static.h
 //
 
-// Do not edit directly
-// Generated on Sat, 01 Jan 2000 00:00:00 GMT
+// Do not edit directly, this file was auto-generated.
 
 
 #import <Foundation/Foundation.h>
@@ -1950,8 +1944,7 @@ snapshots["integration ios objective-c ios/static.m should match snapshot"] =
 // static.m
 //
 
-// Do not edit directly
-// Generated on Sat, 01 Jan 2000 00:00:00 GMT
+// Do not edit directly, this file was auto-generated.
 
 
 #import "StyleDictionaryStatic.h"

diff --git a/__integration__/__snapshots__/objectValues.test.snap.js b/__integration__/__snapshots__/objectValues.test.snap.js
@@ -123,8 +123,7 @@ $border-primary: $size-border solid $color-red;
 
 snapshots["integration object values css/variables shadow should match snapshot with references"] = 
 `/**
- * Do not edit directly
- * Generated on Sat, 01 Jan 2000 00:00:00 GMT
+ * Do not edit directly, this file was auto-generated.
  */
 
 :root {
@@ -136,8 +135,7 @@ snapshots["integration object values css/variables shadow should match snapshot
 
 snapshots["integration object values css/variables hsl syntax should match snapshot"] = 
 `/**
- * Do not edit directly
- * Generated on Sat, 01 Jan 2000 00:00:00 GMT
+ * Do not edit directly, this file was auto-generated.
  */
 
 :root {
@@ -149,8 +147,7 @@ snapshots["integration object values css/variables hsl syntax should match snaps
 
 snapshots["integration object values css/variables hsl syntax with references should match snapshot"] = 
 `/**
- * Do not edit directly
- * Generated on Sat, 01 Jan 2000 00:00:00 GMT
+ * Do not edit directly, this file was auto-generated.
  */
 
 :root {
@@ -162,8 +159,7 @@ snapshots["integration object values css/variables hsl syntax with references sh
 
 snapshots["integration object values css/variables hex syntax should match snapshot"] = 
 `/**
- * Do not edit directly
- * Generated on Sat, 01 Jan 2000 00:00:00 GMT
+ * Do not edit directly, this file was auto-generated.
  */
 
 :root {
@@ -175,8 +171,7 @@ snapshots["integration object values css/variables hex syntax should match snaps
 
 snapshots["integration object values css/variables hex syntax with references should match snapshot"] = 
 `/**
- * Do not edit directly
- * Generated on Sat, 01 Jan 2000 00:00:00 GMT
+ * Do not edit directly, this file was auto-generated.
  */
 
 :root {
@@ -188,8 +183,7 @@ snapshots["integration object values css/variables hex syntax with references sh
 
 snapshots["integration object values css/variables border should match snapshot"] = 
 `/**
- * Do not edit directly
- * Generated on Sat, 01 Jan 2000 00:00:00 GMT
+ * Do not edit directly, this file was auto-generated.
  */
 
 :root {
@@ -200,8 +194,7 @@ snapshots["integration object values css/variables border should match snapshot"
 
 snapshots["integration object values css/variables border with references should match snapshot"] = 
 `/**
- * Do not edit directly
- * Generated on Sat, 01 Jan 2000 00:00:00 GMT
+ * Do not edit directly, this file was auto-generated.
  */
 
 :root {
@@ -212,8 +205,7 @@ snapshots["integration object values css/variables border with references should
 
 snapshots["integration object values css/variables shadow should match snapshot"] = 
 `/**
- * Do not edit directly
- * Generated on Sat, 01 Jan 2000 00:00:00 GMT
+ * Do not edit directly, this file was auto-generated.
  */
 
 :root {
@@ -225,17 +217,15 @@ snapshots["integration object values css/variables shadow should match snapshot"
 
 snapshots["integration object values scss/variables should match snapshot"] = 
 `
-// Do not edit directly
-// Generated on Sat, 01 Jan 2000 00:00:00 GMT
+// Do not edit directly, this file was auto-generated.
 
 $border-primary: 0.125rem solid #ff0000;
 `;
 /* end snapshot integration object values scss/variables should match snapshot */
 
 snapshots["integration object values scss/variables with references should match snapshot"] = 
 `
-// Do not edit directly
-// Generated on Sat, 01 Jan 2000 00:00:00 GMT
+// Do not edit directly, this file was auto-generated.
 
 $border-primary: $size-border solid $color-red;
 `;

diff --git a/__integration__/__snapshots__/outputReferences.test.snap.js b/__integration__/__snapshots__/outputReferences.test.snap.js
@@ -30,8 +30,7 @@ css
 
 snapshots["integration output references should allow using outputReferencesTransformed to not output refs when value has been transitively transformed"] = 
 `/**
- * Do not edit directly
- * Generated on Sat, 01 Jan 2000 00:00:00 GMT
+ * Do not edit directly, this file was auto-generated.
  */
 
 :root {