Only Save Workspace Settings If Necessary (#1702)

Only Save Settings If Necessary

Author: thecoolwinter

CodeEdit/Features/CEWorkspace/Extensions/CEWorkspaceSettingsData+ProjectSettings.swift

@@ -9,7 +9,7 @@ import SwiftUI
 
 extension CEWorkspaceSettingsData {
     /// Workspace settings for the project tab.
-    struct ProjectSettings: Codable, Hashable, SearchableSettingsPage {
+    struct ProjectSettings: Codable, Hashable, SearchableSettingsPage, WorkspaceSettingsGroup {
         var searchKeys: [String] {
             [
                 "Project Name",
@@ -26,5 +26,9 @@ extension CEWorkspaceSettingsData {
             let container = try decoder.container(keyedBy: CodingKeys.self)
             self.projectName = try container.decodeIfPresent(String.self, forKey: .projectName) ?? ""
         }
+
+        func isEmpty() -> Bool {
+            projectName == ""
+        }
     }
 }

CodeEdit/Features/CEWorkspace/Extensions/CEWorkspaceSettingsData+TasksSettings.swift

@@ -10,7 +10,7 @@ import Collections
 
 extension CEWorkspaceSettingsData {
     /// Workspace settings for the tasks tab.
-    struct TasksSettings: Codable, Hashable, SearchableSettingsPage {
+    struct TasksSettings: Codable, Hashable, SearchableSettingsPage, WorkspaceSettingsGroup {
         var items: [CETask] = []
 
         var searchKeys: [String] {
@@ -31,5 +31,9 @@ extension CEWorkspaceSettingsData {
             self.items = try container.decodeIfPresent([CETask].self, forKey: .items) ?? []
             self.enabled = try container.decodeIfPresent(Bool.self, forKey: .enabled) ?? true
         }
+
+        func isEmpty() -> Bool {
+            items.isEmpty && enabled == true
+        }
     }
 }

CodeEdit/Features/CEWorkspace/Models/CEWorkspaceSettings.swift

@@ -13,7 +13,6 @@ final class CEWorkspaceSettings: ObservableObject {
     @ObservedObject private var workspace: WorkspaceDocument
     @Published public var preferences: CEWorkspaceSettingsData = .init()
 
-    private var savedSettings = false
     private var storeTask: AnyCancellable!
     private let fileManager = FileManager.default
 
@@ -37,12 +36,7 @@ final class CEWorkspaceSettings: ObservableObject {
 
         loadSettings()
 
-        self.storeTask = self.$preferences.throttle(for: 2, scheduler: RunLoop.main, latest: true).sink {
-            if !self.savedSettings, let folderURL = self.folderURL {
-                try? self.fileManager.createDirectory(at: folderURL, withIntermediateDirectories: false)
-                self.savedSettings = true
-            }
-
+        self.storeTask = self.$preferences.throttle(for: 2.0, scheduler: RunLoop.main, latest: true).sink {
             try? self.savePreferences($0)
         }
     }
@@ -54,16 +48,21 @@ final class CEWorkspaceSettings: ObservableObject {
                 guard let json = try? Data(contentsOf: settingsURL),
                       let prefs = try? JSONDecoder().decode(CEWorkspaceSettingsData.self, from: json)
                 else { return }
-
-                self.savedSettings = true
                 self.preferences = prefs
             }
         }
     }
 
     /// Save``CEWorkspaceSettings`` model to `.codeedit/settings.json`
     private func savePreferences(_ data: CEWorkspaceSettingsData) throws {
-        guard let settingsURL = settingsURL else { return }
+        // If the user doesn't have any settings to save, don't save them.
+        guard !data.isEmpty() else { return }
+
+        guard let folderURL, let settingsURL else { return }
+
+        if !fileManager.fileExists(atPath: folderURL.path()) {
+            try fileManager.createDirectory(at: folderURL, withIntermediateDirectories: true)
+        }
 
         let data = try JSONEncoder().encode(data)
         let json = try JSONSerialization.jsonObject(with: data)

CodeEdit/Features/CEWorkspace/Models/CEWorkspaceSettingsData.swift

@@ -8,12 +8,18 @@
 import SwiftUI
 import Foundation
 
+protocol WorkspaceSettingsGroup {
+    /// Determine if the settings are changed from the defaults.
+    /// Used to check if creating a `.codeedit` folder is necessary on the user's machine.
+    func isEmpty() -> Bool
+}
+
 /// # Workspace Settings
 ///
 /// The model of the workspace settings for `CodeEdit` that control the behavior of some functionality at the workspace
 /// level like the workspace name or defining tasks.  A `JSON` representation is persisted in the workspace's
 /// `./codeedit/settings.json`. file
-struct CEWorkspaceSettingsData: Codable, Hashable {
+struct CEWorkspaceSettingsData: Codable, Hashable, WorkspaceSettingsGroup {
     /// The project global settings
     var project: ProjectSettings = .init()
 
@@ -41,4 +47,8 @@ struct CEWorkspaceSettingsData: Codable, Hashable {
 
         return settings
     }
+
+    func isEmpty() -> Bool {
+        project.isEmpty() && tasks.isEmpty()
+    }
 }

CodeEdit/Features/Settings/Models/Settings.swift

@@ -65,7 +65,6 @@ final class Settings: ObservableObject {
     /// Save``Settings`` model to
     /// `~/Library/Application Support/CodeEdit/settings.json`
     private func savePreferences(_ data: SettingsData) throws {
-        print("Saving...")
         let data = try JSONEncoder().encode(data)
         let json = try JSONSerialization.jsonObject(with: data)
         let prettyJSON = try JSONSerialization.data(withJSONObject: json, options: [.prettyPrinted])