fix(types): make FileHeaderArgs.commentStyle optional (#743)

amzn · Dec 7, 2021 · 401d93b · 401d93b
1 parent 3570dfc
commit 401d93b
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 2 deletions.
diff --git a/lib/common/formatHelpers/fileHeader.js b/lib/common/formatHelpers/fileHeader.js
@@ -38,7 +38,7 @@ const defaultFormatting = {
  * StyleDictionary.registerFormat({
  *   name: 'myCustomFormat',
  *   formatter: function({ dictionary, file }) {
- *     return fileHeader({file, 'short') +
+ *     return fileHeader({file, commentStyle: 'short'}) +
  *       dictionary.allTokens.map(token => `${token.name} = ${token.value}`)
  *         .join('\n');
  *   }

diff --git a/types/FormatHelpers.d.ts b/types/FormatHelpers.d.ts
@@ -39,7 +39,7 @@ export interface CommentFormatting {
 
 export interface FileHeaderArgs {
   file: File;
-  commentStyle: string;
+  commentStyle?: string;
   formatting?: CommentFormatting;
 }