add codegen comment to top of files (#538)

* add codegen comment to top of files

* unversion Makefile

* check for ts(x) extension before adding codegen attribution comment

Author: kuhe

.gitignore

@@ -22,6 +22,9 @@ build/
 */*/out/
 wrapper/
 
+# local scripting
+Makefile
+
 # Visual Studio Code
 .vscode/*
 

smithy-typescript-codegen/src/main/java/software/amazon/smithy/typescript/codegen/TypeScriptDelegator.java

@@ -29,6 +29,7 @@
 import software.amazon.smithy.model.Model;
 import software.amazon.smithy.model.shapes.Shape;
 import software.amazon.smithy.typescript.codegen.integration.TypeScriptIntegration;
+import software.amazon.smithy.typescript.codegen.validation.IsTypeScriptFileExtension;
 import software.amazon.smithy.utils.SmithyUnstableApi;
 
 @SmithyUnstableApi
@@ -59,7 +60,8 @@ final class TypeScriptDelegator {
      * Writes all of the pending writers and clears out the history of writers.
      */
     void flushWriters() {
-        writers.forEach((filename, writer) -> fileManifest.writeFile(filename, writer.toString()));
+        writers.forEach((filename, writer) ->
+                fileManifest.writeFile(filename, writer.toString(IsTypeScriptFileExtension.check(filename))));
         writers.clear();
     }
 

smithy-typescript-codegen/src/main/java/software/amazon/smithy/typescript/codegen/TypeScriptWriter.java

@@ -56,6 +56,7 @@
  */
 @SmithyUnstableApi
 public final class TypeScriptWriter extends CodeWriter {
+    public static final String CODEGEN_INDICATOR = "// smithy-typescript generated code\n";
 
     private static final Logger LOGGER = Logger.getLogger(TypeScriptWriter.class.getName());
 
@@ -292,17 +293,26 @@ Collection<SymbolDependency> getDependencies() {
 
     @Override
     public String toString() {
+        return toString(true);
+    }
+
+    /**
+     * @param withAttribution - whether to include the {@link TypeScriptWriter#CODEGEN_INDICATOR} comment.
+     * @return buffered code string.
+     */
+    public String toString(boolean withAttribution) {
         String contents = super.toString();
         String importString = imports.toString();
         String strippedContents = StringUtils.stripStart(contents, null);
         String strippedImportString = StringUtils.strip(importString, null);
+        String attribution = withAttribution ? CODEGEN_INDICATOR : "";
 
         // Don't add an additional new line between explicit imports and managed imports.
         if (!strippedImportString.isEmpty() && strippedContents.startsWith("import ")) {
-            return strippedImportString + "\n" + strippedContents;
+            return attribution + strippedImportString + "\n" + strippedContents;
         }
 
-        return importString + contents;
+        return attribution + importString + contents;
     }
 
     /**

smithy-typescript-codegen/src/main/java/software/amazon/smithy/typescript/codegen/validation/IsTypeScriptFileExtension.java

@@ -0,0 +1,24 @@
+/*
+ * Copyright 2021 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://aws.amazon.com/apache2.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.
+ */
+
+package software.amazon.smithy.typescript.codegen.validation;
+
+public final class IsTypeScriptFileExtension {
+    private IsTypeScriptFileExtension() {}
+
+    public static boolean check(String fileName) {
+        return fileName != null && (fileName.endsWith(".ts") || fileName.endsWith(".tsx"));
+    }
+}

smithy-typescript-codegen/src/test/java/software/amazon/smithy/typescript/codegen/TypeScriptDelegatorTest.java

@@ -1,11 +1,5 @@
 package software.amazon.smithy.typescript.codegen;
 
-import static org.hamcrest.MatcherAssert.assertThat;
-import static org.hamcrest.Matchers.containsInAnyOrder;
-import static org.hamcrest.Matchers.equalTo;
-
-import java.util.ArrayList;
-import java.util.List;
 import org.junit.jupiter.api.Test;
 import software.amazon.smithy.build.MockManifest;
 import software.amazon.smithy.codegen.core.Symbol;
@@ -17,6 +11,13 @@
 import software.amazon.smithy.utils.ListUtils;
 import software.amazon.smithy.utils.Pair;
 
+import java.util.ArrayList;
+import java.util.List;
+
+import static org.hamcrest.MatcherAssert.assertThat;
+import static org.hamcrest.Matchers.containsInAnyOrder;
+import static org.hamcrest.Matchers.equalTo;
+
 public class TypeScriptDelegatorTest {
     @Test
     public void vendsWritersForShapes() {

smithy-typescript-codegen/src/test/java/software/amazon/smithy/typescript/codegen/TypeScriptJmesPathVisitorTest.java

@@ -5,6 +5,7 @@
 
 import static org.hamcrest.MatcherAssert.assertThat;
 import static org.hamcrest.Matchers.equalTo;
+import static software.amazon.smithy.typescript.codegen.TypeScriptWriter.CODEGEN_INDICATOR;
 
 public class TypeScriptJmesPathVisitorTest {
 
@@ -23,140 +24,140 @@ private String generateTypescriptInterpretation(String path) {
     public void createsSimpleOneLevelIndex() {
         String result = generateTypescriptInterpretation("foo");
         assertThat(result,
-                equalTo("let returnComparator = () => {\n  return result.foo;\n}\n"));
+                equalTo(CODEGEN_INDICATOR + "let returnComparator = () => {\n  return result.foo;\n}\n"));
     }
 
     @Test
     public void createsSimpleTwoLevelIndex() {
         String result = generateTypescriptInterpretation("foo.bar");
         assertThat(result,
-                equalTo("let returnComparator = () => {\n  return result.foo.bar;\n}\n"));
+                equalTo(CODEGEN_INDICATOR + "let returnComparator = () => {\n  return result.foo.bar;\n}\n"));
     }
 
     @Test
     public void createsDeepIndex() {
         String result = generateTypescriptInterpretation("foo.bar.car.gar.foo.bar.car");
         assertThat(result,
-                equalTo("let returnComparator = () => {\n  return result.foo.bar.car.gar.foo.bar.car;\n}\n"));
+                equalTo(CODEGEN_INDICATOR + "let returnComparator = () => {\n  return result.foo.bar.car.gar.foo.bar.car;\n}\n"));
     }
 
     @Test
     public void createsListProfile() {
         String result = generateTypescriptInterpretation("foo.bar[].car");
         assertThat(result,
-                equalTo("let returnComparator = () => {\n  let flat_1: any[] = [].concat(...result.foo.bar);\n  let projection_3 = flat_1.map((element_2: any) => {\n    return element_2.car;\n  });\n  return projection_3;\n}\n"));
+                equalTo(CODEGEN_INDICATOR + "let returnComparator = () => {\n  let flat_1: any[] = [].concat(...result.foo.bar);\n  let projection_3 = flat_1.map((element_2: any) => {\n    return element_2.car;\n  });\n  return projection_3;\n}\n"));
     }
 
     @Test
     public void createsLengthEqualityCheckProfile() {
         String result = generateTypescriptInterpretation("length(items) == `0`");
         assertThat(result,
-                equalTo("let returnComparator = () => {\n  return (result.items.length == 0.0);\n}\n"));
+                equalTo(CODEGEN_INDICATOR + "let returnComparator = () => {\n  return (result.items.length == 0.0);\n}\n"));
     }
 
     @Test
     public void createsLengthLessCheckProfile() {
         String result = generateTypescriptInterpretation("length(items) < `0`");
         assertThat(result,
-                equalTo("let returnComparator = () => {\n  return (result.items.length < 0.0);\n}\n"));
+                equalTo(CODEGEN_INDICATOR + "let returnComparator = () => {\n  return (result.items.length < 0.0);\n}\n"));
     }
 
     @Test
     public void createsLengthGreaterCheckProfile() {
         String result = generateTypescriptInterpretation("length(items) > `0`");
         assertThat(result,
-                equalTo("let returnComparator = () => {\n  return (result.items.length > 0.0);\n}\n"));
+                equalTo(CODEGEN_INDICATOR + "let returnComparator = () => {\n  return (result.items.length > 0.0);\n}\n"));
     }
 
     @Test
     public void createsDeepLengthCheckProfile() {
 
         String result = generateTypescriptInterpretation("length(items.foo.deep[]) == `0`");
         assertThat(result,
-                equalTo("let returnComparator = () => {\n  let flat_1: any[] = [].concat(...result.items.foo.deep);\n  return (flat_1.length == 0.0);\n}\n"));
+                equalTo(CODEGEN_INDICATOR + "let returnComparator = () => {\n  let flat_1: any[] = [].concat(...result.items.foo.deep);\n  return (flat_1.length == 0.0);\n}\n"));
     }
 
     @Test
     public void createsDoubleLengthChecksProfile() {
         String result = generateTypescriptInterpretation("length(set.items[].bar[].gar.foo.items[].item) == length(bar.foos[].foo)");
         assertThat(result,
-                equalTo("let returnComparator = () => {\n  let flat_1: any[] = [].concat(...result.set.items);\n  let projection_3 = flat_1.map((element_2: any) => {\n    return element_2.bar;\n  });\n  let flat_4: any[] = [].concat(...projection_3);\n  let projection_6 = flat_4.map((element_5: any) => {\n    return element_5.gar.foo.items;\n  });\n  let flat_7: any[] = [].concat(...projection_6);\n  let projection_9 = flat_7.map((element_8: any) => {\n    return element_8.item;\n  });\n  let flat_10: any[] = [].concat(...result.bar.foos);\n  let projection_12 = flat_10.map((element_11: any) => {\n    return element_11.foo;\n  });\n  return (projection_9.length == projection_12.length);\n}\n"));
+                equalTo(CODEGEN_INDICATOR + "let returnComparator = () => {\n  let flat_1: any[] = [].concat(...result.set.items);\n  let projection_3 = flat_1.map((element_2: any) => {\n    return element_2.bar;\n  });\n  let flat_4: any[] = [].concat(...projection_3);\n  let projection_6 = flat_4.map((element_5: any) => {\n    return element_5.gar.foo.items;\n  });\n  let flat_7: any[] = [].concat(...projection_6);\n  let projection_9 = flat_7.map((element_8: any) => {\n    return element_8.item;\n  });\n  let flat_10: any[] = [].concat(...result.bar.foos);\n  let projection_12 = flat_10.map((element_11: any) => {\n    return element_11.foo;\n  });\n  return (projection_9.length == projection_12.length);\n}\n"));
     }
 
     @Test
     public void createWrapAroundProfile() {
         String result = generateTypescriptInterpretation("length(items[-1]) == `0`");
         assertThat(result,
-                equalTo("let returnComparator = () => {\n  return (result.items[result.items.length - 1].length == 0.0);\n}\n"));
+                equalTo(CODEGEN_INDICATOR + "let returnComparator = () => {\n  return (result.items[result.items.length - 1].length == 0.0);\n}\n"));
     }
 
     @Test
     public void createContainsProfile() {
         String result = generateTypescriptInterpretation("contains(items[].State, `false`)");
         assertThat(result,
-                equalTo("let returnComparator = () => {\n  let flat_1: any[] = [].concat(...result.items);\n  let projection_3 = flat_1.map((element_2: any) => {\n    return element_2.State;\n  });\n  return projection_3.includes(false);\n}\n"));
+                equalTo(CODEGEN_INDICATOR + "let returnComparator = () => {\n  let flat_1: any[] = [].concat(...result.items);\n  let projection_3 = flat_1.map((element_2: any) => {\n    return element_2.State;\n  });\n  return projection_3.includes(false);\n}\n"));
     }
 
     @Test
     public void createWildcardIndex() {
         String result = generateTypescriptInterpretation("foo.*.bar");
         assertThat(result,
-                equalTo("let returnComparator = () => {\n  let objectProjection_2 = Object.values(result.foo).map((element_1: any) => {\n    return element_1.bar;\n  });\n  return objectProjection_2;\n}\n"));
+                equalTo(CODEGEN_INDICATOR + "let returnComparator = () => {\n  let objectProjection_2 = Object.values(result.foo).map((element_1: any) => {\n    return element_1.bar;\n  });\n  return objectProjection_2;\n}\n"));
     }
 
     @Test
     public void createFilterIndex() {
         String result = generateTypescriptInterpretation("items[?foo=='awesome'][]");
         assertThat(result,
-                equalTo("let returnComparator = () => {\n  let filterRes_2 = result.items.filter((element_1: any) => {\n    return (element_1.foo == \"awesome\");\n  });\n  let flat_3: any[] = [].concat(...filterRes_2);\n  return flat_3;\n}\n"));
+                equalTo(CODEGEN_INDICATOR + "let returnComparator = () => {\n  let filterRes_2 = result.items.filter((element_1: any) => {\n    return (element_1.foo == \"awesome\");\n  });\n  let flat_3: any[] = [].concat(...filterRes_2);\n  return flat_3;\n}\n"));
     }
 
     @Test
     public void createMultiIndex() {
         String result = generateTypescriptInterpretation("items[].[`4` > `0`, `1` == `0`][]");
         assertThat(result,
-                equalTo("let returnComparator = () => {\n  let flat_1: any[] = [].concat(...result.items);\n  let projection_3 = flat_1.map((element_2: any) => {\n    let result_4 = [];\n    result_4.push((4.0 > 0.0));\n    result_4.push((1.0 == 0.0));\n    element_2 = result_4;\n    return element_2;\n  });\n  let flat_5: any[] = [].concat(...projection_3);\n  return flat_5;\n}\n"));
+                equalTo(CODEGEN_INDICATOR + "let returnComparator = () => {\n  let flat_1: any[] = [].concat(...result.items);\n  let projection_3 = flat_1.map((element_2: any) => {\n    let result_4 = [];\n    result_4.push((4.0 > 0.0));\n    result_4.push((1.0 == 0.0));\n    element_2 = result_4;\n    return element_2;\n  });\n  let flat_5: any[] = [].concat(...projection_3);\n  return flat_5;\n}\n"));
     }
 
     @Test
     public void createLengthFilterInstancesIndex() {
         String result = generateTypescriptInterpretation("length(Instances[?LifecycleState==\"InService\"]) >= MinSize");
         assertThat(result,
-                equalTo("let returnComparator = () => {\n  let filterRes_2 = result.Instances.filter((element_1: any) => {\n    return (element_1.LifecycleState == element_1.InService);\n  });\n  return (filterRes_2.length >= result.MinSize);\n}\n"));
+                equalTo(CODEGEN_INDICATOR + "let returnComparator = () => {\n  let filterRes_2 = result.Instances.filter((element_1: any) => {\n    return (element_1.LifecycleState == element_1.InService);\n  });\n  return (filterRes_2.length >= result.MinSize);\n}\n"));
     }
 
     @Test
     public void createComplexLengthFilterContainsIndex() {
         String result = generateTypescriptInterpretation("contains(AutoScalingGroups[].[length(Instances[?LifecycleState=='InService']) >= MinSize][], `false`)");
         assertThat(result,
-                equalTo("let returnComparator = () => {\n  let flat_1: any[] = [].concat(...result.AutoScalingGroups);\n  let projection_3 = flat_1.map((element_2: any) => {\n    let filterRes_5 = element_2.Instances.filter((element_4: any) => {\n      return (element_4.LifecycleState == \"InService\");\n    });\n    let result_6 = [];\n    result_6.push((filterRes_5.length >= element_2.MinSize));\n    element_2 = result_6;\n    return element_2;\n  });\n  let flat_7: any[] = [].concat(...projection_3);\n  return flat_7.includes(false);\n}\n"));
+                equalTo(CODEGEN_INDICATOR + "let returnComparator = () => {\n  let flat_1: any[] = [].concat(...result.AutoScalingGroups);\n  let projection_3 = flat_1.map((element_2: any) => {\n    let filterRes_5 = element_2.Instances.filter((element_4: any) => {\n      return (element_4.LifecycleState == \"InService\");\n    });\n    let result_6 = [];\n    result_6.push((filterRes_5.length >= element_2.MinSize));\n    element_2 = result_6;\n    return element_2;\n  });\n  let flat_7: any[] = [].concat(...projection_3);\n  return flat_7.includes(false);\n}\n"));
     }
 
     @Test
     public void createNotIndex() {
         String result = generateTypescriptInterpretation("!(length(items) == `0`)");
         assertThat(result,
-                equalTo( "let returnComparator = () => {\n  return (!(result.items.length == 0.0));\n}\n"));
+                equalTo(CODEGEN_INDICATOR +  "let returnComparator = () => {\n  return (!(result.items.length == 0.0));\n}\n"));
     }
 
     @Test
     public void createOrIndex() {
         String result = generateTypescriptInterpretation("length(items[]) == `0` || length(foo) > `0`");
         assertThat(result,
-                equalTo("let returnComparator = () => {\n  let flat_1: any[] = [].concat(...result.items);\n  return (((flat_1.length == 0.0) || (result.foo.length > 0.0)) && ((result.foo.length > 0.0) || (flat_1.length == 0.0))) ;\n}\n"));
+                equalTo(CODEGEN_INDICATOR + "let returnComparator = () => {\n  let flat_1: any[] = [].concat(...result.items);\n  return (((flat_1.length == 0.0) || (result.foo.length > 0.0)) && ((result.foo.length > 0.0) || (flat_1.length == 0.0))) ;\n}\n"));
     }
 
     @Test
     public void createAndIndex() {
         String result = generateTypescriptInterpretation("length(items[]) == `0` && length(foo) > `0`");
         assertThat(result,
-                equalTo("let returnComparator = () => {\n  let flat_1: any[] = [].concat(...result.items);\n  return ((flat_1.length == 0.0) && (result.foo.length > 0.0));\n}\n"));
+                equalTo(CODEGEN_INDICATOR + "let returnComparator = () => {\n  let flat_1: any[] = [].concat(...result.items);\n  return ((flat_1.length == 0.0) && (result.foo.length > 0.0));\n}\n"));
     }
 
     @Test
     public void createComplexAndNotIndex() {
         String result = generateTypescriptInterpretation("(length(services[?!(length(deployments) == `1` && runningCount == desiredCount)]) == `0`)");
         assertThat(result,
-                equalTo("let returnComparator = () => {\n  let filterRes_2 = result.services.filter((element_1: any) => {\n    return (!((element_1.deployments.length == 1.0) && (element_1.runningCount == element_1.desiredCount)));\n  });\n  return (filterRes_2.length == 0.0);\n}\n"));
+                equalTo(CODEGEN_INDICATOR + "let returnComparator = () => {\n  let filterRes_2 = result.services.filter((element_1: any) => {\n    return (!((element_1.deployments.length == 1.0) && (element_1.runningCount == element_1.desiredCount)));\n  });\n  return (filterRes_2.length == 0.0);\n}\n"));
     }
 }

smithy-typescript-codegen/src/test/java/software/amazon/smithy/typescript/codegen/TypeScriptWriterTest.java

@@ -2,6 +2,7 @@
 
 import static org.hamcrest.MatcherAssert.assertThat;
 import static org.hamcrest.Matchers.equalTo;
+import static software.amazon.smithy.typescript.codegen.TypeScriptWriter.CODEGEN_INDICATOR;
 
 import org.junit.jupiter.api.Test;
 
@@ -12,7 +13,7 @@ public void writesDocStrings() {
         writer.writeDocs("These are the docs.\nMore.");
         String result = writer.toString();
 
-        assertThat(result, equalTo("/**\n * These are the docs.\n * More.\n */\n"));
+        assertThat(result, equalTo(CODEGEN_INDICATOR + "/**\n * These are the docs.\n * More.\n */\n"));
     }
 
     @Test
@@ -22,7 +23,7 @@ public void doesNotAddNewlineBetweenManagedAndExplicitImports() {
         writer.addImport("Baz", "Baz", "hello");
         String result = writer.toString();
 
-        assertThat(result, equalTo("import { Baz } from \"hello\";\nimport { Foo } from \"baz\";\n"));
+        assertThat(result, equalTo(CODEGEN_INDICATOR + "import { Baz } from \"hello\";\nimport { Foo } from \"baz\";\n"));
     }
 
     @Test
@@ -33,7 +34,7 @@ public void escapesDollarInDocStrings() {
         writer.writeDocs(docs);
         String result = writer.toString();
 
-        assertThat(result, equalTo("/**\n * " + docs + "\n */\n"));
+        assertThat(result, equalTo(CODEGEN_INDICATOR + "/**\n * " + docs + "\n */\n"));
     }
 
     @Test
@@ -44,7 +45,7 @@ public void escapesMultiLineCloseInDocStrings() {
         writer.writeDocs(docs);
         String result = writer.toString();
 
-        assertThat(result, equalTo("/**\n * This is *\\/ valid documentation.\n */\n"));
+        assertThat(result, equalTo(CODEGEN_INDICATOR + "/**\n * This is *\\/ valid documentation.\n */\n"));
     }
 
     @Test