feat(mac): Support macOS Mojave Dark Mode

Close #3496
electron-userland · Nov 26, 2018 · e85ef88 · e85ef88
1 parent 68e5573
commit e85ef88
Show file tree

Hide file tree

Showing 27 changed files with 79 additions and 99 deletions.
diff --git a/.circleci/config.yml b/.circleci/config.yml
@@ -11,7 +11,7 @@ jobs:
             - deps-{{ checksum "yarn.lock" }}
       - restore_cache:
           keys:
-            - v-3.0.8-electron
+            - v-3.0.10-electron
       - run:
           command: yarn --frozen-lockfile
       - run:
@@ -23,7 +23,7 @@ jobs:
       - run:
           command: node ./test/out/helpers/downloadElectron.js
       - save_cache:
-          key: v-3.0.8-electron
+          key: v-3.0.10-electron
           paths:
             - ~/.cache/electron
 
@@ -41,7 +41,7 @@ jobs:
             - deps-{{ checksum "yarn.lock" }}
       - restore_cache:
           keys:
-            - v-3.0.8-electron
+            - v-3.0.10-electron
       # because in the build job we use circleci docker image and circleci restores cache to original user home
       - run:
           command: |

diff --git a/.idea/dictionaries/develar.xml b/.idea/dictionaries/develar.xml
diff --git a/package.json b/package.json
@@ -20,6 +20,7 @@
     "schema": "typescript-json-schema packages/app-builder-lib/tsconfig.json Configuration --out packages/app-builder-lib/scheme.json --noExtraProps --useTypeOfKeyword --strictNullChecks --titles --required",
     "jsdoc": "ts2jsdoc packages/builder-util-runtime packages/builder-util packages/app-builder-lib packages/electron-builder packages/electron-publish",
     "jsdoc2md": "node scripts/jsdoc2md.js",
+    "/////": " git clone --single-branch -b docs [email protected]:electron-userland/electron-builder.git docs",
     "docs": "tsc -p ./scripts/renderer/tsconfig.json && yarn jsdoc && yarn jsdoc2md",
     "deploy-docs": "mkdocs build --clean && netlifyctl deploy --publish-directory site",
     "////": "pip3 install mkdocs-material mkdocs pymdown-extensions markdown-include Pygments --upgrade"
@@ -31,7 +32,7 @@
   "dependencies": {
     "7zip-bin": "~4.1.0",
     "@types/is-ci": "^1.1.0",
-    "app-builder-bin": "2.5.1",
+    "app-builder-bin": "2.5.4",
     "archiver": "^3.0.0",
     "async-exit-hook": "^2.0.1",
     "bluebird-lst": "^1.0.6",
@@ -65,7 +66,7 @@
     "temp-file": "^3.3.2",
     "tunnel-agent": "^0.6.0",
     "update-notifier": "^2.5.0",
-    "yargs": "^12.0.2"
+    "yargs": "^12.0.5"
   },
   "devDependencies": {
     "@babel/core": "^7.1.6",

diff --git a/packages/app-builder-lib/package.json b/packages/app-builder-lib/package.json
@@ -42,7 +42,7 @@
   "homepage": "https://github.com/electron-userland/electron-builder",
   "dependencies": {
     "7zip-bin": "~4.1.0",
-    "app-builder-bin": "2.5.1",
+    "app-builder-bin": "2.5.4",
     "async-exit-hook": "^2.0.1",
     "bluebird-lst": "^1.0.6",
     "chromium-pickle-js": "^0.2.0",

diff --git a/packages/app-builder-lib/src/macPackager.ts b/packages/app-builder-lib/src/macPackager.ts
@@ -295,6 +295,10 @@ export default class MacPackager extends PlatformPackager<MacConfiguration> {
     use(this.platformSpecificBuildOptions.category || (this.config as any).category, it => appPlist.LSApplicationCategoryType = it)
     appPlist.NSHumanReadableCopyright = appInfo.copyright
 
+    if (this.platformSpecificBuildOptions.darkModeSupport) {
+      appPlist.NSRequiresAquaSystemAppearance = false
+    }
+
     const extendInfo = this.platformSpecificBuildOptions.extendInfo
     if (extendInfo != null) {
       Object.assign(appPlist, extendInfo)

diff --git a/packages/app-builder-lib/src/options/macOptions.ts b/packages/app-builder-lib/src/options/macOptions.ts
@@ -58,6 +58,12 @@ export interface MacConfiguration extends PlatformSpecificBuildOptions {
    */
   readonly bundleShortVersion?: string | null
 
+  /**
+   * Whether a dark mode is supported. If your app does have a dark mode, you can make your app follow the system-wide dark mode setting.
+   * @default false
+   */
+  readonly darkModeSupport?: boolean
+
   /**
    * The bundle identifier to use in the application helper's plist.
    * @default ${appBundleIdentifier}.helper

diff --git a/packages/builder-util/package.json b/packages/builder-util/package.json
@@ -11,7 +11,7 @@
     "out"
   ],
   "dependencies": {
-    "app-builder-bin": "2.5.1",
+    "app-builder-bin": "2.5.4",
     "temp-file": "^3.3.2",
     "fs-extra-p": "^7.0.0",
     "is-ci": "^1.2.1",

diff --git a/packages/electron-builder/package.json b/packages/electron-builder/package.json
@@ -55,7 +55,7 @@
     "read-config-file": "3.2.0",
     "sanitize-filename": "^1.6.1",
     "update-notifier": "^2.5.0",
-    "yargs": "^12.0.2",
+    "yargs": "^12.0.5",
     "lazy-val": "^1.0.3",
     "app-builder-lib": "0.0.0-semantic-release",
     "dmg-builder": "0.0.0-semantic-release"

diff --git a/test/fixtures/test-app-build-sub/electron-builder.yml b/test/fixtures/test-app-build-sub/electron-builder.yml
@@ -1,4 +1,4 @@
-electronVersion: 3.0.8
+electronVersion: 3.0.10
 appId: org.electron-builder.testApp
 compression: store
 npmRebuild: false

diff --git a/test/fixtures/test-app-one/package.json b/test/fixtures/test-app-one/package.json
@@ -8,7 +8,7 @@
   "author": "Foo Bar <[email protected]>",
   "license": "MIT",
   "build": {
-    "electronVersion": "3.0.8",
+    "electronVersion": "3.0.10",
     "appId": "org.electron-builder.testApp",
     "compression": "store",
     "npmRebuild": false,

diff --git a/test/fixtures/test-app-yarn-several-workspace/packages/test-app/package.json b/test/fixtures/test-app-yarn-several-workspace/packages/test-app/package.json
@@ -7,7 +7,7 @@
   "author": "Foo Bar <[email protected]>",
   "license": "MIT",
   "build": {
-    "electronVersion": "3.0.8",
+    "electronVersion": "3.0.10",
     "appId": "org.electron-builder.testApp",
     "compression": "store",
     "npmRebuild": false,

diff --git a/test/fixtures/test-app-yarn-workspace-version-conflict/packages/test-app/package.json b/test/fixtures/test-app-yarn-workspace-version-conflict/packages/test-app/package.json
@@ -7,7 +7,7 @@
   "author": "Foo Bar <[email protected]>",
   "license": "MIT",
   "build": {
-    "electronVersion": "3.0.8",
+    "electronVersion": "3.0.10",
     "appId": "org.electron-builder.testApp",
     "compression": "store",
     "npmRebuild": false,

diff --git a/test/fixtures/test-app-yarn-workspace/packages/test-app/package.json b/test/fixtures/test-app-yarn-workspace/packages/test-app/package.json
@@ -7,7 +7,7 @@
   "author": "Foo Bar <[email protected]>",
   "license": "MIT",
   "build": {
-    "electronVersion": "3.0.8",
+    "electronVersion": "3.0.10",
     "appId": "org.electron-builder.testApp",
     "compression": "store",
     "npmRebuild": false,

diff --git a/test/fixtures/test-app/package.json b/test/fixtures/test-app/package.json
@@ -1,7 +1,7 @@
 {
   "private": true,
   "build": {
-    "electronVersion": "3.0.8",
+    "electronVersion": "3.0.10",
     "appId": "org.electron-builder.testApp",
     "compression": "store",
     "npmRebuild": false,

diff --git a/test/out/__snapshots__/PublishManagerTest.js.snap b/test/out/__snapshots__/PublishManagerTest.js.snap
@@ -169,7 +169,6 @@ Object {
   "CFBundlePackageType": "APPL",
   "CFBundleShortVersionString": "1.1.0",
   "LSApplicationCategoryType": "your.app.category.type",
-  "LSMinimumSystemVersion": "10.9.0",
   "NSAppTransportSecurity": Object {
     "NSAllowsLocalNetworking": true,
     "NSExceptionDomains": Object {
@@ -275,7 +274,6 @@ Object {
   "CFBundlePackageType": "APPL",
   "CFBundleShortVersionString": "1.1.0",
   "LSApplicationCategoryType": "your.app.category.type",
-  "LSMinimumSystemVersion": "10.9.0",
   "NSAppTransportSecurity": Object {
     "NSAllowsLocalNetworking": true,
     "NSExceptionDomains": Object {
@@ -353,7 +351,6 @@ Object {
   "CFBundlePackageType": "APPL",
   "CFBundleShortVersionString": "1.1.0",
   "LSApplicationCategoryType": "your.app.category.type",
-  "LSMinimumSystemVersion": "10.9.0",
   "NSAppTransportSecurity": Object {
     "NSAllowsLocalNetworking": true,
     "NSExceptionDomains": Object {

diff --git a/test/out/mac/__snapshots__/dmgTest.js.snap b/test/out/mac/__snapshots__/dmgTest.js.snap
@@ -33,7 +33,6 @@ Object {
   "CFBundlePackageType": "APPL",
   "CFBundleShortVersionString": "2017.1-alpha5",
   "LSApplicationCategoryType": "your.app.category.type",
-  "LSMinimumSystemVersion": "10.9.0",
   "NSAppTransportSecurity": Object {
     "NSAllowsLocalNetworking": true,
     "NSExceptionDomains": Object {
@@ -56,6 +55,7 @@ Object {
   "NSHighResolutionCapable": true,
   "NSMainNibFile": "MainMenu",
   "NSPrincipalClass": "AtomApplication",
+  "NSRequiresAquaSystemAppearance": false,
   "NSSupportsAutomaticGraphicsSwitching": true,
 }
 `;
@@ -88,7 +88,6 @@ Object {
   "CFBundlePackageType": "APPL",
   "CFBundleShortVersionString": "1.1.0",
   "LSApplicationCategoryType": "your.app.category.type",
-  "LSMinimumSystemVersion": "10.9.0",
   "NSAppTransportSecurity": Object {
     "NSAllowsLocalNetworking": true,
     "NSExceptionDomains": Object {
@@ -143,7 +142,6 @@ Object {
   "CFBundlePackageType": "APPL",
   "CFBundleShortVersionString": "1.1.0",
   "LSApplicationCategoryType": "your.app.category.type",
-  "LSMinimumSystemVersion": "10.9.0",
   "NSAppTransportSecurity": Object {
     "NSAllowsLocalNetworking": true,
     "NSExceptionDomains": Object {
@@ -2267,7 +2265,6 @@ Object {
   "CFBundlePackageType": "APPL",
   "CFBundleShortVersionString": "1.1.0",
   "LSApplicationCategoryType": "your.app.category.type",
-  "LSMinimumSystemVersion": "10.9.0",
   "NSAppTransportSecurity": Object {
     "NSAllowsLocalNetworking": true,
     "NSExceptionDomains": Object {
@@ -2329,7 +2326,6 @@ Object {
   "CFBundlePackageType": "APPL",
   "CFBundleShortVersionString": "1.1.0",
   "LSApplicationCategoryType": "your.app.category.type",
-  "LSMinimumSystemVersion": "10.9.0",
   "NSAppTransportSecurity": Object {
     "NSAllowsLocalNetworking": true,
     "NSExceptionDomains": Object {
@@ -2391,7 +2387,6 @@ Object {
   "CFBundlePackageType": "APPL",
   "CFBundleShortVersionString": "1.1.0",
   "LSApplicationCategoryType": "your.app.category.type",
-  "LSMinimumSystemVersion": "10.9.0",
   "NSAppTransportSecurity": Object {
     "NSAllowsLocalNetworking": true,
     "NSExceptionDomains": Object {
@@ -2453,7 +2448,6 @@ Object {
   "CFBundlePackageType": "APPL",
   "CFBundleShortVersionString": "1.1.0",
   "LSApplicationCategoryType": "your.app.category.type",
-  "LSMinimumSystemVersion": "10.9.0",
   "NSAppTransportSecurity": Object {
     "NSAllowsLocalNetworking": true,
     "NSExceptionDomains": Object {
@@ -2515,7 +2509,6 @@ Object {
   "CFBundlePackageType": "APPL",
   "CFBundleShortVersionString": "1.1.0",
   "LSApplicationCategoryType": "your.app.category.type",
-  "LSMinimumSystemVersion": "10.9.0",
   "NSAppTransportSecurity": Object {
     "NSAllowsLocalNetworking": true,
     "NSExceptionDomains": Object {
@@ -2599,7 +2592,6 @@ Object {
   "CFBundlePackageType": "APPL",
   "CFBundleShortVersionString": "1.1.0",
   "LSApplicationCategoryType": "your.app.category.type",
-  "LSMinimumSystemVersion": "10.9.0",
   "NSAppTransportSecurity": Object {
     "NSAllowsLocalNetworking": true,
     "NSExceptionDomains": Object {
@@ -2659,7 +2651,6 @@ Object {
   "CFBundlePackageType": "APPL",
   "CFBundleShortVersionString": "1.1.0",
   "LSApplicationCategoryType": "your.app.category.type",
-  "LSMinimumSystemVersion": "10.9.0",
   "NSAppTransportSecurity": Object {
     "NSAllowsLocalNetworking": true,
     "NSExceptionDomains": Object {
@@ -2734,7 +2725,6 @@ Object {
   "CFBundlePackageType": "APPL",
   "CFBundleShortVersionString": "1.1.0",
   "LSApplicationCategoryType": "your.app.category.type",
-  "LSMinimumSystemVersion": "10.9.0",
   "NSAppTransportSecurity": Object {
     "NSAllowsLocalNetworking": true,
     "NSExceptionDomains": Object {
@@ -2789,7 +2779,6 @@ Object {
   "CFBundlePackageType": "APPL",
   "CFBundleShortVersionString": "1.1.0",
   "LSApplicationCategoryType": "your.app.category.type",
-  "LSMinimumSystemVersion": "10.9.0",
   "NSAppTransportSecurity": Object {
     "NSAllowsLocalNetworking": true,
     "NSExceptionDomains": Object {
@@ -2851,7 +2840,6 @@ Object {
   "CFBundlePackageType": "APPL",
   "CFBundleShortVersionString": "1.1.0",
   "LSApplicationCategoryType": "your.app.category.type",
-  "LSMinimumSystemVersion": "10.9.0",
   "NSAppTransportSecurity": Object {
     "NSAllowsLocalNetworking": true,
     "NSExceptionDomains": Object {

diff --git a/test/out/mac/__snapshots__/macArchiveTest.js.snap b/test/out/mac/__snapshots__/macArchiveTest.js.snap
@@ -23,7 +23,6 @@ Object {
   "CFBundlePackageType": "APPL",
   "CFBundleShortVersionString": "1.1.0",
   "LSApplicationCategoryType": "your.app.category.type",
-  "LSMinimumSystemVersion": "10.9.0",
   "NSAppTransportSecurity": Object {
     "NSAllowsLocalNetworking": true,
     "NSExceptionDomains": Object {
@@ -78,7 +77,6 @@ Object {
   "CFBundlePackageType": "APPL",
   "CFBundleShortVersionString": "1.1.0",
   "LSApplicationCategoryType": "your.app.category.type",
-  "LSMinimumSystemVersion": "10.9.0",
   "NSAppTransportSecurity": Object {
     "NSAllowsLocalNetworking": true,
     "NSExceptionDomains": Object {
@@ -135,7 +133,6 @@ Object {
   "CFBundlePackageType": "APPL",
   "CFBundleShortVersionString": "1.1.0",
   "LSApplicationCategoryType": "your.app.category.type",
-  "LSMinimumSystemVersion": "10.10.0",
   "NSAppTransportSecurity": Object {
     "NSAllowsLocalNetworking": true,
     "NSExceptionDomains": Object {
@@ -185,7 +182,6 @@ Object {
   "CFBundlePackageType": "APPL",
   "CFBundleShortVersionString": "1.1.0",
   "LSApplicationCategoryType": "your.app.category.type",
-  "LSMinimumSystemVersion": "10.9.0",
   "NSAppTransportSecurity": Object {
     "NSAllowsLocalNetworking": true,
     "NSExceptionDomains": Object {
@@ -235,7 +231,6 @@ Object {
   "CFBundlePackageType": "APPL",
   "CFBundleShortVersionString": "1.1.0",
   "LSApplicationCategoryType": "your.app.category.type",
-  "LSMinimumSystemVersion": "10.9.0",
   "NSAppTransportSecurity": Object {
     "NSAllowsLocalNetworking": true,
     "NSExceptionDomains": Object {
@@ -285,7 +280,6 @@ Object {
   "CFBundlePackageType": "APPL",
   "CFBundleShortVersionString": "1.1.0",
   "LSApplicationCategoryType": "your.app.category.type",
-  "LSMinimumSystemVersion": "10.9.0",
   "NSAppTransportSecurity": Object {
     "NSAllowsLocalNetworking": true,
     "NSExceptionDomains": Object {
@@ -847,7 +841,6 @@ Object {
   "CFBundlePackageType": "APPL",
   "CFBundleShortVersionString": "1.1.0",
   "LSApplicationCategoryType": "your.app.category.type",
-  "LSMinimumSystemVersion": "10.9.0",
   "NSAppTransportSecurity": Object {
     "NSAllowsLocalNetworking": true,
     "NSExceptionDomains": Object {

diff --git a/test/out/mac/__snapshots__/macPackagerTest.js.snap b/test/out/mac/__snapshots__/macPackagerTest.js.snap
@@ -188,7 +188,6 @@ Object {
   "CFBundlePackageType": "APPL",
   "CFBundleShortVersionString": "1.1.0",
   "LSApplicationCategoryType": "your.app.category.type",
-  "LSMinimumSystemVersion": "10.9.0",
   "NSAppTransportSecurity": Object {
     "NSAllowsLocalNetworking": true,
     "NSExceptionDomains": Object {

diff --git a/test/out/mac/__snapshots__/masTest.js.snap b/test/out/mac/__snapshots__/masTest.js.snap
@@ -18,7 +18,6 @@ Object {
   "CFBundleShortVersionString": "1.1.0",
   "ElectronTeamID": "744739DJ4Y",
   "LSApplicationCategoryType": "your.app.category.type",
-  "LSMinimumSystemVersion": "10.9.0",
   "NSHighResolutionCapable": true,
   "NSMainNibFile": "MainMenu",
   "NSPrincipalClass": "AtomApplication",
@@ -50,7 +49,6 @@ Object {
   "CFBundleShortVersionString": "1.1.0",
   "ElectronTeamID": "X8C9Z9L4HW",
   "LSApplicationCategoryType": "your.app.category.type",
-  "LSMinimumSystemVersion": "10.9.0",
   "NSHighResolutionCapable": true,
   "NSMainNibFile": "MainMenu",
   "NSPrincipalClass": "AtomApplication",
@@ -87,7 +85,6 @@ Object {
   "CFBundleShortVersionString": "1.1.0",
   "ElectronTeamID": "X8C9Z9L4HW",
   "LSApplicationCategoryType": "your.app.category.type",
-  "LSMinimumSystemVersion": "10.9.0",
   "NSHighResolutionCapable": true,
   "NSMainNibFile": "MainMenu",
   "NSPrincipalClass": "AtomApplication",