feat: Remove scripts, devDependencies and build from package.json

BREAKING CHANGE: `scripts`, `devDependencies` and `build` automatically removed from package.json

Close #1212

Author: develar

.idea/dictionaries/develar.xml

@@ -190,10 +190,22 @@ class AsarPackager {
         const fileParent = path.dirname(file)
         const dirNode = this.fs.searchNodeFromPath(fileParent)
         const packageDataPromise = fileIndexToModulePackageData.get(i)
-        let newData: any | null = null
+        let newData: string | null = null
         if (packageDataPromise == null) {
-          if (this.options.extraMetadata != null && file === mainPackageJson) {
-            newData = JSON.stringify(deepAssign(await readJson(file), this.options.extraMetadata), null, 2)
+          if (file === mainPackageJson) {
+            const mainPackageData = await readJson(file)
+            if (this.options.extraMetadata != null) {
+              deepAssign(mainPackageData, this.options.extraMetadata)
+            }
+
+            // https://github.com/electron-userland/electron-builder/issues/1212
+            const serializedDataIfChanged = cleanupPackageJson(mainPackageData)
+            if (serializedDataIfChanged != null) {
+              newData = serializedDataIfChanged
+            }
+            else if (this.options.extraMetadata != null) {
+              newData = JSON.stringify(mainPackageData, null, 2)
+            }
           }
         }
         else {
@@ -352,7 +364,7 @@ function cleanupPackageJson(data: any): any {
   try {
     let changed = false
     for (const prop of Object.getOwnPropertyNames(data)) {
-      if (prop[0] === "_" || prop === "dist" || prop === "gitHead" || prop === "keywords") {
+      if (prop[0] === "_" || prop === "dist" || prop === "gitHead" || prop === "keywords" || prop === "build" || prop === "devDependencies" || prop === "scripts") {
         delete data[prop]
         changed = true
       }

packages/electron-builder/src/asarUtil.ts

@@ -128,7 +128,11 @@ export abstract class PlatformPackager<DC extends PlatformSpecificBuildOptions>
     log(`Packaging for ${platformName} ${Arch[arch]} using electron ${this.info.electronVersion} to ${path.relative(this.projectDir, appOutDir)}`)
 
     const appDir = this.info.appDir
-    const ignoreFiles = new Set([path.resolve(this.info.projectDir, outDir), path.resolve(this.info.projectDir, this.buildResourcesDir)])
+    const ignoreFiles = new Set([path.resolve(this.info.projectDir, outDir),
+      path.resolve(this.info.projectDir, this.buildResourcesDir),
+      path.resolve(this.info.projectDir, "electron-builder.yml"),
+      path.resolve(this.info.projectDir, "electron-builder.json"),
+      path.resolve(this.info.projectDir, "electron-builder.json5")])
     if (this.info.isPrepackedAppAsar) {
       await unpackElectron(this, appOutDir, platformName, Arch[arch], this.info.electronVersion)
     }

packages/electron-builder/src/platformPackager.ts

@@ -1,20 +1,6 @@
 exports[`test extra metadata 1`] = `
 Object {
   "author": "Foo Bar <foo@example.com>",
-  "build": Object {
-    "appId": "org.electron-builder.testApp",
-    "compression": "store",
-    "electronVersion": "1.4.12",
-    "iconUrl": "https://raw.githubusercontent.com/szwacz/electron-boilerplate/master/resources/windows/icon.ico",
-    "linux": Object {
-      "category": "Development",
-      "packageCategory": "devel",
-    },
-    "mac": Object {
-      "category": "your.app.category.type",
-    },
-    "npmRebuild": false,
-  },
   "description": "Test Application (test quite \" #378)",
   "foo": Object {
     "bar": 12,

test/out/__snapshots__/extraMetadataTest.js.snap

@@ -6,7 +6,7 @@ Object {
 
 exports[`test outside link 1`] = `
 Object {
-  "offset": "5290",
+  "offset": "4877",
   "size": 4,
 }
 `;

test/out/__snapshots__/globTest.js.snap

@@ -18,6 +18,8 @@ test.ifDevOrLinuxCi("extra metadata", app({
   },
 }, {
   projectDirCreated: projectDir => modifyPackageJson(projectDir, data => {
+    data.scripts = {}
+    data.devDependencies = {"foo": "boo"}
     data.foo = {
       bar: 42,
       existingProp: 22,

test/src/extraMetadataTest.ts

@@ -83,12 +83,14 @@ async function runTests() {
   }
   else if (!isEmptyOrSpaces(process.env.CIRCLE_NODE_INDEX)) {
     const circleNodeIndex = parseInt(process.env.CIRCLE_NODE_INDEX, 10)
-    if (circleNodeIndex === 0 || circleNodeIndex === 2) {
+    if (circleNodeIndex === 0) {
       skipWin = true
-      args.push("linux.*", "BuildTest.js", "extraMetadataTest.js", "mainEntryTest.js", "globTest.js", "filesTest.js", "ignoreTest.js")
-      if (circleNodeIndex === 0) {
-        args.push("nsisUpdaterTest")
-      }
+      args.push("debTest", "fpmTest", "linuxArchiveTest", "BuildTest.js", "extraMetadataTest.js", "mainEntryTest.js", "globTest.js", "filesTest.js", "ignoreTest.js")
+      args.push("nsisUpdaterTest")
+    }
+    else if (circleNodeIndex === 2) {
+      skipWin = true
+      args.push("linuxPackagerTest", "snapTest", "BuildTest.js", "extraMetadataTest.js", "mainEntryTest.js", "globTest.js", "filesTest.js", "ignoreTest.js")
     }
     else {
       args.push("windows.*", "mac.*")

test/src/helpers/runTests.ts

@@ -3,6 +3,7 @@ import { remove, readFile, rename } from "fs-extra-p"
 import * as path from "path"
 import { Platform, build } from "electron-builder"
 import { assertThat } from "../helpers/fileAssert"
+import { ELECTRON_VERSION } from "../helpers/config"
 
 test.ifDevOrLinuxCi("AppImage", app({targets: Platform.LINUX.createTarget()}))
 
@@ -38,6 +39,10 @@ test.ifNotWindows("icons from ICNS", app({targets: Platform.LINUX.createTarget()
     await build({
       targets: Platform.LINUX.createTarget(),
       projectDir: projectDir,
+      config: {
+        electronVersion: ELECTRON_VERSION,
+        compression: "store",
+      }
     })
 
     await assertThat(path.join(projectDir, "dist")).isDirectory()