feat(mac): control the localization files

Close #708

Author: develar

packages/electron-builder-lib/src/configuration.ts

@@ -155,7 +155,7 @@ export interface Configuration extends PlatformSpecificBuildOptions {
    * Whether to fail if the application is not signed (to prevent unsigned app if code signing configuration is not correct).
    * @default false
    */
-  readonly forceCodeSigning?: boolean
+  readonly ?: boolean
 
   /**
    * The version of muon you are packaging for.

packages/electron-builder-lib/src/macPackager.ts

@@ -1,21 +1,25 @@
 import BluebirdPromise from "bluebird-lst"
 import { Arch, AsyncTaskManager, exec, InvalidConfigurationError, log } from "builder-util"
 import { signAsync, SignOptions } from "electron-osx-sign"
-import { ensureDir } from "fs-extra-p"
+import { ensureDir, readdir, remove } from "fs-extra-p"
 import { Lazy } from "lazy-val"
 import * as path from "path"
 import { deepAssign } from "read-config-file/out/deepAssign"
 import * as semver from "semver"
+import { AsarIntegrity } from "asar-integrity"
+import { asArray } from "builder-util-runtime/out"
 import { AppInfo } from "./appInfo"
 import { appleCertificatePrefixes, CertType, CodeSigningInfo, createKeychain, findIdentity, Identity, isSignAllowed, reportError } from "./codeSign"
 import { DIR_TARGET, Platform, Target } from "./core"
 import { MacConfiguration, MasConfiguration } from "./options/macOptions"
 import { Packager } from "./packager"
+import { createMacApp } from "./packager/mac"
 import { PlatformPackager } from "./platformPackager"
 import { ArchiveTarget } from "./targets/ArchiveTarget"
 import { DmgTarget } from "./targets/dmg"
 import { PkgTarget, prepareProductBuildArgs } from "./targets/pkg"
 import { createCommonTarget, NoOpTarget } from "./targets/targetFactory"
+import { CONCURRENCY } from "builder-util/out/fs"
 
 export default class MacPackager extends PlatformPackager<MacConfiguration> {
   readonly codeSigningInfo: Promise<CodeSigningInfo>
@@ -255,6 +259,30 @@ export default class MacPackager extends PlatformPackager<MacConfiguration> {
   public getElectronDestinationDir(appOutDir: string) {
     return path.join(appOutDir, this.electronDistMacOsAppName)
   }
+
+  protected async beforeCopyExtraFiles(appOutDir: string, asarIntegrity: AsarIntegrity | null): Promise<any> {
+    await createMacApp(this, appOutDir, asarIntegrity)
+
+    const wantedLanguages = asArray(this.platformSpecificBuildOptions.electronLanguages)
+    if (wantedLanguages == null) {
+      return
+    }
+
+    // noinspection SpellCheckingInspection
+    const langFileExt = ".lproj"
+    const resourcesDir = this.getResourcesDir(appOutDir)
+    await BluebirdPromise.map(readdir(resourcesDir), file => {
+      if (!file.endsWith(langFileExt)) {
+        return
+      }
+
+      const language = file.substring(0, file.length - langFileExt.length)
+      if (!wantedLanguages.includes(language)) {
+        return remove(path.join(resourcesDir, file))
+      }
+      return
+    }, CONCURRENCY)
+  }
 }
 
 function getCertificateType(isMas: boolean, isDevelopment: boolean): CertType {

packages/electron-builder-lib/src/options/macOptions.ts

@@ -93,6 +93,11 @@ export interface MacConfiguration extends PlatformSpecificBuildOptions {
    * 2.16.0 files
    */
   readonly electronUpdaterCompatibility?: string | null
+
+  /**
+   * The electron locales. By default Electron locales used as is.
+   */
+  readonly electronLanguages?: Array<string> | string
 }
 
 /**

packages/electron-builder-lib/src/platformPackager.ts

@@ -9,6 +9,7 @@ import { Lazy } from "lazy-val"
 import { Minimatch } from "minimatch"
 import * as path from "path"
 import { deepAssign } from "read-config-file/out/deepAssign"
+import { AsarIntegrity } from "asar-integrity"
 import { AppInfo } from "./appInfo"
 import { checkFileInArchive } from "./asar/asarFileChecker"
 import { AsarPackager } from "./asar/asarUtil"
@@ -18,7 +19,6 @@ import { createTransformer, isElectronCompileUsed } from "./fileTransformer"
 import { AfterPackContext, AsarOptions, Configuration, FileAssociation, PlatformSpecificBuildOptions } from "./index"
 import { Packager } from "./packager"
 import { unpackElectron, unpackMuon } from "./packager/dirPackager"
-import { createMacApp } from "./packager/mac"
 import { PackagerOptions } from "./packagerApi"
 import { getAppBuilderTool } from "./targets/tools"
 import { copyAppFiles } from "./util/appFileCopier"
@@ -198,11 +198,7 @@ export abstract class PlatformPackager<DC extends PlatformSpecificBuildOptions>
     }
 
     await taskManager.awaitTasks()
-
-    if (platformName === "darwin" || platformName === "mas") {
-      await createMacApp(this, appOutDir, asarOptions == null ? null : await computeData(resourcesPath, asarOptions.externalAllowed ? {externalAllowed: true} : null))
-    }
-
+    await this.beforeCopyExtraFiles(appOutDir, asarOptions == null ? null : await computeData(resourcesPath, asarOptions.externalAllowed ? {externalAllowed: true} : null))
     await BluebirdPromise.each([extraResourceMatchers, extraFileMatchers], it => copyFiles(it))
 
     if (this.info.cancellationToken.cancelled) {
@@ -215,6 +211,10 @@ export abstract class PlatformPackager<DC extends PlatformSpecificBuildOptions>
     await this.info.afterSign(packContext)
   }
 
+  protected async beforeCopyExtraFiles(appOutDir: string, asarIntegrity: AsarIntegrity | null) {
+    // empty impl
+  }
+
   private copyAppFiles(taskManager: AsyncTaskManager, asarOptions: AsarOptions | null, resourcePath: string, outDir: string, platformSpecificBuildOptions: DC, excludePatterns: Array<Minimatch>, macroExpander: ((it: string) => string)) {
     const appDir = this.info.appDir
     const config = this.config
@@ -256,7 +256,7 @@ export abstract class PlatformPackager<DC extends PlatformSpecificBuildOptions>
   }
 
   protected signApp(packContext: AfterPackContext): Promise<any> {
-    return BluebirdPromise.resolve()
+    return Promise.resolve()
   }
 
   async getIconPath(): Promise<string | null> {

test/out/mac/__snapshots__/macPackagerTest.js.snap

@@ -162,3 +162,14 @@ Object {
   ],
 }
 `;
+
+exports[`two-package 2`] = `
+Array [
+  "TestApp.icns",
+  "app-update.yml",
+  "app.asar",
+  "bn.lproj",
+  "electron.asar",
+  "en.lproj",
+]
+`;

test/src/mac/macPackagerTest.ts

@@ -1,6 +1,6 @@
 import { copyOrLinkFile } from "builder-util/out/fs"
 import { createTargets, DIR_TARGET, Platform } from "electron-builder"
-import { readJson } from "fs-extra-p"
+import { readdir, readJson } from "fs-extra-p"
 import * as path from "path"
 import { assertThat } from "../helpers/fileAssert"
 import { app, appThrows, assertPack, convertUpdateInfo, platform } from "../helpers/packTester"
@@ -13,12 +13,16 @@ test.ifMac.ifAll("two-package", () => assertPack("test-app", {
     },
     mac: {
       electronUpdaterCompatibility: ">=2.16",
+      electronLanguages: ["bn", "en"]
     },
     //tslint:disable-next-line:no-invalid-template-strings
     artifactName: "${name}-${version}-${os}.${ext}",
   },
 }, {
   signed: true,
+  checkMacApp: async appDir => {
+    expect((await readdir(path.join(appDir, "Contents", "Resources"))).filter(it => !it.startsWith("."))).toMatchSnapshot()
+  },
 }))
 
 test.ifMac("one-package", app({