Remove explicit README and LICENSE from files array

jpmorganchase · Nov 15, 2022 · bff7fe1 · bff7fe1
1 parent 4e9aa65
commit bff7fe1
Show file tree

Hide file tree

Showing 9 changed files with 14 additions and 15 deletions.
diff --git a/.changeset/tall-turtles-think.md b/.changeset/tall-turtles-think.md
@@ -0,0 +1,10 @@
+---
+'modular-scripts': patch
+'modular-template-app': patch
+'modular-template-esm-view': patch
+'modular-template-node-env-app': patch
+'modular-template-package': patch
+'modular-template-view': patch
+---
+
+Remove explicit package.json and license entry in files array
diff --git a/packages/modular-scripts/src/__tests__/build.test.ts b/packages/modular-scripts/src/__tests__/build.test.ts
@@ -32,8 +32,6 @@ describe('WHEN building with preserve modules', () => {
           "dist-cjs",
           "dist-es",
           "dist-types",
-          "README.md",
-          "LICENSE",
         ],
         "main": "dist-cjs/index.js",
         "modular": Object {

diff --git a/packages/modular-scripts/src/__tests__/index.test.ts b/packages/modular-scripts/src/__tests__/index.test.ts
@@ -209,8 +209,6 @@ describe('modular-scripts', () => {
             "dist-cjs",
             "dist-es",
             "dist-types",
-            "README.md",
-            "LICENSE",
           ],
           "main": "dist-cjs/index.js",
           "modular": Object {
@@ -363,8 +361,6 @@ describe('modular-scripts', () => {
             "dist-cjs",
             "dist-es",
             "dist-types",
-            "README.md",
-            "LICENSE",
           ],
           "main": "dist-cjs/index.js",
           "modular": Object {
@@ -446,8 +442,6 @@ describe('modular-scripts', () => {
             "dist-cjs",
             "dist-es",
             "dist-types",
-            "README.md",
-            "LICENSE",
           ],
           "main": "dist-cjs/nested-sample-package.cjs.js",
           "modular": Object {

diff --git a/packages/modular-scripts/src/build/buildPackage/makeBundle.ts b/packages/modular-scripts/src/build/buildPackage/makeBundle.ts
@@ -307,13 +307,15 @@ export async function makeBundle(
       ...packageJson.dependencies,
       ...localImports,
     },
+    /**
+     * Certain files are always included, regardless of settings.
+     * https://docs.npmjs.com/cli/v9/configuring-npm/package-json#files
+     */
     files: distinct([
       ...(packageJson.files || []),
       'dist-cjs',
       'dist-es',
       'dist-types',
-      'README.md',
-      'LICENSE',
     ]),
   };
 }
diff --git a/packages/modular-template-app/package.json b/packages/modular-template-app/package.json
@@ -10,7 +10,6 @@
   },
   "license": "Apache-2.0",
   "files": [
-    "README.md",
     "public",
     "src"
   ]

diff --git a/packages/modular-template-esm-view/package.json b/packages/modular-template-esm-view/package.json
@@ -10,7 +10,6 @@
   },
   "license": "Apache-2.0",
   "files": [
-    "README.md",
     "src"
   ]
 }
diff --git a/packages/modular-template-node-env-app/package.json b/packages/modular-template-node-env-app/package.json
@@ -14,7 +14,6 @@
   },
   "license": "Apache-2.0",
   "files": [
-    "README.md",
     "public",
     "src"
   ]

diff --git a/packages/modular-template-package/package.json b/packages/modular-template-package/package.json
@@ -11,7 +11,6 @@
   },
   "license": "Apache-2.0",
   "files": [
-    "README.md",
     "src"
   ]
 }
diff --git a/packages/modular-template-view/package.json b/packages/modular-template-view/package.json
@@ -11,7 +11,6 @@
     "templateType": "view"
   },
   "files": [
-    "README.md",
     "src"
   ]
 }