Fixing Typos (#1579)

tom-ludwig · web-flow · commit 202a25dc2300 · 2024-01-30T17:43:45.000+01:00
* Corrected a few typos
diff --git a/CodeEdit.xcodeproj/project.pbxproj b/CodeEdit.xcodeproj/project.pbxproj
@@ -261,7 +261,7 @@
 		611191FE2B08CCD200D4459B /* SearchIndexer+File.swift in Sources */ = {isa = PBXBuildFile; fileRef = 611191FD2B08CCD200D4459B /* SearchIndexer+File.swift */; };
 		611192002B08CCD700D4459B /* SearchIndexer+Memory.swift in Sources */ = {isa = PBXBuildFile; fileRef = 611191FF2B08CCD700D4459B /* SearchIndexer+Memory.swift */; };
 		611192022B08CCDC00D4459B /* SearchIndexer+Search.swift in Sources */ = {isa = PBXBuildFile; fileRef = 611192012B08CCDC00D4459B /* SearchIndexer+Search.swift */; };
-		611192042B08CCED00D4459B /* SearchIndexer+ProgressivSearch.swift in Sources */ = {isa = PBXBuildFile; fileRef = 611192032B08CCED00D4459B /* SearchIndexer+ProgressivSearch.swift */; };
+		611192042B08CCED00D4459B /* SearchIndexer+ProgressiveSearch.swift in Sources */ = {isa = PBXBuildFile; fileRef = 611192032B08CCED00D4459B /* SearchIndexer+ProgressiveSearch.swift */; };
 		611192062B08CCF600D4459B /* SearchIndexer+Add.swift in Sources */ = {isa = PBXBuildFile; fileRef = 611192052B08CCF600D4459B /* SearchIndexer+Add.swift */; };
 		611192082B08CCFD00D4459B /* SearchIndexer+Terms.swift in Sources */ = {isa = PBXBuildFile; fileRef = 611192072B08CCFD00D4459B /* SearchIndexer+Terms.swift */; };
 		6111920C2B08CD0B00D4459B /* SearchIndexer+InternalMethods.swift in Sources */ = {isa = PBXBuildFile; fileRef = 6111920B2B08CD0B00D4459B /* SearchIndexer+InternalMethods.swift */; };
@@ -800,7 +800,7 @@
 		611191FD2B08CCD200D4459B /* SearchIndexer+File.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = "SearchIndexer+File.swift"; sourceTree = "<group>"; };
 		611191FF2B08CCD700D4459B /* SearchIndexer+Memory.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = "SearchIndexer+Memory.swift"; sourceTree = "<group>"; };
 		611192012B08CCDC00D4459B /* SearchIndexer+Search.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = "SearchIndexer+Search.swift"; sourceTree = "<group>"; };
-		611192032B08CCED00D4459B /* SearchIndexer+ProgressivSearch.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = "SearchIndexer+ProgressivSearch.swift"; sourceTree = "<group>"; };
+		611192032B08CCED00D4459B /* SearchIndexer+ProgressiveSearch.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = "SearchIndexer+ProgressiveSearch.swift"; sourceTree = "<group>"; };
 		611192052B08CCF600D4459B /* SearchIndexer+Add.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = "SearchIndexer+Add.swift"; sourceTree = "<group>"; };
 		611192072B08CCFD00D4459B /* SearchIndexer+Terms.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = "SearchIndexer+Terms.swift"; sourceTree = "<group>"; };
 		6111920B2B08CD0B00D4459B /* SearchIndexer+InternalMethods.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = "SearchIndexer+InternalMethods.swift"; sourceTree = "<group>"; };
@@ -2240,7 +2240,7 @@
 				611191FF2B08CCD700D4459B /* SearchIndexer+Memory.swift */,
 				611191FD2B08CCD200D4459B /* SearchIndexer+File.swift */,
 				611192012B08CCDC00D4459B /* SearchIndexer+Search.swift */,
-				611192032B08CCED00D4459B /* SearchIndexer+ProgressivSearch.swift */,
+				611192032B08CCED00D4459B /* SearchIndexer+ProgressiveSearch.swift */,
 				611192052B08CCF600D4459B /* SearchIndexer+Add.swift */,
 				611192072B08CCFD00D4459B /* SearchIndexer+Terms.swift */,
 				6111920B2B08CD0B00D4459B /* SearchIndexer+InternalMethods.swift */,
@@ -3217,7 +3217,7 @@
 				B6C4F2A62B3CABD200B2B140 /* HistoryInspectorItemView.swift in Sources */,
 				B65B10FE2B08B07D002852CF /* SourceControlNavigatorChangesList.swift in Sources */,
 				58F2EB03292FB2B0004A9BDE /* Documentation.docc in Sources */,
-				611192042B08CCED00D4459B /* SearchIndexer+ProgressivSearch.swift in Sources */,
+				611192042B08CCED00D4459B /* SearchIndexer+ProgressiveSearch.swift in Sources */,
 				611192022B08CCDC00D4459B /* SearchIndexer+Search.swift in Sources */,
 				04BA7C272AE2E9F100584E1C /* GitClient+Push.swift in Sources */,
 				2B7A583527E4BA0100D25D4E /* AppDelegate.swift in Sources */,
diff --git a/CodeEdit/Features/CodeEditUI/Views/CEContentUnavailableView.swift b/CodeEdit/Features/CodeEditUI/Views/CEContentUnavailableView.swift
@@ -25,7 +25,7 @@ struct CEContentUnavailableView<Actions: View>: View {
         self.actions = actions()
     }
 
-    var contentUnavaiableView: some View {
+    var contentUnavailableView: some View {
         VStack(spacing: 14) {
             VStack(spacing: 5) {
                 if systemImage != nil {
@@ -53,10 +53,10 @@ struct CEContentUnavailableView<Actions: View>: View {
 
     var body: some View {
         if #available(macOS 14, *) {
-            contentUnavaiableView
+            contentUnavailableView
                 .buttonStyle(.accessoryBarAction)
         } else {
-            contentUnavaiableView
+            contentUnavailableView
         }
     }
 }
diff --git a/CodeEdit/Features/CodeEditUI/Views/OverlayPanel.swift b/CodeEdit/Features/CodeEditUI/Views/OverlayPanel.swift
@@ -21,9 +21,9 @@ final class OverlayPanel: NSPanel, NSWindowDelegate {
     }
 
     override func standardWindowButton(_ button: NSWindow.ButtonType) -> NSButton? {
-        let btn = super.standardWindowButton(button)
-        btn?.isHidden = true
-        return btn
+        let button = super.standardWindowButton(button)
+        button?.isHidden = true
+        return button
     }
 
     func windowDidResignKey(_ notification: Notification) {
diff --git a/CodeEdit/Features/CodeFile/CodeFileDocument.swift b/CodeEdit/Features/CodeFile/CodeFileDocument.swift
@@ -32,13 +32,13 @@ final class CodeFileDocument: NSDocument, ObservableObject, QLPreviewItem {
     /// Used to override detected languages.
     @Published var language: CodeLanguage?
 
-    /// Document-specific overriden indent option.
+    /// Document-specific overridden indent option.
     @Published var indentOption: SettingsData.TextEditingSettings.IndentOption?
 
-    /// Document-specific overriden tab width.
+    /// Document-specific overridden tab width.
     @Published var defaultTabWidth: Int?
 
-    /// Document-specific overriden line wrap preference.
+    /// Document-specific overridden line wrap preference.
     @Published var wrapLines: Bool?
 
     /*
@@ -133,7 +133,7 @@ final class CodeFileDocument: NSDocument, ObservableObject, QLPreviewItem {
         self.content = content
     }
 
-    /// Triggered when change occured
+    /// Triggered when change occurred
     override func updateChangeCount(_ change: NSDocument.ChangeType) {
         super.updateChangeCount(change)
 
diff --git a/CodeEdit/Features/Documents/Controllers/CodeEditWindowController.swift b/CodeEdit/Features/Documents/Controllers/CodeEditWindowController.swift
@@ -128,7 +128,7 @@ final class CodeEditWindowController: NSWindowController, NSToolbarDelegate, Obs
             // style the toolbar background in native tab bar style.
             self.window?.titlebarSeparatorStyle = .none
         } else {
-            // In xcode tab bar style, we use default toolbar background with
+            // In Xcode tab bar style, we use default toolbar background with
             // line separator.
             self.window?.titlebarSeparatorStyle = .automatic
         }
diff --git a/CodeEdit/Features/Documents/Indexer/SearchIndexer+Add.swift b/CodeEdit/Features/Documents/Indexer/SearchIndexer+Add.swift
@@ -21,7 +21,7 @@ extension SearchIndexer {
             return false
         }
 
-        return modifiyIndexQueue.sync {
+        return modifyIndexQueue.sync {
             SKIndexAddDocumentWithText(index, document.takeUnretainedValue(), text as CFString, canReplace)
         }
     }
@@ -65,7 +65,7 @@ extension SearchIndexer {
         // Try to detect the mime type if it wasn't specified
         let mime = mimeType ?? self.detectMimeType(fileURL)
 
-        return modifiyIndexQueue.sync {
+        return modifyIndexQueue.sync {
             SKIndexAddDocument(index, document.takeUnretainedValue(), mime as CFString?, canReplace)
         }
     }
diff --git a/CodeEdit/Features/Documents/Indexer/SearchIndexer+AsyncController.swift b/CodeEdit/Features/Documents/Indexer/SearchIndexer+AsyncController.swift
@@ -8,7 +8,7 @@
 import Foundation
 
 extension SearchIndexer {
-    /// Manager for SearchIndexer objct that supports async calls to the index
+    /// Manager for SearchIndexer object that supports async calls to the index
     class AsyncManager {
         /// An instance of the SearchIndexer
         let index: SearchIndexer
@@ -44,7 +44,7 @@ extension SearchIndexer {
         ///   - timeout: The timeout duration for each search operation. Default is 1.0 second.
         ///
         /// - Returns: An asynchronous stream (`AsyncStream`) of search results in chunks.
-        /// The search results are returned in the form of a `SearchIndexer.ProgressivSearch.Results` object.
+        /// The search results are returned in the form of a `SearchIndexer.ProgressiveSearch.Results` object.
         ///
         /// This function initiates a progressive search on the index for the specified query
         /// and asynchronously yields search results in chunks using an `AsyncStream`.
@@ -65,7 +65,7 @@ extension SearchIndexer {
             query: String,
             _ maxResults: Int,
             timeout: TimeInterval = 1.0
-        ) async -> AsyncStream<SearchIndexer.ProgressivSearch.Results> {
+        ) async -> AsyncStream<SearchIndexer.ProgressiveSearch.Results> {
             let search = index.progressiveSearch(query: query)
 
             return AsyncStream { configuration in
diff --git a/CodeEdit/Features/Documents/Indexer/SearchIndexer+InternalMethods.swift b/CodeEdit/Features/Documents/Indexer/SearchIndexer+InternalMethods.swift
@@ -9,10 +9,10 @@ import Foundation
 import UniformTypeIdentifiers
 
 extension SearchIndexer {
-    /// A "typealias" for a document ID, using a struct becasue swift lint doesn't allow typealiases for 3 types
+    /// A "typealias" for a document ID, using a struct because swift lint doesn't allow type-aliases for 3 types
     public struct DocumentID {
         let url: URL
-        let docuemnt: SKDocument
+        let document: SKDocument
         let documentID: SKDocumentID
     }
     /// Returns the mime type for the url, or nil if the mime type couldn't be ascertained from the extension
@@ -21,8 +21,8 @@ extension SearchIndexer {
     /// - Returns: the mime type of the url if able to detect, nil otherwise
     func detectMimeType(_ url: URL) -> String? {
         if let type = UTType(filenameExtension: url.pathExtension) {
-            if let mimetype = type.preferredMIMEType {
-                return mimetype
+            if let mimeType = type.preferredMIMEType {
+                return mimeType
             }
         }
         return nil
@@ -33,7 +33,7 @@ extension SearchIndexer {
     /// i. e. the index does not need to get flushed.
     func remove(document: SKDocument) -> Bool {
         if let index = self.index {
-            return modifiyIndexQueue.sync {
+            return modifyIndexQueue.sync {
                 SKIndexRemoveDocument(index, document)
             }
         }
@@ -78,7 +78,7 @@ extension SearchIndexer {
                 docs.append(
                     DocumentID(
                         url: baseURL,
-                        docuemnt: inParentDocument!,
+                        document: inParentDocument!,
                         documentID: documentID
                     )
                 )
@@ -88,8 +88,8 @@ extension SearchIndexer {
 
     /// Return an array of all the documents contained within the index
     ///
-    /// - Parameter termState: the termstate of documents to be returned (eg. all, empty only, non-empty only)
-    /// - Returns: An array containing all the documents matching the termstate
+    /// - Parameter termState: the TermState of documents to be returned (eg. all, empty only, non-empty only)
+    /// - Returns: An array containing all the documents matching the TermState
     func fullDocuments(termState: TermState = .all) -> [DocumentID] {
         guard let index = self.index else {
             return []
diff --git a/CodeEdit/Features/Documents/Indexer/SearchIndexer+Memory.swift b/CodeEdit/Features/Documents/Indexer/SearchIndexer+Memory.swift
@@ -7,12 +7,12 @@
 
 import Foundation
 extension SearchIndexer {
-    /// Memory based indxing using NSMutable
+    /// Memory based indexing using NSMutable
     public class Memory: SearchIndexer {
         // The data index store
         private var store = NSMutableData()
 
-        /// Creat a new in-memory index
+        /// Create a new in-memory index
         /// - Parameter properties: the properties to use in the index
         public init?(properties: CreateProperties = CreateProperties()) {
             let data = NSMutableData()
diff --git a/CodeEdit/Features/Documents/Indexer/SearchIndexer+ProgressiveSearch.swift b/CodeEdit/Features/Documents/Indexer/SearchIndexer+ProgressiveSearch.swift
@@ -1,5 +1,5 @@
 //
-//  SearchIndexer+ProgressivSearch.swift
+//  SearchIndexer+ProgressiveSearch.swift
 //  CodeEdit
 //
 //  Created by Tommy Ludwig on 18.11.23.
@@ -8,12 +8,12 @@
 import Foundation
 
 extension SearchIndexer {
-    /// Object representaitng the search results
+    /// Object representing the search results
     public class SearchResult {
         /// The identifying url for the document
         let url: URL
 
-        /// The search score for the codument result, Heigher means more relevant
+        /// The search score for the document, higher means more relevant
         let score: Float
 
         init(url: URL, score: Float) {
@@ -26,13 +26,13 @@ extension SearchIndexer {
     public func progressiveSearch(
         query: String,
         options: SKSearchOptions = SKSearchOptions(kSKSearchOptionDefault)
-    ) -> ProgressivSearch {
-        return ProgressivSearch(options: options, index: self, query: query)
+    ) -> ProgressiveSearch {
+        return ProgressiveSearch(options: options, index: self, query: query)
     }
 
     /// A class for creating and managing a progressive search.
     /// A search starts on creation and can be cancelled at any time.
-    public class ProgressivSearch {
+    public class ProgressiveSearch {
         /// A class representing the results of a search request.
         public class Results {
             /// Create a search result
@@ -78,7 +78,7 @@ extension SearchIndexer {
         public func getNextSearchResultsChunk(
             limit: Int = 10,
             timeout: TimeInterval = 1.0
-        ) -> (ProgressivSearch.Results) {
+        ) -> (ProgressiveSearch.Results) {
             guard self.index.index != nil else {
                 return Results(moreResultsAvailable: false, results: [])
             }
diff --git a/CodeEdit/Features/Documents/Indexer/SearchIndexer.swift b/CodeEdit/Features/Documents/Indexer/SearchIndexer.swift
@@ -9,7 +9,7 @@ import Foundation
 
 /// Indexer using SKIndex
 public class SearchIndexer {
-    let modifiyIndexQueue = DispatchQueue(label: "app.codeedit.CodeEdit.ModifySearchIndex")
+    let modifyIndexQueue = DispatchQueue(label: "app.codeedit.CodeEdit.ModifySearchIndex")
 
     var index: SKIndex?
 
@@ -42,7 +42,7 @@ public class SearchIndexer {
         let allDocs = self.fullDocuments(termState: .empty)
         var removedCount = 0
         for docID in allDocs {
-            _ = self.remove(document: docID.docuemnt)
+            _ = self.remove(document: docID.document)
             removedCount += 1
         }
         return removedCount
@@ -90,7 +90,7 @@ public class SearchIndexer {
     /// - `indexType`: The type of the index to be created.
     ///     Options include `.unknown`, `.inverted`, `.vector` or `.invertedVector`
     /// - `proximityIndexing`: A Boolean flag indicating whether or not Search Kit should use proximity indexing.
-    /// - `stopWords`: A set of stopwords — words not to index.
+    /// - `stopWords`: A set of stop-words — words not to index.
     /// - `minTermLength`: The minimum term length to index (defaults to 1).
     public class CreateProperties {
         /// The type of the index to be created
@@ -107,18 +107,18 @@ public class SearchIndexer {
         /// - Parameters:
         ///   - indexType: The type of index
         ///   - proximityIndexing: A Boolean flag indicating whether or not Search Kit should use proximity indexing
-        ///   - stopWords: A set of stopwords — words not to index
+        ///   - stopWords: A set of stop-words — words not to index
         ///   - minTermLength: The minimum term length to index (defaults to 1)
         public init(
             indexType: SearchIndexer.IndexType = .inverted,
             proximityIndexing: Bool = false,
             stopWords: Set<String> = [],
-            minTermLengh: UInt = 1
+            minTermLength: UInt = 1
         ) {
             self.indexType = SKIndexType(indexType.rawValue)
             self.proximityIndexing = proximityIndexing
             self.stopWords = stopWords
-            self.minTermLength = minTermLengh
+            self.minTermLength = minTermLength
         }
 
         /// Returns a CFDictionary object to use for the call to SKIndexCreate
diff --git a/CodeEdit/Features/Documents/LazyStringLoader.swift b/CodeEdit/Features/Documents/LazyStringLoader.swift
@@ -11,7 +11,7 @@ class LazyStringLoader {
     let fileURL: URL
     var fileHandle: FileHandle?
     let chunkSize: Int
-    let queue = DispatchQueue(label: "com.CodeEdit.LayzLoader")
+    let queue = DispatchQueue(label: "com.CodeEdit.LazyLoader")
 
     init(fileURL: URL, chunkSize: Int = 1024) {
         self.fileURL = fileURL
diff --git a/CodeEdit/Features/Editor/TabBar/Tabs/Tab/EditorFileTabCloseButton.swift b/CodeEdit/Features/Editor/TabBar/Tabs/Tab/EditorFileTabCloseButton.swift
@@ -32,7 +32,7 @@ struct EditorFileTabCloseButton: View {
         .id(id)
         // Detects if file document changed, when this view created item.fileDocument is nil
         .onReceive(item.fileDocumentPublisher, perform: { _ in
-            // Force rerender so isDocumentEdited publisher is updated
+            // Force re-render so isDocumentEdited publisher is updated
             self.id += 1
         })
         .onReceive(
diff --git a/CodeEditTests/Features/Documents/Indexer/MemorySearchTests.swift b/CodeEditTests/Features/Documents/Indexer/MemorySearchTests.swift
@@ -20,9 +20,9 @@ final class MemoryIndexSearchTests: XCTestCase {
         let indexResults = index.addFileWithText(filePath, text: "Hello, World!")
         XCTAssert(indexResults)
         index.flush()
-        let progressivSearch = index.progressiveSearch(query: "hello")
-        let progressivSearchResults = progressivSearch.getNextSearchResultsChunk(limit: 10)
-        XCTAssertEqual(progressivSearchResults.results.count, 1)
+        let progressiveSearch = index.progressiveSearch(query: "hello")
+        let progressiveSearchResults = progressiveSearch.getNextSearchResultsChunk(limit: 10)
+        XCTAssertEqual(progressiveSearchResults.results.count, 1)
     }
 
     func testIndexFolderSearch() {
@@ -50,9 +50,9 @@ final class MemoryIndexSearchTests: XCTestCase {
         let indexResults = index.addFileWithText(filePath, text: "Hello, World!")
         XCTAssert(indexResults)
         index.flush()
-        let progressivSearch = index.progressiveSearch(query: "*ll*")
-        let progressivSearchResults = progressivSearch.getNextSearchResultsChunk(limit: 10)
-        XCTAssertEqual(progressivSearchResults.results.count, 1)
+        let progressiveSearch = index.progressiveSearch(query: "*ll*")
+        let progressiveSearchResults = progressiveSearch.getNextSearchResultsChunk(limit: 10)
+        XCTAssertEqual(progressiveSearchResults.results.count, 1)
     }
 
     func testIndexRemoveDocument() {

Original file line number	Diff line number	Diff line change
`@@ -25,7 +25,7 @@ struct CEContentUnavailableView<Actions: View>: View {`
`25`	`25`	`self.actions = actions()`
`26`	`26`	`}`
`27`	`27`
`28`		`- var contentUnavaiableView: some View {`
	`28`	`+ var contentUnavailableView: some View {`
`29`	`29`	`VStack(spacing: 14) {`
`30`	`30`	`VStack(spacing: 5) {`
`31`	`31`	`if systemImage != nil {`
`@@ -53,10 +53,10 @@ struct CEContentUnavailableView<Actions: View>: View {`
`53`	`53`
`54`	`54`	`var body: some View {`
`55`	`55`	`if #available(macOS 14, *) {`
`56`		`- contentUnavaiableView`
	`56`	`+ contentUnavailableView`
`57`	`57`	`.buttonStyle(.accessoryBarAction)`
`58`	`58`	`} else {`
`59`		`- contentUnavaiableView`
	`59`	`+ contentUnavailableView`
`60`	`60`	`}`
`61`	`61`	`}`
`62`	`62`	`}`
Original file line number	Diff line number	Diff line change
`@@ -21,9 +21,9 @@ final class OverlayPanel: NSPanel, NSWindowDelegate {`
`21`	`21`	`}`
`22`	`22`
`23`	`23`	`override func standardWindowButton(_ button: NSWindow.ButtonType) -> NSButton? {`
`24`		`- let btn = super.standardWindowButton(button)`
`25`		`- btn?.isHidden = true`
`26`		`- return btn`
	`24`	`+ let button = super.standardWindowButton(button)`
	`25`	`+ button?.isHidden = true`
	`26`	`+ return button`
`27`	`27`	`}`
`28`	`28`
`29`	`29`	`func windowDidResignKey(_ notification: Notification) {`
Original file line number	Diff line number	Diff line change
`@@ -128,7 +128,7 @@ final class CodeEditWindowController: NSWindowController, NSToolbarDelegate, Obs`
`128`	`128`	`// style the toolbar background in native tab bar style.`
`129`	`129`	`self.window?.titlebarSeparatorStyle = .none`
`130`	`130`	`} else {`
`131`		`- // In xcode tab bar style, we use default toolbar background with`
	`131`	`+ // In Xcode tab bar style, we use default toolbar background with`
`132`	`132`	`// line separator.`
`133`	`133`	`self.window?.titlebarSeparatorStyle = .automatic`
`134`	`134`	`}`
Original file line number	Diff line number	Diff line change
`@@ -21,7 +21,7 @@ extension SearchIndexer {`
`21`	`21`	`return false`
`22`	`22`	`}`
`23`	`23`
`24`		`- return modifiyIndexQueue.sync {`
	`24`	`+ return modifyIndexQueue.sync {`
`25`	`25`	`SKIndexAddDocumentWithText(index, document.takeUnretainedValue(), text as CFString, canReplace)`
`26`	`26`	`}`
`27`	`27`	`}`
`@@ -65,7 +65,7 @@ extension SearchIndexer {`
`65`	`65`	`// Try to detect the mime type if it wasn't specified`
`66`	`66`	`let mime = mimeType ?? self.detectMimeType(fileURL)`
`67`	`67`
`68`		`- return modifiyIndexQueue.sync {`
	`68`	`+ return modifyIndexQueue.sync {`
`69`	`69`	`SKIndexAddDocument(index, document.takeUnretainedValue(), mime as CFString?, canReplace)`
`70`	`70`	`}`
`71`	`71`	`}`