Updated documentation and some coding style changes

Author: armartinez

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

@@ -8,7 +8,7 @@
 import SwiftUI
 
 extension CEWorkspaceSettingsData {
-    /// The project setting
+    /// Workspace settings for the project tab.
     struct ProjectSettings: Codable, Hashable, SearchableSettingsPage {
         var searchKeys: [String] {
             [
@@ -17,19 +17,14 @@ extension CEWorkspaceSettingsData {
             .map { NSLocalizedString($0, comment: "") }
         }
 
-        /// The project name
         var projectName: String = ""
 
-        /// Default initializer
         init() {}
 
         /// Explicit decoder init for setting default values when key is not present in `JSON`
         init(from decoder: Decoder) throws {
             let container = try decoder.container(keyedBy: CodingKeys.self)
-            self.projectName = try container.decodeIfPresent(
-                String.self,
-                forKey: .projectName
-            ) ?? ""
+            self.projectName = try container.decodeIfPresent(String.self,forKey: .projectName) ?? ""
         }
     }
 }

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

@@ -9,7 +9,7 @@ import Foundation
 import Collections
 
 extension CEWorkspaceSettingsData {
-    /// The tasks  setting
+    /// Workspace settings for the tasks tab.
     struct TasksSettings: Codable, Hashable, SearchableSettingsPage {
         var items: [CETask] = []
 
@@ -20,23 +20,16 @@ extension CEWorkspaceSettingsData {
                 .map { NSLocalizedString($0, comment: "") }
         }
 
-        /// The tasks behavior of the app
+        /// The tasks functionality behavior of the app
         var enabled: Bool = true
 
-        /// Default initializer
         init() {}
 
         /// Explicit decoder init for setting default values when key is not present in `JSON`
         init(from decoder: Decoder) throws {
             let container = try decoder.container(keyedBy: CodingKeys.self)
-            self.items = try container.decodeIfPresent(
-                [CETask].self,
-                forKey: .items
-            ) ?? []
-            self.enabled = try container.decodeIfPresent(
-                Bool.self,
-                forKey: .enabled
-            ) ?? true
+            self.items = try container.decodeIfPresent([CETask].self,  forKey: .items) ?? []
+            self.enabled = try container.decodeIfPresent(Bool.self, forKey: .enabled) ?? true
         }
     }
 }

CodeEdit/Features/CEWorkspace/Models/CETask.swift

@@ -7,15 +7,14 @@
 
 import SwiftUI
 
-/// Represents a CodeEdit task that will be executed by the a
-/// task manager.
+/// CodeEdit task that will be executed by the task manager.
 struct CETask: Identifiable, Hashable, Codable {
     var id = UUID()
     var name: String = ""
     var target: String = ""
     var workingDirectory: String = ""
     var command: String = ""
-    var env: [EnvironmentVariable]  = []
+    var environmentVariables: [EnvironmentVariable]  = []
 
     var isInvalid: Bool {
         name.isEmpty ||
@@ -29,14 +28,15 @@ struct CETask: Identifiable, Hashable, Codable {
         case target
         case workingDirectory
         case command
-        case env
+        case environmentVariables
     }
 
     struct EnvironmentVariable: Identifiable, Hashable, Codable {
         var id = UUID()
         var name: String = ""
         var value: String = ""
 
+        /// Enables encoding the environment variables as a `name`:`value`pair.
         private struct CodingKeys: CodingKey {
             var stringValue: String
             var intValue: Int?
@@ -46,14 +46,14 @@ struct CETask: Identifiable, Hashable, Codable {
                 self.intValue = nil
             }
 
+            /// Required by the CodingKey protocol but not being currently used.
             init?(intValue: Int) {
                 self.stringValue = "\(intValue)"
                 self.intValue = intValue
             }
         }
 
-        init() {
-        }
+        init() {}
 
         init(from decoder: Decoder) throws {
             let container = try decoder.container(keyedBy: CodingKeys.self)

CodeEdit/Features/CEWorkspace/Models/CEWorkspaceSettings.swift

@@ -5,7 +5,6 @@
 //  Created by Axel Martinez on 27/3/24.
 //
 
-import Foundation
 import SwiftUI
 import Combine
 
@@ -16,7 +15,7 @@ final class CEWorkspaceSettings: ObservableObject {
 
     private var savedSettings = false
     private var storeTask: AnyCancellable!
-    private let filemanager = FileManager.default
+    private let fileManager = FileManager.default
 
     private var folderURL: URL? {
         guard let workspaceURL = workspace.fileURL else {
@@ -40,33 +39,29 @@ final class CEWorkspaceSettings: ObservableObject {
 
         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)
+                try? self.fileManager.createDirectory(at: folderURL, withIntermediateDirectories: false)
                 self.savedSettings = true
             }
 
             try? self.savePreferences($0)
         }
     }
 
-    /// Load and construct ``Settings`` model from
-    /// `.codeedit/settings.json`
+    /// Load and construct ``CEWorkspaceSettings`` model from `.codeedit/settings.json`
     private func loadSettings() {
         if let settingsURL = settingsURL {
-            if filemanager.fileExists(atPath: settingsURL.path) {
+            if fileManager.fileExists(atPath: settingsURL.path) {
                 guard let json = try? Data(contentsOf: settingsURL),
                       let prefs = try? JSONDecoder().decode(CEWorkspaceSettingsData.self, from: json)
-                else {
-                    return
-                }
+                else { return }
+
                 self.savedSettings = true
                 self.preferences = prefs
             }
         }
-        return
     }
 
-    /// Save``Settings`` model to
-    /// `.codeedit/settings.json`
+    /// Save``CEWorkspaceSettings`` model to `.codeedit/settings.json`
     private func savePreferences(_ data: CEWorkspaceSettingsData) throws {
         guard let settingsURL = settingsURL else { return }
 

CodeEdit/Features/CEWorkspace/Models/CEWorkspaceSettingsData.swift

@@ -10,22 +10,16 @@ import Foundation
 
 /// # Workspace Settings
 ///
-/// The model structure of the workspace settings for `CodeEdit`
-///
-/// A `JSON` representation is persisted in the workspace's `./codeedit/settings.json`. file
-///
-/// - Note: Make sure to implement the ``init(from:)`` initializer, decoding
-///  all properties with
-///  [`decodeIfPresent`](https://developer.apple.com/documentation/swift/keyeddecodingcontainer/2921389-decodeifpresent)
-///  and providing a default value. Otherwise all settings get overridden.
+/// 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 {
     /// The project global settings
     var project: ProjectSettings = .init()
 
     /// The tasks settings
     var tasks: TasksSettings = .init()
 
-    /// Default initializer
     init() {}
 
     /// Explicit decoder init for setting default values when key is not present in `JSON`

CodeEdit/Features/CEWorkspace/Models/CEWorkspaceSettingsPage.swift

@@ -8,16 +8,16 @@
 import Foundation
 import SwiftUI
 
-/// A struct for a workspace settings page
+/// Represents a workspace settings tab.
 struct CEWorkspaceSettingsPage: Hashable, Equatable, Identifiable {
-    /// A struct for a sidebar icon, with a base color and SF Symbol
+    /// Sidebar icon, with a base color and SF Symbol
     enum IconResource: Equatable, Hashable {
         case system(_ name: String)
         case symbol(_ name: String)
         case asset(_ name: String)
     }
 
-    /// An enum of all the settings pages
+    /// All the workspace settings pages
     enum Name: String {
         case project = "Project"
         case tasks = "Tasks"
@@ -34,7 +34,6 @@ struct CEWorkspaceSettingsPage: Hashable, Equatable, Identifiable {
     }
     let icon: IconResource?
 
-    /// Default initializer
     init(
         _ name: Name,
         baseColor: Color? = nil,

CodeEdit/Features/CEWorkspace/Views/CETaskFormView.swift

@@ -33,7 +33,7 @@ struct CETaskFormView: View {
             }
             Section(content: {
                 List(selection: $selectedItemId) {
-                    ForEach($task.env) { env in
+                    ForEach($task.environmentVariables) { env in
                         EnvironmentVariableListItem(
                             item: env,
                             selectedItemId: $selectedItemId,
@@ -43,14 +43,14 @@ struct CETaskFormView: View {
                 }
                 .frame(minHeight: 56)
                 .overlay {
-                    if task.env.isEmpty {
+                    if task.environmentVariables.isEmpty {
                         Text("No environment variables")
                             .foregroundStyle(Color(.secondaryLabelColor))
                     }
                 }
                 .actionBar {
                     Button {
-                        self.task.env.append(CETask.EnvironmentVariable())
+                        self.task.environmentVariables.append(CETask.EnvironmentVariable())
                     } label: {
                         Image(systemName: "plus")
                     }
@@ -72,7 +72,7 @@ struct CETaskFormView: View {
     }
 
     func removeEnv(id: UUID) {
-        self.task.env.removeAll(where: {
+        self.task.environmentVariables.removeAll(where: {
             $0.id == id
         })
     }

CodeEdit/Features/CEWorkspace/Views/CEWorkspaceSettingsView.swift

@@ -10,15 +10,14 @@ import CodeEditSymbols
 
 /// A struct for settings
 struct CEWorkspaceSettingsView: View {
-    let workspace: WorkspaceDocument
-
     @ObservedObject var settings: CEWorkspaceSettings
 
     @StateObject var viewModel = SettingsViewModel()
     @State private var selectedPage: CEWorkspaceSettingsPage = Self.pages[0].page
     @State private var searchText: String = ""
 
     let window: NSWindow?
+    let workspace: WorkspaceDocument
 
     static var pages: [PageAndCEWorkspaceSettings] = [
         .init(

CodeEdit/Features/CEWorkspace/Views/EnvironmentVariableListItem.swift

@@ -8,17 +8,16 @@
 import SwiftUI
 
 struct EnvironmentVariableListItem: View {
+    @FocusState private var isKeyFocused: Bool
+
     @Binding var item: CETask.EnvironmentVariable
     @Binding var selectedItemId: UUID?
 
-    var delete: (UUID) -> Void
-
-    /// State variables added to prevent an exception when deleting
-    /// the item in the onChange event
+    /// State variables added to prevent an exception when deleting the item in the onChange event.
     @State var name: String
     @State var value: String
 
-    @FocusState private var isKeyFocused: Bool
+    var delete: (UUID) -> Void
 
     init(
         item: Binding<CETask.EnvironmentVariable>,

CodeEdit/Features/CEWorkspace/Views/Pages/ProjectCEWorkspaceSettingsView.swift

@@ -23,8 +23,6 @@ struct ProjectCEWorkspaceSettingsView: View {
 /// The extension of the view with all the preferences
 private extension ProjectCEWorkspaceSettingsView {
     private var projectName: some View {
-        TextField(text: $settings.projectName) {
-            Text("Name")
-        }
+        TextField("Name", text: $settings.projectName)
     }
 }