Improve Editor Configuration, Rename to SourceEditor (CodeEditApp#336)

### Description

Improved the organization of our editor's configuration options by
organizing them into a separate type from the SwiftUI API. This type is
further organized into four structs based on the configuration option's
effect on the editor.

#### Detailed Changes

- Creates a new `SourceEditorConfiguration` struct.
- Passed to `CodeEditSourceEditor` and `TextViewController` to update
configuration.
- One single object for all configuration that doesn't usually change
during editing (no state is stored here).
- Has an efficient method for updating the editor for a new
configuration (moved from `CodeEditSourceEditor`'s SwiftUI update method
to `SourceEditorConfiguration`).
- Organized into four categories: appearance, behavior, layout, and
peripherals. Each has it's own documentation.
- Adds a new API for toggling the gutter view.
- Renames `CodeEditSourceEditor` to `SourceEditor` (requested by
@austincondiff).
- Updates docc docs to reflect new API.
- Updates README to reflect new API (as well as a few missing/broken
links).

I found a small bug with the refactor guide while making these changes.
I may move them out of this PR.

### Related Issues

* closes CodeEditApp#115
* closes CodeEditApp#319 

### Checklist

- [x] I read and understood the [contributing
guide](https://github.com/CodeEditApp/CodeEdit/blob/main/CONTRIBUTING.md)
as well as the [code of
conduct](https://github.com/CodeEditApp/CodeEdit/blob/main/CODE_OF_CONDUCT.md)
- [x] The issues this PR addresses are related to each other
- [x] My changes generate no new warnings
- [x] My code builds and runs on my machine
- [x] My changes are all related to the related issue above
- [x] I documented my code

### Screenshots

N/A no content changes

Author: thecoolwinter

Example/CodeEditSourceEditorExample/CodeEditSourceEditorExample/Views/ContentView.swift

@@ -19,18 +19,28 @@ struct ContentView: View {
 
     @State private var language: CodeLanguage = .default
     @State private var theme: EditorTheme = .light
+    @State private var cursorPositions: [CursorPosition] = [.init(line: 1, column: 1)]
+
     @State private var font: NSFont = NSFont.monospacedSystemFont(ofSize: 12, weight: .medium)
     @AppStorage("wrapLines") private var wrapLines: Bool = true
-    @State private var cursorPositions: [CursorPosition] = [.init(line: 1, column: 1)]
     @AppStorage("systemCursor") private var useSystemCursor: Bool = false
-    @State private var isInLongParse = false
-    @State private var settingsIsPresented: Bool = false
-    @State private var treeSitterClient = TreeSitterClient()
-    @AppStorage("showMinimap") private var showMinimap: Bool = true
     @State private var indentOption: IndentOption = .spaces(count: 4)
     @AppStorage("reformatAtColumn") private var reformatAtColumn: Int = 80
+
+    @AppStorage("showGutter") private var showGutter: Bool = true
+    @AppStorage("showMinimap") private var showMinimap: Bool = true
     @AppStorage("showReformattingGuide") private var showReformattingGuide: Bool = false
-    @State private var invisibleCharactersConfig: InvisibleCharactersConfig = .empty
+    @State private var invisibleCharactersConfig: InvisibleCharactersConfiguration = .empty
+    @State private var warningCharacters: Set<UInt16> = []
+
+    @State private var isInLongParse = false
+    @State private var settingsIsPresented: Bool = false
+
+    @State private var treeSitterClient = TreeSitterClient()
+
+    private func contentInsets(proxy: GeometryProxy) -> NSEdgeInsets {
+        NSEdgeInsets(top: proxy.safeAreaInsets.top, left: showGutter ? 0 : 1, bottom: 28.0, right: 0)
+    }
 
     init(document: Binding<CodeEditSourceEditorExampleDocument>, fileURL: URL?) {
         self._document = document
@@ -39,26 +49,25 @@ struct ContentView: View {
 
     var body: some View {
         GeometryReader { proxy in
-            CodeEditSourceEditor(
+            SourceEditor(
                 document.text,
                 language: language,
-                theme: theme,
-                font: font,
-                tabWidth: 4,
-                indentOption: indentOption,
-                lineHeight: 1.2,
-                wrapLines: wrapLines,
-                editorOverscroll: 0.3,
-                cursorPositions: $cursorPositions,
-                useThemeBackground: true,
-                highlightProviders: [treeSitterClient],
-                contentInsets: NSEdgeInsets(top: proxy.safeAreaInsets.top, left: 0, bottom: 28.0, right: 0),
-                additionalTextInsets: NSEdgeInsets(top: 1, left: 0, bottom: 1, right: 0),
-                useSystemCursor: useSystemCursor,
-                showMinimap: showMinimap,
-                reformatAtColumn: reformatAtColumn,
-                showReformattingGuide: showReformattingGuide,
-                invisibleCharactersConfig: invisibleCharactersConfig
+                configuration: SourceEditorConfiguration(
+                    appearance: .init(theme: theme, font: font, wrapLines: wrapLines),
+                    behavior: .init(
+                        indentOption: indentOption,
+                        reformatAtColumn: reformatAtColumn
+                    ),
+                    layout: .init(contentInsets: contentInsets(proxy: proxy)),
+                    peripherals: .init(
+                        showGutter: showGutter,
+                        showMinimap: showMinimap,
+                        showReformattingGuide: showReformattingGuide,
+                        invisibleCharactersConfiguration: invisibleCharactersConfig,
+                        warningCharacters: warningCharacters
+                    )
+                ),
+                cursorPositions: $cursorPositions
             )
             .overlay(alignment: .bottom) {
                 StatusBar(
@@ -70,11 +79,13 @@ struct ContentView: View {
                     isInLongParse: $isInLongParse,
                     language: $language,
                     theme: $theme,
+                    showGutter: $showGutter,
                     showMinimap: $showMinimap,
                     indentOption: $indentOption,
                     reformatAtColumn: $reformatAtColumn,
                     showReformattingGuide: $showReformattingGuide,
-                    invisibles: $invisibleCharactersConfig
+                    invisibles: $invisibleCharactersConfig,
+                    warningCharacters: $warningCharacters
                 )
             }
             .ignoresSafeArea()

Example/CodeEditSourceEditorExample/CodeEditSourceEditorExample/Views/StatusBar.swift

@@ -22,18 +22,21 @@ struct StatusBar: View {
     @Binding var isInLongParse: Bool
     @Binding var language: CodeLanguage
     @Binding var theme: EditorTheme
+    @Binding var showGutter: Bool
     @Binding var showMinimap: Bool
     @Binding var indentOption: IndentOption
     @Binding var reformatAtColumn: Int
     @Binding var showReformattingGuide: Bool
-    @Binding var invisibles: InvisibleCharactersConfig
+    @Binding var invisibles: InvisibleCharactersConfiguration
+    @Binding var warningCharacters: Set<UInt16>
 
     var body: some View {
         HStack {
             Menu {
                 IndentPicker(indentOption: $indentOption, enabled: document.text.length == 0)
                     .buttonStyle(.borderless)
                 Toggle("Wrap Lines", isOn: $wrapLines)
+                Toggle("Show Gutter", isOn: $showGutter)
                 Toggle("Show Minimap", isOn: $showMinimap)
                 Toggle("Show Reformatting Guide", isOn: $showReformattingGuide)
                 Picker("Reformat column at column", selection: $reformatAtColumn) {
@@ -61,16 +64,16 @@ struct StatusBar: View {
                         "Warning Characters",
                         isOn: Binding(
                             get: {
-                                !invisibles.warningCharacters.isEmpty
+                                !warningCharacters.isEmpty
                             },
                             set: { newValue in
                                 // In this example app, we only add one character
                                 // For real apps, consider providing a table where users can add UTF16
                                 // char codes to warn about, as well as a set of good defaults.
                                 if newValue {
-                                    invisibles.warningCharacters.insert(0x200B) // zero-width space
+                                    warningCharacters.insert(0x200B) // zero-width space
                                 } else {
-                                    invisibles.warningCharacters.removeAll()
+                                    warningCharacters.removeAll()
                                 }
                             }
                         )

README.md

@@ -5,8 +5,11 @@
 
 
 <p align="center">
-  <a aria-label="Follow CodeEdit on Twitter" href="https://twitter.com/CodeEditApp" target="_blank">
-    <img alt="" src="https://img.shields.io/badge/Follow%[email protected]?style=for-the-badge&logo=Twitter">
+  <a aria-label="Follow CodeEdit on X" href="https://x.com/CodeEditApp" target="_blank">
+    <img alt="" src="https://img.shields.io/badge/Follow%[email protected]?style=for-the-badge&logo=X">
+  </a>
+    <a aria-label="Follow CodeEdit on Bluesky" href="https://bsky.app/profile/codeedit.app" target="_blank">
+    <img alt="" src="https://img.shields.io/badge/Follow%[email protected]?style=for-the-badge&logo=Bluesky">
   </a>
   <a aria-label="Join the community on Discord" href="https://discord.gg/vChUXVf9Em" target="_blank">
     <img alt="" src="https://img.shields.io/badge/Join%20the%20community-black.svg?style=for-the-badge&logo=Discord">
@@ -33,45 +36,50 @@ An Xcode-inspired code editor view written in Swift powered by tree-sitter for [
 
 This package is fully documented [here](https://codeeditapp.github.io/CodeEditSourceEditor/documentation/codeeditsourceeditor/).
 
-## Usage
+## Usage (SwiftUI)
 
 ```swift
 import CodeEditSourceEditor
 
 struct ContentView: View {
-
     @State var text = "let x = 1.0"
+    
+    /// Automatically updates with cursor positions, or update the binding to set the user's cursors.
+    @State var cursorPositions: [CursorPosition] = []
+    
+    /// Configure the editor's appearance, features, and editing behavior...
     @State var theme = EditorTheme(...)
     @State var font = NSFont.monospacedSystemFont(ofSize: 11, weight: .regular)
-    @State var tabWidth = 4
-    @State var lineHeight = 1.2
-    @State var editorOverscroll = 0.3
+    @State var indentOption = .spaces(count: 4)
 
     var body: some View { 
-        CodeEditSourceEditor(
+        SourceEditor(
             $text,
-            language: .swift,
-            theme: $theme,
-            font: $font,
-            tabWidth: $tabWidth,
-            lineHeight: $lineHeight,
-            editorOverscroll: $editorOverscroll
+            language: language,
+            // Tons of customization options, with good defaults to get started quickly.
+            configuration: SourceEditorConfiguration(
+                appearance: .init(theme: theme, font: font),
+                behavior: .init(indentOption: indentOption)
+            ),
+            cursorPositions: $cursorPositions
         )
     }
 }
 ```
 
+An AppKit API is also available.
+
 ## Currently Supported Languages
 
 See this issue https://github.com/CodeEditApp/CodeEditLanguages/issues/10 on `CodeEditLanguages` for more information on supported languages.
 
 ## Dependencies
 
-Special thanks to [Matt Massicotte](https://twitter.com/mattie) for the great work he's done!
+Special thanks to [Matt Massicotte](https://bsky.app/profile/massicotte.org) for the great work he's done!
 
 | Package | Source | Author |
 | :- | :- | :- |
-| `SwiftTreeSitter` | [GitHub](https://github.com/ChimeHQ/SwiftTreeSitter) | [Matt Massicotte](https://twitter.com/mattie) |
+| `SwiftTreeSitter` | [GitHub](https://github.com/ChimeHQ/SwiftTreeSitter) | [Matt Massicotte](https://bsky.app/profile/massicotte.org) |
 
 ## License