Generated file message (#191)

* Generated file message

Added message about the file being generated and should not be edited as any changes will be lost the next time the file is generated

* fixed typo

* fixed typo in tests

* added newline at the end of xml stencils

* fixed tests

* fixed test

* fixed test

* moved message about files being generated to a header stencil

Co-authored-by: Edvald Eysteinson <edvald.eysteinson@Edvald-Eysteinsson-MBP.local>

Author: edvaldeysteinsson

Sources/AndroidExport/Resources/Colors.kt.stencil

@@ -1,3 +1,6 @@
+/*
+{% include "header.stencil" %}
+*/
 package {{package}}
 
 import androidx.compose.runtime.Composable

Sources/AndroidExport/Resources/Icons.kt.stencil

@@ -1,3 +1,6 @@
+/*
+{% include "header.stencil" %}
+*/
 package {{package}}
 
 import androidx.compose.material.Icon

Sources/AndroidExport/Resources/Typography.kt.stencil

@@ -1,3 +1,6 @@
+/*
+{% include "header.stencil" %}
+*/
 package {{package}}
 
 import androidx.compose.ui.text.TextStyle

Sources/AndroidExport/Resources/colors.xml.stencil

@@ -1,4 +1,7 @@
 <?xml version="1.0" encoding="utf-8"?>
+<!--
+{% include "header.stencil" %}
+-->
 <resources>{% for color in colors %}
     <color name="{{color.name}}">{{color.hex}}</color>{% endfor %}
-</resources>
+</resources>

Sources/AndroidExport/Resources/header.stencil

@@ -0,0 +1,6 @@
+Do not edit this file!
+
+This file was generated by FigmaExport, any changes made
+to it will be lost the next time the file is generated.
+
+For more details see https://github.com/RedMadRobot/figma-export

Sources/AndroidExport/Resources/typography.xml.stencil

@@ -1,8 +1,11 @@
 <?xml version="1.0" encoding="utf-8"?>
+<!--
+{% include "header.stencil" %}
+-->
 <resources>{% for textStyle in textStyles %}
     <style name="{{ textStyle.name }}">
         <item name="android:fontFamily">{{ textStyle.fontFamily }}</item>
         <item name="android:textSize">{{ textStyle.textSize }}sp</item>
         <item name="android:letterSpacing">{{ textStyle.letterSpacing }}</item>
     </style>{% endfor %}
-</resources>
+</resources>

Tests/AndroidExportTests/AndroidColorExporterTests.swift

@@ -49,18 +49,26 @@ final class AndroidColorExporterTests: XCTestCase {
 
         let referenceCodeLight = """
         <?xml version="1.0" encoding="utf-8"?>
+        <!--
+        \(header)
+        -->
         <resources>
             <color name="color_pair_1">#807703FF</color>
             <color name="color_pair_2">#FFFFFF</color>
         </resources>
+
         """
 
         let referenceCodeDark = """
         <?xml version="1.0" encoding="utf-8"?>
+        <!--
+        \(header)
+        -->
         <resources>
             <color name="color_pair_1">#807703FF</color>
             <color name="color_pair_2">#000000</color>
         </resources>
+
         """
 
         XCTAssertNoDifference(generatedCodeLight, referenceCodeLight)
@@ -70,6 +78,9 @@ final class AndroidColorExporterTests: XCTestCase {
         XCTAssertEqual(result[2].destination.file.absoluteString, "Colors.kt")
         let generatedComposedCode = String(data: try XCTUnwrap(result[2].data), encoding: .utf8)
         let referenceComposeCode = """
+        /*
+        \(header)
+        */
         package \(AndroidColorExporterTests.packageName)
         
         import androidx.compose.runtime.Composable

Tests/AndroidExportTests/AndroidComposeIconExporterTests.swift

@@ -31,6 +31,9 @@ final class AndroidComposeIconExporterTests: XCTestCase {
         XCTAssertEqual(result.destination.file.absoluteString, "Icons.kt")
         let generatedComposedCode = String(data: try XCTUnwrap(result.data), encoding: .utf8)
         let referenceComposeCode = """
+        /*
+        \(header)
+        */
         package \(AndroidComposeIconExporterTests.packageName)
         
         import androidx.compose.material.Icon

Tests/AndroidExportTests/AndroidTypographyExporterTests.swift

@@ -36,6 +36,9 @@ final class AndroidTypographyExporterTests: XCTestCase {
         let generatedCode = String(data: fileContent, encoding: .utf8)
         let referenceCode = """
         <?xml version="1.0" encoding="utf-8"?>
+        <!--
+        \(header)
+        -->
         <resources>
             <style name="title">
                 <item name="android:fontFamily">@font/test_font</item>
@@ -48,13 +51,17 @@ final class AndroidTypographyExporterTests: XCTestCase {
                 <item name="android:letterSpacing">0.00</item>
             </style>
         </resources>
+
         """
         XCTAssertNoDifference(generatedCode, referenceCode)
 
         XCTAssertEqual(result[1].destination.directory.lastPathComponent, AndroidTypographyExporterTests.packageName)
         XCTAssertEqual(result[1].destination.file.absoluteString, "Typography.kt")
         let generatedComposedCode = String(data: try XCTUnwrap(result[1].data), encoding: .utf8)
         let referenceComposeCode = """
+        /*
+        \(header)
+        */
         package \(AndroidTypographyExporterTests.packageName)
         
         import androidx.compose.ui.text.TextStyle

Tests/AndroidExportTests/header.swift

@@ -0,0 +1,8 @@
+let header = """
+Do not edit this file!
+
+This file was generated by FigmaExport, any changes made
+to it will be lost the next time the file is generated.
+
+For more details see https://github.com/RedMadRobot/figma-export
+"""