From b707353a93d1b4785fca0f10b4adc99e4372f57b Mon Sep 17 00:00:00 2001
From: Danny Banks <djb@amazon.com>
Date: Thu, 29 Apr 2021 22:09:43 -0700
Subject: [PATCH] fix(formats): fixing formatting options in fileHeader

---
 .../common/formatHelpers/fileHeader.test.js   | 125 ++++++++++++++++++
 lib/common/formatHelpers/fileHeader.js        |  15 +--
 2 files changed, 131 insertions(+), 9 deletions(-)
 create mode 100644 __tests__/common/formatHelpers/fileHeader.test.js

diff --git a/__tests__/common/formatHelpers/fileHeader.test.js b/__tests__/common/formatHelpers/fileHeader.test.js
new file mode 100644
index 000000000..6474241b8
--- /dev/null
+++ b/__tests__/common/formatHelpers/fileHeader.test.js
@@ -0,0 +1,125 @@
+/*
+ * Copyright 2017 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
+ * the License. A copy of the License is located at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
+ * CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
+ * and limitations under the License.
+ */
+
+const fileHeader = require('../../../lib/common/formatHelpers/fileHeader');
+
+const defaultLine1 = `Do not edit directly`;
+const defaultLine2 = `Generated on Sat, 01 Jan 2000 00:00:00 GMT`;
+
+describe('common', () => {
+  describe('formatHelpers', () => {
+
+    describe('fileHeader', () => {
+      it(`should default to /**/ comment style`, () => {
+        const comment = fileHeader({});
+        expect(comment).toEqual(
+`/**
+ * ${defaultLine1}
+ * ${defaultLine2}
+ */
+
+`);
+      });
+
+      it(`should handle commentStyle short`, () => {
+        const comment = fileHeader({commentStyle: 'short'});
+        expect(comment).toEqual(
+`
+// ${defaultLine1}
+// ${defaultLine2}
+
+`);
+      });
+
+      it(`should handle commentStyle xml`, () => {
+        const comment = fileHeader({commentStyle: 'xml'});
+        expect(comment).toEqual(
+`<!--
+  ${defaultLine1}
+  ${defaultLine2}
+-->`);
+      });
+
+      it(`should handle showFileHeader option`, () => {
+        const comment = fileHeader({
+          file: {
+            options: {
+              showFileHeader: false
+            }
+          }
+        });
+        expect(comment).toEqual('');
+      });
+
+      it(`should handle custom fileHeader function`, () => {
+        const comment = fileHeader({
+          file: {
+            options: {
+              fileHeader: () => {
+                return [
+                  `Never gonna give you up`,
+                  `Never gonna let you down`
+                ]
+              }
+            }
+          }
+        });
+        expect(comment).toEqual(
+`/**
+ * Never gonna give you up
+ * Never gonna let you down
+ */
+
+`);
+      });
+
+      it(`should handle custom fileHeader function with default`, () => {
+        const comment = fileHeader({
+          file: {
+            options: {
+              fileHeader: (defaultMessage) => {
+                return [
+                  ...defaultMessage,
+                  `Never gonna give you up`,
+                  `Never gonna let you down`
+                ]
+              }
+            }
+          }
+        });
+        expect(comment).toEqual(
+`/**
+ * ${defaultLine1}
+ * ${defaultLine2}
+ * Never gonna give you up
+ * Never gonna let you down
+ */
+
+`);
+      });
+
+      it('should handle custom formatting', () => {
+        const comment = fileHeader({formatting: {
+          prefix: `  `,
+          header: `{#\n`,
+          footer: `\n#}`
+        }});
+        expect(comment).toEqual(
+`{#
+  ${defaultLine1}
+  ${defaultLine2}
+#}`);
+      });
+    });
+  });
+});
\ No newline at end of file
diff --git a/lib/common/formatHelpers/fileHeader.js b/lib/common/formatHelpers/fileHeader.js
index a4105592c..9332a717f 100644
--- a/lib/common/formatHelpers/fileHeader.js
+++ b/lib/common/formatHelpers/fileHeader.js
@@ -14,11 +14,12 @@
 // no-op default
 const defaultFileHeader = (arr) => arr
 
+const lineSeparator = `\n`;
 const defaultFormatting = {
-  lineSeparator: '\n',
-  prefix: '',
-  header: '',
-  footer: ''
+  lineSeparator,
+  prefix: ` * `,
+  header: `/**${lineSeparator}`,
+  footer: `${lineSeparator} */${lineSeparator}${lineSeparator}`
 }
 
 /**
@@ -44,7 +45,7 @@ const defaultFormatting = {
  * });
  * ```
  */
-function fileHeader({file, commentStyle, formatting={}}) {
+function fileHeader({file={}, commentStyle, formatting={}}) {
   // showFileHeader is true by default
   let showFileHeader = true;
   if (file.options && typeof file.options.showFileHeader !== 'undefined') {
@@ -76,10 +77,6 @@ function fileHeader({file, commentStyle, formatting={}}) {
     prefix = `  `;
     header = `<!--${lineSeparator}`;
     footer = `${lineSeparator}-->`;
-  } else {
-    prefix = ` * `;
-    header = `/**${lineSeparator}`;
-    footer = `${lineSeparator} */${lineSeparator}${lineSeparator}`;
   }
 
   return `${header}${fn(defaultHeader)