From 9eae9be69545cd905e6d9cb977bd6d9d9a95cd73 Mon Sep 17 00:00:00 2001
From: Jannis Pohlmann <jannis@thegraph.com>
Date: Fri, 10 May 2019 14:53:23 +0200
Subject: [PATCH] type-generator: Add note at the top of all generated files
 (#212)

This should make it more obvious that generated files are not to be
messed with; unless you know what you're doing.
---
 src/type-generator.js | 23 ++++++++++++++++-------
 1 file changed, 16 insertions(+), 7 deletions(-)

diff --git a/src/type-generator.js b/src/type-generator.js
index 51d4795ff..0c00441e6 100644
--- a/src/type-generator.js
+++ b/src/type-generator.js
@@ -14,6 +14,10 @@ const Watcher = require('./watcher')
 const { step, withSpinner } = require('./command-helpers/spinner')
 const { applyMigrations } = require('./migrations')
 
+const GENERATED_FILE_NOTE = `
+// THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY.
+`
+
 module.exports = class TypeGenerator {
   constructor(options) {
     this.options = options || {}
@@ -168,9 +172,11 @@ module.exports = class TypeGenerator {
 
       let codeGenerator = abi.abi.codeGenerator()
       let code = prettier.format(
-        [...codeGenerator.generateModuleImports(), ...codeGenerator.generateTypes()].join(
-          '\n',
-        ),
+        [
+          GENERATED_FILE_NOTE,
+          ...codeGenerator.generateModuleImports(),
+          ...codeGenerator.generateTypes(),
+        ].join('\n'),
         {
           parser: 'typescript',
         },
@@ -201,9 +207,11 @@ module.exports = class TypeGenerator {
 
       let codeGenerator = abi.abi.codeGenerator()
       let code = prettier.format(
-        [...codeGenerator.generateModuleImports(), ...codeGenerator.generateTypes()].join(
-          '\n',
-        ),
+        [
+          GENERATED_FILE_NOTE,
+          ...codeGenerator.generateModuleImports(),
+          ...codeGenerator.generateTypes(),
+        ].join('\n'),
         {
           parser: 'typescript',
         },
@@ -249,6 +257,7 @@ module.exports = class TypeGenerator {
         let codeGenerator = schema.codeGenerator()
         let code = prettier.format(
           [
+            GENERATED_FILE_NOTE,
             ...codeGenerator.generateModuleImports(),
             ...codeGenerator.generateTypes(),
           ].join('\n'),
@@ -288,7 +297,7 @@ module.exports = class TypeGenerator {
       }, immutable.List())
 
     if (!codeSegments.isEmpty()) {
-      let code = prettier.format(codeSegments.join('\n'), {
+      let code = prettier.format([GENERATED_FILE_NOTE, ...codeSegments].join('\n'), {
         parser: 'typescript',
       })