Support for File-Associations on macOS

docs/src/content/docs/changelog.mdx

@@ -76,6 +76,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Add cancellation support for query methods on `sqlite` service by [@fbbdev](https://github.com/fbbdev) in [#4067](https://github.com/wailsapp/wails/pull/4067)
 - Add prepared statement support to `sqlite` service with JS bindings by [@fbbdev](https://github.com/fbbdev) in [#4067](https://github.com/wailsapp/wails/pull/4067)
 - Add `SetMenu()` on window to allow for setting a menu on a window by [@leaanthony](https://github.com/leaanthony)
+-  Add File Association support for mac by [@wimaha]
 
 ### Fixed
 

docs/src/content/docs/guides/file-associations.mdx

@@ -62,6 +62,7 @@ fileAssociations:
 | description | Description shown in file properties                             | Windows  |
 | iconName    | Name of the icon file (without extension) in the build folder    | All      |
 | role        | Application's role for this file type (e.g., `Editor`, `Viewer`) | macOS    |
+| mimeType    | MIME type for the file (e.g., `image/jpeg`)                      | macOS    |
 
 ## Listening for File Open Events
 
@@ -105,6 +106,8 @@ Let's walk through setting up file associations for a simple text editor:
     Run `wails3 generate icons --help` for more information.
     :::
 
+    - For macOS add copy statement like `cp build/darwin/documenticon.icns {{.BIN_DIR}}/{{.APP_NAME}}.app/Contents/Resources` in the `create:app:bundle:` task.
+
 2. ### Configure File Associations
 
     Edit the `build/config.yml` file to add your file associations:

v3/internal/commands/build-assets.go

@@ -4,14 +4,15 @@ import (
 	"embed"
 	_ "embed"
 	"fmt"
-	"github.com/leaanthony/gosod"
-	"gopkg.in/yaml.v3"
 	"io/fs"
 	"os"
 	"path/filepath"
 	"runtime"
 	"strings"
 	"time"
+
+	"github.com/leaanthony/gosod"
+	"gopkg.in/yaml.v3"
 )
 
 //go:embed build_assets
@@ -121,6 +122,7 @@ type FileAssociation struct {
 	Description string `yaml:"description"`
 	IconName    string `yaml:"iconName"`
 	Role        string `yaml:"role"`
+	MimeType    string `yaml:"mimeType"`
 }
 
 type UpdateConfig struct {

v3/internal/commands/build_assets/config.yml

@@ -56,6 +56,7 @@ fileAssociations:
 #    description: Image File
 #    iconName: jpegFileIcon
 #    role: Editor
+#    mimeType: image/jpeg  # (optional)
 
 # Other data
 other:

v3/internal/commands/updatable_build_assets/darwin/Info.dev.plist.tmpl

@@ -2,27 +2,50 @@
 <plist version="1.0">
     <dict>
         <key>CFBundlePackageType</key>
-        <string>APPL</string>
+            <string>APPL</string>
         <key>CFBundleName</key>
-        <string>{{.ProductName}}</string>
+            <string>{{.ProductName}}</string>
         <key>CFBundleExecutable</key>
-        <string>{{.BinaryName}}</string>
+            <string>{{.BinaryName}}</string>
         <key>CFBundleIdentifier</key>
-        <string>{{.ProductIdentifier}}</string>
+            <string>{{.ProductIdentifier}}</string>
         <key>CFBundleVersion</key>
-        <string>{{.ProductVersion}}</string>
+            <string>{{.ProductVersion}}</string>
         <key>CFBundleGetInfoString</key>
-        <string>{{.ProductComments}}</string>
+            <string>{{.ProductComments}}</string>
         <key>CFBundleShortVersionString</key>
-        <string>{{.ProductVersion}}</string>
+            <string>{{.ProductVersion}}</string>
         <key>CFBundleIconFile</key>
-        <string>icons</string>
+            <string>icons</string>
         <key>LSMinimumSystemVersion</key>
-        <string>10.15.0</string>
+            <string>10.15.0</string>
         <key>NSHighResolutionCapable</key>
-        <string>true</string>
+            <string>true</string>
         <key>NSHumanReadableCopyright</key>
-        <string>{{.ProductCopyright}}</string>
+            <string>{{.ProductCopyright}}</string>
+        {{- if .FileAssociations}}
+        <key>CFBundleDocumentTypes</key>
+        <array>
+            {{- range .FileAssociations}}
+            <dict>
+                <key>CFBundleTypeExtensions</key>
+                <array>
+                    <string>{{.Ext}}</string>
+                </array>
+                <key>CFBundleTypeName</key>
+                    <string>{{.Name}}</string>
+                <key>CFBundleTypeRole</key>
+                    <string>{{.Role}}</string>
+                <key>CFBundleTypeIconFile</key>
+                    <string>{{.IconName}}</string>
+                {{- if .MimeType}}
+                <key>CFBundleTypeMimeType</key>
+                    <string>{{.MimeType}}</string>
+                {{- end}}
+            </dict>
+            {{- end}}
+        </array>
+        {{- end}}
         <key>NSAppTransportSecurity</key>
         <dict>
             <key>NSAllowsLocalNetworking</key>

v3/internal/commands/updatable_build_assets/darwin/Info.plist.tmpl

@@ -2,26 +2,49 @@
 <plist version="1.0">
     <dict>
         <key>CFBundlePackageType</key>
-        <string>APPL</string>
+            <string>APPL</string>
         <key>CFBundleName</key>
-        <string>{{.ProductName}}</string>
+            <string>{{.ProductName}}</string>
         <key>CFBundleExecutable</key>
-        <string>{{.BinaryName}}</string>
+            <string>{{.BinaryName}}</string>
         <key>CFBundleIdentifier</key>
-        <string>{{.ProductIdentifier}}</string>
+            <string>{{.ProductIdentifier}}</string>
         <key>CFBundleVersion</key>
-        <string>{{.ProductVersion}}</string>
+            <string>{{.ProductVersion}}</string>
         <key>CFBundleGetInfoString</key>
-        <string>{{.ProductComments}}</string>
+            <string>{{.ProductComments}}</string>
         <key>CFBundleShortVersionString</key>
-        <string>{{.ProductVersion}}</string>
+            <string>{{.ProductVersion}}</string>
         <key>CFBundleIconFile</key>
-        <string>icons</string>
+            <string>icons</string>
         <key>LSMinimumSystemVersion</key>
-        <string>10.15.0</string>
+            <string>10.15.0</string>
         <key>NSHighResolutionCapable</key>
-        <string>true</string>
+            <string>true</string>
         <key>NSHumanReadableCopyright</key>
-        <string>{{.ProductCopyright}}</string>
+            <string>{{.ProductCopyright}}</string>
+        {{- if .FileAssociations}}
+        <key>CFBundleDocumentTypes</key>
+        <array>
+            {{- range .FileAssociations}}
+            <dict>
+                <key>CFBundleTypeExtensions</key>
+                <array>
+                    <string>{{.Ext}}</string>
+                </array>
+                <key>CFBundleTypeName</key>
+                    <string>{{.Name}}</string>
+                <key>CFBundleTypeRole</key>
+                    <string>{{.Role}}</string>
+                <key>CFBundleTypeIconFile</key>
+                    <string>{{.IconName}}</string>
+                {{- if .MimeType}}
+                <key>CFBundleTypeMimeType</key>
+                    <string>{{.MimeType}}</string>
+                {{- end}}
+            </dict>
+            {{- end}}
+        </array>
+        {{- end}}
     </dict>
 </plist>