fix: make FileHeader defaultMessage param optional (#1351)

amzn · Oct 1, 2024 · 9376247 · 9376247
1 parent 26728b9
commit 9376247
Show file tree

Hide file tree

Showing 3 changed files with 7 additions and 2 deletions.
diff --git a/.changeset/dirty-grapes-deliver.md b/.changeset/dirty-grapes-deliver.md
@@ -0,0 +1,5 @@
+---
+'style-dictionary': patch
+---
+
+Make `defaultMessage` param in FileHeader type optional.
diff --git a/lib/common/formatHelpers/fileHeader.js b/lib/common/formatHelpers/fileHeader.js
@@ -67,7 +67,7 @@ export default async function fileHeader({ file, commentStyle, formatting = {},
   /**
    * @type {FileHeader}
    */
-  let fn = (arr) => arr;
+  let fn = (arr) => arr ?? [];
   if (file?.options?.fileHeader && typeof file?.options?.fileHeader !== 'string') {
     fn = file.options.fileHeader;
   }

diff --git a/types/File.ts b/types/File.ts
@@ -25,7 +25,7 @@ export interface FormattingOverrides {
 }
 
 export type FileHeader = (
-  defaultMessage: string[],
+  defaultMessage?: string[],
   options?: Config,
 ) => Promise<string[]> | string[];