chore: re-add custom file header to include tokens docs

openedx · Sep 3, 2024 · 8234010 · 8234010
1 parent ec15f2a
commit 8234010
Show file tree

Hide file tree

Showing 6 changed files with 22 additions and 20 deletions.
diff --git a/lib/build-tokens.js b/lib/build-tokens.js
@@ -61,16 +61,16 @@ async function buildTokensCommand(commandArgs) {
         prefix: 'pgn',
         // NOTE: buildPath must end with a slash
         buildPath: buildDir.slice(-1) === '/' ? buildDir : `${buildDir}/`,
+        options: {
+          fileHeader: 'customFileHeader',
+        },
         files: [
           {
             format: 'css/custom-variables',
             destination: 'core/variables.css',
             filter: hasSourceTokensOnly ? 'isSource' : undefined,
             options: {
               outputReferences,
-              formatting: {
-                fileHeaderTimestamp: true,
-              },
             },
           },
           {
@@ -79,9 +79,6 @@ async function buildTokensCommand(commandArgs) {
             filter: hasSourceTokensOnly ? 'isSource' : undefined,
             options: {
               outputReferences,
-              formatting: {
-                fileHeaderTimestamp: true,
-              },
             },
           },
         ],
@@ -124,9 +121,6 @@ async function buildTokensCommand(commandArgs) {
               : `isThemeVariant.${themeVariant}`,
             options: {
               outputReferences,
-              formatting: {
-                fileHeaderTimestamp: true,
-              },
             },
           },
           {
@@ -135,9 +129,6 @@ async function buildTokensCommand(commandArgs) {
             filter: hasSourceTokensOnly ? 'isSource' : undefined,
             options: {
               outputReferences,
-              formatting: {
-                fileHeaderTimestamp: true,
-              },
             },
           },
         ],

diff --git a/styles/css/core/custom-media-breakpoints.css b/styles/css/core/custom-media-breakpoints.css
@@ -1,6 +1,6 @@
 /**
- * Do not edit directly, this file was auto-generated.
- * Generated on Tue, 03 Sep 2024 13:46:25 GMT
+ * Do not edit directly, this file was auto-generated. while transforming design tokens.
+ * See <root>/tokens/README.md for more details.
  */
 
 @custom-media --pgn-size-breakpoint-min-width-xs (min-width: 0);

diff --git a/styles/css/core/variables.css b/styles/css/core/variables.css
@@ -1,6 +1,6 @@
 /**
- * Do not edit directly, this file was auto-generated.
- * Generated on Tue, 03 Sep 2024 13:46:25 GMT
+ * Do not edit directly, this file was auto-generated. while transforming design tokens.
+ * See <root>/tokens/README.md for more details.
  */
 
 :root {

diff --git a/styles/css/themes/light/utility-classes.css b/styles/css/themes/light/utility-classes.css
@@ -1,6 +1,6 @@
 /**
- * Do not edit directly, this file was auto-generated.
- * Generated on Tue, 03 Sep 2024 13:46:26 GMT
+ * Do not edit directly, this file was auto-generated. while transforming design tokens.
+ * See <root>/tokens/README.md for more details.
  */
 
 .bg-accent-a {

diff --git a/styles/css/themes/light/variables.css b/styles/css/themes/light/variables.css
@@ -1,6 +1,6 @@
 /**
- * Do not edit directly, this file was auto-generated.
- * Generated on Tue, 03 Sep 2024 13:46:26 GMT
+ * Do not edit directly, this file was auto-generated. while transforming design tokens.
+ * See <root>/tokens/README.md for more details.
  */
 
 :root {

diff --git a/tokens/style-dictionary.js b/tokens/style-dictionary.js
@@ -346,6 +346,17 @@ const initializeStyleDictionary = async ({ themes }) => {
     parser: ({ contents }) => toml.load(contents),
   });
 
+  /**
+   * Registers a custom fileHeader.
+   */
+  StyleDictionary.registerFileHeader({
+    name: 'customFileHeader',
+    fileHeader: (defaultMessage) => [
+      `${defaultMessage} while transforming design tokens.`,
+      'See <root>/tokens/README.md for more details.',
+    ],
+  });
+
   return StyleDictionary;
 };