refactor: add comment to main generated index.js (#413)

* add comment to main generated index.js
* update test snapshots

Author: Chris Brody

templates/general.js

@@ -79,7 +79,9 @@ ${objectClassName};
   // for module without view:
   name: ({ view }) => !view && 'index.js',
   content: ({ objectClassName }) =>
-    `import { NativeModules } from 'react-native';
+    `// main index.js
+
+import { NativeModules } from 'react-native';
 
 const { ${objectClassName} } = NativeModules;
 
@@ -89,7 +91,9 @@ export default ${objectClassName};
   // for module with view:
   name: ({ view }) => view && 'index.js',
   content: ({ objectClassName }) =>
-    `import { requireNativeComponent } from 'react-native';
+    `// main index.js
+
+import { requireNativeComponent } from 'react-native';
 
 const ${objectClassName} = requireNativeComponent('${objectClassName}', null);
 

tests/integration/cli/create/view/__snapshots__/cli-create-with-view.test.js.snap

@@ -305,7 +305,9 @@ public class IntegrationViewTestPackagePackage implements ReactPackage {
   },
   Object {
     "name": "react-native-integration-view-test-package/index.js",
-    "theContent": "import { requireNativeComponent } from 'react-native';
+    "theContent": "// main index.js
+
+import { requireNativeComponent } from 'react-native';
 
 const IntegrationViewTestPackage = requireNativeComponent('IntegrationViewTestPackage', null);
 

tests/integration/cli/create/with-defaults/__snapshots__/cli-create-with-defaults.test.js.snap

@@ -306,7 +306,9 @@ public class IntegrationTestPackagePackage implements ReactPackage {
   },
   Object {
     "name": "react-native-integration-test-package/index.js",
-    "theContent": "import { NativeModules } from 'react-native';
+    "theContent": "// main index.js
+
+import { NativeModules } from 'react-native';
 
 const { IntegrationTestPackage } = NativeModules;
 

tests/with-injection/create/view/with-defaults/__snapshots__/create-view-with-defaults.test.js.snap

@@ -104,6 +104,8 @@ content:
   "* outputFile name: react-native-alice-bobbi/index.js
 content:
 --------
+// main index.js
+
 import { requireNativeComponent } from 'react-native';
 
 const AliceBobbi = requireNativeComponent('AliceBobbi', null);

tests/with-injection/create/view/with-example/with-defaults/__snapshots__/create-view-with-example-with-defaults.test.js.snap

@@ -108,6 +108,8 @@ content:
   "* outputFile name: react-native-alice-bobbi/index.js
 content:
 --------
+// main index.js
+
 import { requireNativeComponent } from 'react-native';
 
 const AliceBobbi = requireNativeComponent('AliceBobbi', null);

tests/with-injection/create/view/with-example/with-options/__snapshots__/create-view-with-example-with-options.test.js.snap

@@ -108,6 +108,8 @@ content:
   "* outputFile name: react-native-alice-bobbi/index.js
 content:
 --------
+// main index.js
+
 import { requireNativeComponent } from 'react-native';
 
 const AliceBobbi = requireNativeComponent('AliceBobbi', null);

tests/with-injection/create/view/with-options/for-android/__snapshots__/lib-view-android-config-options.test.js.snap

@@ -92,6 +92,8 @@ content:
   "* outputFile name: react-native-alice-bobbi/index.js
 content:
 --------
+// main index.js
+
 import { requireNativeComponent } from 'react-native';
 
 const AliceBobbi = requireNativeComponent('AliceBobbi', null);

tests/with-injection/create/view/with-options/for-ios/__snapshots__/create-view-with-options-for-ios.test.js.snap

@@ -93,6 +93,8 @@ content:
   "* outputFile name: react-native-alice-bobbi/index.js
 content:
 --------
+// main index.js
+
 import { requireNativeComponent } from 'react-native';
 
 const AliceBobbi = requireNativeComponent('AliceBobbi', null);

tests/with-injection/create/with-defaults/__snapshots__/create-with-defaults.test.js.snap

@@ -104,6 +104,8 @@ content:
   "* outputFile name: react-native-alice-bobbi/index.js
 content:
 --------
+// main index.js
+
 import { NativeModules } from 'react-native';
 
 const { AliceBobbi } = NativeModules;

tests/with-injection/create/with-defaults/bogus-platforms/bogus-name/__snapshots__/bogus-platforms-name.test.js.snap

@@ -81,6 +81,8 @@ content:
   "* outputFile name: react-native-alice-bobbi/index.js
 content:
 --------
+// main index.js
+
 import { NativeModules } from 'react-native';
 
 const { AliceBobbi } = NativeModules;

tests/with-injection/create/with-defaults/bogus-platforms/empty-array/__snapshots__/bogus-platforms-empty-array.test.js.snap

@@ -81,6 +81,8 @@ content:
   "* outputFile name: react-native-alice-bobbi/index.js
 content:
 --------
+// main index.js
+
 import { NativeModules } from 'react-native';
 
 const { AliceBobbi } = NativeModules;

tests/with-injection/create/with-defaults/bogus-platforms/empty-string/__snapshots__/bogus-platforms-empty-string.test.js.snap

@@ -81,6 +81,8 @@ content:
   "* outputFile name: react-native-alice-bobbi/index.js
 content:
 --------
+// main index.js
+
 import { NativeModules } from 'react-native';
 
 const { AliceBobbi } = NativeModules;

tests/with-injection/create/with-example/for-android-only/__snapshots__/create-with-example-for-android-only.test.js.snap

@@ -96,6 +96,8 @@ content:
   "* outputFile name: react-native-alice-bobbi/index.js
 content:
 --------
+// main index.js
+
 import { NativeModules } from 'react-native';
 
 const { AliceBobbi } = NativeModules;

tests/with-injection/create/with-example/with-defaults/__snapshots__/create-with-example-with-defaults.test.js.snap

@@ -108,6 +108,8 @@ content:
   "* outputFile name: react-native-alice-bobbi/index.js
 content:
 --------
+// main index.js
+
 import { NativeModules } from 'react-native';
 
 const { AliceBobbi } = NativeModules;

tests/with-injection/create/with-example/with-missing-package-scripts/__snapshots__/recover-from-missing-package-scripts.test.js.snap

@@ -108,6 +108,8 @@ content:
   "* outputFile name: react-native-alice-bobbi/index.js
 content:
 --------
+// main index.js
+
 import { NativeModules } from 'react-native';
 
 const { AliceBobbi } = NativeModules;

tests/with-injection/create/with-example/with-null-options/with-null-prefix/__snapshots__/create-with-example-with-null-prefix.test.js.snap

@@ -108,6 +108,8 @@ content:
   "* outputFile name: react-native-alice-bobbi/index.js
 content:
 --------
+// main index.js
+
 import { NativeModules } from 'react-native';
 
 const { AliceBobbi } = NativeModules;

tests/with-injection/create/with-example/with-options/__snapshots__/create-with-example-with-options.test.js.snap

@@ -108,6 +108,8 @@ content:
   "* outputFile name: react-native-alice-bobbi/index.js
 content:
 --------
+// main index.js
+
 import { NativeModules } from 'react-native';
 
 const { SuperAwesomeModule } = NativeModules;

tests/with-injection/create/with-name-in-camel-case/__snapshots__/create-with-name-in-camel-case.test.js.snap

@@ -104,6 +104,8 @@ content:
   "* outputFile name: react-native-alice-bobbi/index.js
 content:
 --------
+// main index.js
+
 import { NativeModules } from 'react-native';
 
 const { AliceBobbi } = NativeModules;

tests/with-injection/create/with-options/for-android/__snapshots__/create-with-options-for-android.test.js.snap

@@ -92,6 +92,8 @@ content:
   "* outputFile name: react-native-alice-bobbi/index.js
 content:
 --------
+// main index.js
+
 import { NativeModules } from 'react-native';
 
 const { AliceBobbi } = NativeModules;

tests/with-injection/create/with-options/for-ios/__snapshots__/create-with-options-for-ios.test.js.snap

@@ -93,6 +93,8 @@ content:
   "* outputFile name: react-native-alice-bobbi/index.js
 content:
 --------
+// main index.js
+
 import { NativeModules } from 'react-native';
 
 const { AliceBobbi } = NativeModules;

tests/with-injection/create/with-options/platforms-array/__snapshots__/platforms-array.test.js.snap

@@ -104,6 +104,8 @@ content:
   "* outputFile name: react-native-alice-bobbi/index.js
 content:
 --------
+// main index.js
+
 import { NativeModules } from 'react-native';
 
 const { ABCAliceBobbi } = NativeModules;

tests/with-injection/create/with-options/platforms-comma-separated/__snapshots__/platforms-comma-separated.test.js.snap

@@ -104,6 +104,8 @@ content:
   "* outputFile name: react-native-alice-bobbi/index.js
 content:
 --------
+// main index.js
+
 import { NativeModules } from 'react-native';
 
 const { AliceBobbi } = NativeModules;

tests/with-injection/create/with-options/with-custom-module-prefix/__snapshots__/create-with-custom-module-prefix.test.js.snap

@@ -104,6 +104,8 @@ content:
   "* outputFile name: custom-native-alice-bobbi/index.js
 content:
 --------
+// main index.js
+
 import { NativeModules } from 'react-native';
 
 const { AliceBobbi } = NativeModules;

tests/with-injection/create/with-options/with-module-name/__snapshots__/create-with-module-name.test.js.snap

@@ -104,6 +104,8 @@ content:
   "* outputFile name: custom-native-module/index.js
 content:
 --------
+// main index.js
+
 import { NativeModules } from 'react-native';
 
 const { AliceBobbi } = NativeModules;

tests/with-mocks/cli/command/action-func/with-logging/with-bogus-platforms/bogus-name/__snapshots__/cli-command-with-bogus-platforms-name.test.js.snap

@@ -114,7 +114,9 @@ AliceBobbi;
   },
   Object {
     "outputFileName": "react-native-alice-bobbi/index.js",
-    "theContent": "import { NativeModules } from 'react-native';
+    "theContent": "// main index.js
+
+import { NativeModules } from 'react-native';
 
 const { AliceBobbi } = NativeModules;
 

tests/with-mocks/cli/command/action-func/with-logging/with-bogus-platforms/empty-string/__snapshots__/cli-command-with-empty-platforms-string.test.js.snap

@@ -114,7 +114,9 @@ AliceBobbi;
   },
   Object {
     "outputFileName": "react-native-alice-bobbi/index.js",
-    "theContent": "import { NativeModules } from 'react-native';
+    "theContent": "// main index.js
+
+import { NativeModules } from 'react-native';
 
 const { AliceBobbi } = NativeModules;
 

tests/with-mocks/cli/command/action-func/with-options/__snapshots__/cli-command-func-with-options.test.js.snap

@@ -114,7 +114,9 @@ AliceBobbi;
   },
   Object {
     "outputFileName": "react-native-alice-bobbi/index.js",
-    "theContent": "import { NativeModules } from 'react-native';
+    "theContent": "// main index.js
+
+import { NativeModules } from 'react-native';
 
 const { AliceBobbi } = NativeModules;
 

tests/with-mocks/cli/program/with-defaults/for-android/__snapshots__/cli-program-with-defaults-for-android.test.js.snap

@@ -311,7 +311,9 @@ TestPackage;
   },
   Object {
     "outputFileName": "react-native-test-package/index.js",
-    "theContent": "import { NativeModules } from 'react-native';
+    "theContent": "// main index.js
+
+import { NativeModules } from 'react-native';
 
 const { TestPackage } = NativeModules;
 

tests/with-mocks/cli/program/with-example/with-logging/__snapshots__/cli-program-with-example-with-logging.test.js.snap

@@ -399,7 +399,9 @@ TestPackage;
   },
   Object {
     "outputFileName": "react-native-test-package/index.js",
-    "theContent": "import { NativeModules } from 'react-native';
+    "theContent": "// main index.js
+
+import { NativeModules } from 'react-native';
 
 const { TestPackage } = NativeModules;
 

tests/with-mocks/lib/create/with-example/with-logging/with-defaults/__snapshots__/create-with-example-with-defaults.test.js.snap

@@ -185,7 +185,9 @@ AliceBobbi;
   },
   Object {
     "outputFileName": "react-native-alice-bobbi/index.js",
-    "theContent": "import { NativeModules } from 'react-native';
+    "theContent": "// main index.js
+
+import { NativeModules } from 'react-native';
 
 const { AliceBobbi } = NativeModules;
 

tests/with-mocks/lib/create/with-example/with-logging/with-error/__snapshots__/with-yarn-error-logging.test.js.snap

@@ -185,7 +185,9 @@ AliceBobbi;
   },
   Object {
     "outputFileName": "react-native-alice-bobbi/index.js",
-    "theContent": "import { NativeModules } from 'react-native';
+    "theContent": "// main index.js
+
+import { NativeModules } from 'react-native';
 
 const { AliceBobbi } = NativeModules;
 

tests/with-mocks/lib/create/with-example/with-logging/with-null-options/with-null-prefix/__snapshots__/create-with-example-with-options.test.js.snap

@@ -185,7 +185,9 @@ AliceBobbi;
   },
   Object {
     "outputFileName": "react-native-alice-bobbi/index.js",
-    "theContent": "import { NativeModules } from 'react-native';
+    "theContent": "// main index.js
+
+import { NativeModules } from 'react-native';
 
 const { AliceBobbi } = NativeModules;
 

tests/with-mocks/lib/create/with-example/with-logging/with-options/__snapshots__/create-with-example-with-options.test.js.snap

@@ -179,7 +179,9 @@ ABCAliceBobbi;
   },
   Object {
     "outputFileName": "react-native-alice-bobbi/index.js",
-    "theContent": "import { NativeModules } from 'react-native';
+    "theContent": "// main index.js
+
+import { NativeModules } from 'react-native';
 
 const { ABCAliceBobbi } = NativeModules;