feat(mac): add LSHandlerRank

Close #4614
electron-userland · Apr 29, 2020 · 5129266 · 5129266
1 parent 82d6602
commit 5129266
Show file tree

Hide file tree

Showing 5 changed files with 17 additions and 0 deletions.
diff --git a/packages/app-builder-lib/scheme.json b/packages/app-builder-lib/scheme.json
@@ -997,6 +997,11 @@
           "default": "Editor",
           "description": "*macOS-only* The app’s role with respect to the type. The value can be `Editor`, `Viewer`, `Shell`, or `None`. Corresponds to `CFBundleTypeRole`.",
           "type": "string"
+        },
+        "rank": {
+          "default": "Default",
+          "description": "*macOS-only* The app’s rank with respect to the type. The value can be `Owner`, `Default`, `Alternate`, or `None`. Corresponds to `LSHandlerRank`.",
+          "type": "string"
         }
       },
       "required": [

diff --git a/packages/app-builder-lib/src/electron/electronMac.ts b/packages/app-builder-lib/src/electron/electronMac.ts
@@ -178,6 +178,7 @@ export async function createMacApp(packager: MacPackager, appOutDir: string, asa
         CFBundleTypeExtensions: extensions,
         CFBundleTypeName: fileAssociation.name || extensions[0],
         CFBundleTypeRole: fileAssociation.role || "Editor",
+        LSHandlerRank: fileAssociation.rank || "Default",
         CFBundleTypeIconFile: iconFile
       } as any
 

diff --git a/packages/app-builder-lib/src/options/FileAssociation.ts b/packages/app-builder-lib/src/options/FileAssociation.ts
@@ -43,4 +43,10 @@ export interface FileAssociation {
    * *macOS-only* Whether the document is distributed as a bundle. If set to true, the bundle directory is treated as a file. Corresponds to `LSTypeIsPackage`.
    */
   readonly isPackage?: boolean
+
+    /**
+   * *macOS-only* The app’s rank with respect to the type. The value can be `Owner`, `Default`, `Alternate`, or `None`. Corresponds to `LSHandlerRank`.
+   * @default Default
+   */
+  readonly rank?: string
 }
diff --git a/test/snapshots/mac/macPackagerTest.js.snap b/test/snapshots/mac/macPackagerTest.js.snap
@@ -69,6 +69,7 @@ Object {
       "CFBundleTypeIconFile": "foo.icns",
       "CFBundleTypeName": "Foo",
       "CFBundleTypeRole": "Viewer",
+      "LSHandlerRank": "Default",
     },
     Object {
       "CFBundleTypeExtensions": Array [
@@ -77,6 +78,7 @@ Object {
       "CFBundleTypeIconFile": "Test App ßW.icns",
       "CFBundleTypeName": "Boo",
       "CFBundleTypeRole": "Shell",
+      "LSHandlerRank": "Owner",
       "LSTypeIsPackage": true,
     },
     Object {
@@ -86,6 +88,7 @@ Object {
       "CFBundleTypeIconFile": "someFoo.icns",
       "CFBundleTypeName": "Bar",
       "CFBundleTypeRole": "Shell",
+      "LSHandlerRank": "Default",
     },
   ],
   "CFBundleExecutable": "Test App ßW",

diff --git a/test/src/mac/macPackagerTest.ts b/test/src/mac/macPackagerTest.ts
@@ -53,12 +53,14 @@ test.ifMac("one-package", app({
           ext: "boo",
           name: "Boo",
           role: "Shell",
+          rank: "Owner",
           isPackage: true,
         },
         {
           ext: "bar",
           name: "Bar",
           role: "Shell",
+          rank: "Default",
           // If I specify `fileAssociations.icon` as `build/foo.icns` will it know to use `build/foo.ico` for Windows?
           icon: "someFoo.ico"
         },