use package files entry instead of .npmignore (#326)

* do not generate .npmignore * add files entry to generated package.json * update test snapshots * cleanup: remove example options not needed from template arguments in lib/lib.js (example options are still used to render example artifacts)
brodycj · May 4, 2020 · 91369fe · 91369fe
1 parent a89916d
commit 91369fe
Show file tree

Hide file tree

Showing 33 changed files with 204 additions and 255 deletions.
diff --git a/lib/lib.js b/lib/lib.js
@@ -181,9 +181,6 @@ Android packageIdentifier: ${packageIdentifier}
           license,
           view,
           useAppleNetworking,
-          generateExample,
-          exampleFileLinkage,
-          exampleName,
         };
 
         return renderTemplateIfValid(fs, moduleName, template, templateArgs);

diff --git a/templates/general.js b/templates/general.js
@@ -22,6 +22,17 @@ ${name};
 }, {
   name: () => 'package.json',
   content: ({ moduleName, platforms, githubAccount, authorName, authorEmail, license }) => {
+    const files =
+      `[
+    "README.md",` +
+    (platforms.indexOf('android') >= 0 ? `
+    "android",` : ``) + `
+    "index.js"` +
+    (platforms.indexOf('ios') >= 0 ? `,
+    "ios",
+    "${moduleName}.podspec"` : ``) + `
+  ]`;
+
     const peerDependencies =
       `{
     "react": "^16.8.1",
@@ -40,6 +51,7 @@ ${name};
   "version": "1.0.0",
   "description": "TODO",
   "main": "index.js",
+  "files": ${files},
   "scripts": {
     "test": "echo \\"Error: no test specified\\" && exit 1"
   },
@@ -149,15 +161,6 @@ buck-out/
       return '*.pbxproj -text\n';
     }
 
-    return '';
-  }
-}, {
-  name: () => '.npmignore',
-  content: ({ generateExample, exampleName }) => {
-    if (generateExample) {
-      return `${exampleName}\n`;
-    }
-
     return '';
   }
 }];
diff --git a/tests/integration/cli/create/view/__snapshots__/cli-create-with-view.test.js.snap b/tests/integration/cli/create/view/__snapshots__/cli-create-with-view.test.js.snap
@@ -53,10 +53,6 @@ buck-out/
 *.keystore
 ",
   },
-  Object {
-    "name": "react-native-integration-view-test-package/.npmignore",
-    "theContent": "",
-  },
   Object {
     "name": "react-native-integration-view-test-package/README.md",
     "theContent": "# react-native-integration-view-test-package
@@ -649,6 +645,13 @@ RCT_EXPORT_MODULE()
   \\"version\\": \\"1.0.0\\",
   \\"description\\": \\"TODO\\",
   \\"main\\": \\"index.js\\",
+  \\"files\\": [
+    \\"README.md\\",
+    \\"android\\",
+    \\"index.js\\",
+    \\"ios\\",
+    \\"react-native-integration-view-test-package.podspec\\"
+  ],
   \\"scripts\\": {
     \\"test\\": \\"echo \\\\\\"Error: no test specified\\\\\\" && exit 1\\"
   },

diff --git a/.../integration/cli/create/with-defaults/__snapshots__/cli-create-with-defaults.test.js.snap b/.../integration/cli/create/with-defaults/__snapshots__/cli-create-with-defaults.test.js.snap
@@ -53,10 +53,6 @@ buck-out/
 *.keystore
 ",
   },
-  Object {
-    "name": "react-native-integration-test-package/.npmignore",
-    "theContent": "",
-  },
   Object {
     "name": "react-native-integration-test-package/README.md",
     "theContent": "# react-native-integration-test-package
@@ -645,6 +641,13 @@ RCT_EXPORT_METHOD(sampleMethod:(NSString *)stringArgument numberParameter:(nonnu
   \\"version\\": \\"1.0.0\\",
   \\"description\\": \\"TODO\\",
   \\"main\\": \\"index.js\\",
+  \\"files\\": [
+    \\"README.md\\",
+    \\"android\\",
+    \\"index.js\\",
+    \\"ios\\",
+    \\"react-native-integration-test-package.podspec\\"
+  ],
   \\"scripts\\": {
     \\"test\\": \\"echo \\\\\\"Error: no test specified\\\\\\" && exit 1\\"
   },

diff --git a/...-injection/create/view/with-defaults/__snapshots__/create-view-with-defaults.test.js.snap b/...-injection/create/view/with-defaults/__snapshots__/create-view-with-defaults.test.js.snap
@@ -13,8 +13,6 @@ Array [
   "* ensureDir dir: react-native-alice-bobbi/
 ",
   "* ensureDir dir: react-native-alice-bobbi/
-",
-  "* ensureDir dir: react-native-alice-bobbi/
 ",
   "* ensureDir dir: react-native-alice-bobbi/android/
 ",
@@ -68,6 +66,13 @@ content:
   \\"version\\": \\"1.0.0\\",
   \\"description\\": \\"TODO\\",
   \\"main\\": \\"index.js\\",
+  \\"files\\": [
+    \\"README.md\\",
+    \\"android\\",
+    \\"index.js\\",
+    \\"ios\\",
+    \\"react-native-alice-bobbi.podspec\\"
+  ],
   \\"scripts\\": {
     \\"test\\": \\"echo \\\\\\"Error: no test specified\\\\\\" && exit 1\\"
   },
@@ -162,12 +167,6 @@ content:
 --------
 *.pbxproj -text
 
-<<<<<<<< ======== >>>>>>>>
-",
-  "* outputFile name: react-native-alice-bobbi/.npmignore
-content:
---------
-
 <<<<<<<< ======== >>>>>>>>
 ",
   "* outputFile name: react-native-alice-bobbi/android/build.gradle

diff --git a/...h-example/with-defaults/__snapshots__/create-view-with-example-with-defaults.test.js.snap b/...h-example/with-defaults/__snapshots__/create-view-with-example-with-defaults.test.js.snap
@@ -17,8 +17,6 @@ Array [
   "* ensureDir dir: react-native-alice-bobbi/
 ",
   "* ensureDir dir: react-native-alice-bobbi/
-",
-  "* ensureDir dir: react-native-alice-bobbi/
 ",
   "* ensureDir dir: react-native-alice-bobbi/android/
 ",
@@ -72,6 +70,13 @@ content:
   \\"version\\": \\"1.0.0\\",
   \\"description\\": \\"TODO\\",
   \\"main\\": \\"index.js\\",
+  \\"files\\": [
+    \\"README.md\\",
+    \\"android\\",
+    \\"index.js\\",
+    \\"ios\\",
+    \\"react-native-alice-bobbi.podspec\\"
+  ],
   \\"scripts\\": {
     \\"test\\": \\"echo \\\\\\"Error: no test specified\\\\\\" && exit 1\\"
   },
@@ -166,13 +171,6 @@ content:
 --------
 *.pbxproj -text
 
-<<<<<<<< ======== >>>>>>>>
-",
-  "* outputFile name: react-native-alice-bobbi/.npmignore
-content:
---------
-example
-
 <<<<<<<< ======== >>>>>>>>
 ",
   "* outputFile name: react-native-alice-bobbi/android/build.gradle

diff --git a/...ith-example/with-options/__snapshots__/create-view-with-example-with-options.test.js.snap b/...ith-example/with-options/__snapshots__/create-view-with-example-with-options.test.js.snap
@@ -17,8 +17,6 @@ Array [
   "* ensureDir dir: react-native-alice-bobbi/
 ",
   "* ensureDir dir: react-native-alice-bobbi/
-",
-  "* ensureDir dir: react-native-alice-bobbi/
 ",
   "* ensureDir dir: react-native-alice-bobbi/android/
 ",
@@ -72,6 +70,13 @@ content:
   \\"version\\": \\"1.0.0\\",
   \\"description\\": \\"TODO\\",
   \\"main\\": \\"index.js\\",
+  \\"files\\": [
+    \\"README.md\\",
+    \\"android\\",
+    \\"index.js\\",
+    \\"ios\\",
+    \\"react-native-alice-bobbi.podspec\\"
+  ],
   \\"scripts\\": {
     \\"test\\": \\"echo \\\\\\"Error: no test specified\\\\\\" && exit 1\\"
   },
@@ -166,13 +171,6 @@ content:
 --------
 *.pbxproj -text
 
-<<<<<<<< ======== >>>>>>>>
-",
-  "* outputFile name: react-native-alice-bobbi/.npmignore
-content:
---------
-test-demo
-
 <<<<<<<< ======== >>>>>>>>
 ",
   "* outputFile name: react-native-alice-bobbi/android/build.gradle

diff --git a/.../view/with-options/for-android/__snapshots__/lib-view-android-config-options.test.js.snap b/.../view/with-options/for-android/__snapshots__/lib-view-android-config-options.test.js.snap
@@ -13,8 +13,6 @@ Array [
   "* ensureDir dir: react-native-alice-bobbi/
 ",
   "* ensureDir dir: react-native-alice-bobbi/
-",
-  "* ensureDir dir: react-native-alice-bobbi/
 ",
   "* ensureDir dir: react-native-alice-bobbi/android/
 ",
@@ -58,6 +56,11 @@ content:
   \\"version\\": \\"1.0.0\\",
   \\"description\\": \\"TODO\\",
   \\"main\\": \\"index.js\\",
+  \\"files\\": [
+    \\"README.md\\",
+    \\"android\\",
+    \\"index.js\\"
+  ],
   \\"scripts\\": {
     \\"test\\": \\"echo \\\\\\"Error: no test specified\\\\\\" && exit 1\\"
   },
@@ -131,12 +134,6 @@ buck-out/
 content:
 --------
 
-<<<<<<<< ======== >>>>>>>>
-",
-  "* outputFile name: react-native-alice-bobbi/.npmignore
-content:
---------
-
 <<<<<<<< ======== >>>>>>>>
 ",
   "* outputFile name: react-native-alice-bobbi/android/build.gradle

diff --git a/...ate/view/with-options/for-ios/__snapshots__/create-view-with-options-for-ios.test.js.snap b/...ate/view/with-options/for-ios/__snapshots__/create-view-with-options-for-ios.test.js.snap
@@ -15,8 +15,6 @@ Array [
   "* ensureDir dir: react-native-alice-bobbi/
 ",
   "* ensureDir dir: react-native-alice-bobbi/
-",
-  "* ensureDir dir: react-native-alice-bobbi/
 ",
   "* ensureDir dir: react-native-alice-bobbi/ios/
 ",
@@ -58,6 +56,12 @@ content:
   \\"version\\": \\"1.0.0\\",
   \\"description\\": \\"TODO\\",
   \\"main\\": \\"index.js\\",
+  \\"files\\": [
+    \\"README.md\\",
+    \\"index.js\\",
+    \\"ios\\",
+    \\"react-native-alice-bobbi.podspec\\"
+  ],
   \\"scripts\\": {
     \\"test\\": \\"echo \\\\\\"Error: no test specified\\\\\\" && exit 1\\"
   },
@@ -139,12 +143,6 @@ content:
 --------
 *.pbxproj -text
 
-<<<<<<<< ======== >>>>>>>>
-",
-  "* outputFile name: react-native-alice-bobbi/.npmignore
-content:
---------
-
 <<<<<<<< ======== >>>>>>>>
 ",
   "* outputFile name: react-native-alice-bobbi/react-native-alice-bobbi.podspec

diff --git a/tests/with-injection/create/with-defaults/__snapshots__/create-with-defaults.test.js.snap b/tests/with-injection/create/with-defaults/__snapshots__/create-with-defaults.test.js.snap
@@ -13,8 +13,6 @@ Array [
   "* ensureDir dir: react-native-alice-bobbi/
 ",
   "* ensureDir dir: react-native-alice-bobbi/
-",
-  "* ensureDir dir: react-native-alice-bobbi/
 ",
   "* ensureDir dir: react-native-alice-bobbi/android/
 ",
@@ -68,6 +66,13 @@ content:
   \\"version\\": \\"1.0.0\\",
   \\"description\\": \\"TODO\\",
   \\"main\\": \\"index.js\\",
+  \\"files\\": [
+    \\"README.md\\",
+    \\"android\\",
+    \\"index.js\\",
+    \\"ios\\",
+    \\"react-native-alice-bobbi.podspec\\"
+  ],
   \\"scripts\\": {
     \\"test\\": \\"echo \\\\\\"Error: no test specified\\\\\\" && exit 1\\"
   },
@@ -162,12 +167,6 @@ content:
 --------
 *.pbxproj -text
 
-<<<<<<<< ======== >>>>>>>>
-",
-  "* outputFile name: react-native-alice-bobbi/.npmignore
-content:
---------
-
 <<<<<<<< ======== >>>>>>>>
 ",
   "* outputFile name: react-native-alice-bobbi/android/build.gradle

diff --git a/.../with-defaults/bogus-platforms/bogus-name/__snapshots__/bogus-platforms-name.test.js.snap b/.../with-defaults/bogus-platforms/bogus-name/__snapshots__/bogus-platforms-name.test.js.snap
@@ -13,8 +13,6 @@ Array [
   "* ensureDir dir: react-native-alice-bobbi/
 ",
   "* ensureDir dir: react-native-alice-bobbi/
-",
-  "* ensureDir dir: react-native-alice-bobbi/
 ",
   "* outputFile name: react-native-alice-bobbi/README.md
 content:
@@ -48,6 +46,10 @@ content:
   \\"version\\": \\"1.0.0\\",
   \\"description\\": \\"TODO\\",
   \\"main\\": \\"index.js\\",
+  \\"files\\": [
+    \\"README.md\\",
+    \\"index.js\\"
+  ],
   \\"scripts\\": {
     \\"test\\": \\"echo \\\\\\"Error: no test specified\\\\\\" && exit 1\\"
   },
@@ -108,12 +110,6 @@ yarn-error.log
 content:
 --------
 
-<<<<<<<< ======== >>>>>>>>
-",
-  "* outputFile name: react-native-alice-bobbi/.npmignore
-content:
---------
-
 <<<<<<<< ======== >>>>>>>>
 ",
 ]

diff --git a/...faults/bogus-platforms/empty-array/__snapshots__/bogus-platforms-empty-array.test.js.snap b/...faults/bogus-platforms/empty-array/__snapshots__/bogus-platforms-empty-array.test.js.snap
@@ -13,8 +13,6 @@ Array [
   "* ensureDir dir: react-native-alice-bobbi/
 ",
   "* ensureDir dir: react-native-alice-bobbi/
-",
-  "* ensureDir dir: react-native-alice-bobbi/
 ",
   "* outputFile name: react-native-alice-bobbi/README.md
 content:
@@ -48,6 +46,10 @@ content:
   \\"version\\": \\"1.0.0\\",
   \\"description\\": \\"TODO\\",
   \\"main\\": \\"index.js\\",
+  \\"files\\": [
+    \\"README.md\\",
+    \\"index.js\\"
+  ],
   \\"scripts\\": {
     \\"test\\": \\"echo \\\\\\"Error: no test specified\\\\\\" && exit 1\\"
   },
@@ -108,12 +110,6 @@ yarn-error.log
 content:
 --------
 
-<<<<<<<< ======== >>>>>>>>
-",
-  "* outputFile name: react-native-alice-bobbi/.npmignore
-content:
---------
-
 <<<<<<<< ======== >>>>>>>>
 ",
 ]