Rename variables

Author: yusufozgul

README.md

@@ -44,7 +44,7 @@ struct ContentView: View {
     @State var font = NSFont.monospacedSystemFont(ofSize: 11, weight: .regular)
     @State var tabWidth = 4
     @State var lineHeight = 1.2
-    @State var overScrollRatio = 0.3
+    @State var editorOverscroll = 0.3
 
     var body: some View { 
         CodeEditTextView(
@@ -54,7 +54,7 @@ struct ContentView: View {
             font: $font,
             tabWidth: $tabWidth,
             lineHeight: $lineHeight,
-            overScrollRatio: $overScrollRatio
+            editorOverscroll: $editorOverscroll
         )
     }
 }

Sources/CodeEditTextView/CodeEditTextView.swift

@@ -20,15 +20,15 @@ public struct CodeEditTextView: NSViewControllerRepresentable {
     ///   - font: The default font
     ///   - tabWidth: The tab width
     ///   - lineHeight: The line height multiplier (e.g. `1.2`)
-    ///   - overScrollRatio: The ratio for overscroll, between 0-1 (default: `0.0`)
+    ///   - editorOverscroll: The percentage for overscroll, between 0-1 (default: `0.0`)
     public init(
         _ text: Binding<String>,
         language: CodeLanguage,
         theme: Binding<EditorTheme>,
         font: Binding<NSFont>,
         tabWidth: Binding<Int>,
         lineHeight: Binding<Double>,
-        overScrollRatio: Binding<Double> = .constant(0.0),
+        editorOverscroll: Binding<Double> = .constant(0.0),
         cursorPosition: Published<(Int, Int)>.Publisher? = nil
     ) {
         self._text = text
@@ -37,7 +37,7 @@ public struct CodeEditTextView: NSViewControllerRepresentable {
         self._font = font
         self._tabWidth = tabWidth
         self._lineHeight = lineHeight
-        self._overScrollRatio = overScrollRatio
+        self._editorOverscroll = editorOverscroll
         self.cursorPosition = cursorPosition
     }
 
@@ -47,7 +47,7 @@ public struct CodeEditTextView: NSViewControllerRepresentable {
     @Binding private var font: NSFont
     @Binding private var tabWidth: Int
     @Binding private var lineHeight: Double
-    @Binding private var overScrollRatio: Double
+    @Binding private var editorOverscroll: Double
     private var cursorPosition: Published<(Int, Int)>.Publisher?
 
     public typealias NSViewControllerType = STTextViewController
@@ -60,7 +60,7 @@ public struct CodeEditTextView: NSViewControllerRepresentable {
             theme: theme,
             tabWidth: tabWidth,
             cursorPosition: cursorPosition,
-            overScrollRatio: overScrollRatio
+            editorOverscroll: editorOverscroll
         )
         controller.lineHeightMultiple = lineHeight
         return controller
@@ -72,7 +72,7 @@ public struct CodeEditTextView: NSViewControllerRepresentable {
         controller.theme = theme
         controller.tabWidth = tabWidth
         controller.lineHeightMultiple = lineHeight
-        controller.overScrollRatio = overScrollRatio
+        controller.editorOverscroll = editorOverscroll
         controller.reloadUI()
         return
     }

Sources/CodeEditTextView/Documentation.docc/CodeEditTextView.md

@@ -12,7 +12,7 @@ struct ContentView: View {
     @State var font = NSFont.monospacedSystemFont(ofSize: 11, weight: .regular)
     @State var tabWidth = 4
     @State var lineHeight = 1.2
-    @State var overScrollRatio = 0.3
+    @State var editorOverscroll = 0.3
 
     var body: some View { 
         CodeEditTextView(
@@ -22,7 +22,7 @@ struct ContentView: View {
             font: $font,
             tabWidth: $tabWidth,
             lineHeight: $lineHeight,
-            overScrollRatio: $overScrollRatio
+            editorOverscroll: $editorOverscroll
         )
     }
 }

Sources/CodeEditTextView/Documentation.docc/STTextViewController.md

@@ -10,4 +10,4 @@
 - ``font``
 - ``tabWidth``
 - ``lineHeightMultiple``
-- ``overScrollRatio``
+- ``editorOverscroll``

Sources/CodeEditTextView/STTextViewController.swift

@@ -42,8 +42,8 @@ public class STTextViewController: NSViewController, STTextViewDelegate, ThemeAt
     /// The font to use in the `textView`
     public var font: NSFont
 
-    /// The overScrollRatio to use for the textView over scroll
-    public var overScrollRatio: Double
+    /// The editorOverscroll to use for the textView over scroll
+    public var editorOverscroll: Double
 
     // MARK: - Highlighting
 
@@ -59,15 +59,15 @@ public class STTextViewController: NSViewController, STTextViewDelegate, ThemeAt
         theme: EditorTheme,
         tabWidth: Int,
         cursorPosition: Published<(Int, Int)>.Publisher? = nil,
-        overScrollRatio: Double
+        editorOverscroll: Double
     ) {
         self.text = text
         self.language = language
         self.font = font
         self.theme = theme
         self.tabWidth = tabWidth
         self.cursorPosition = cursorPosition
-        self.overScrollRatio = overScrollRatio
+        self.editorOverscroll = editorOverscroll
         super.init(nibName: nil, bundle: nil)
     }
 
@@ -184,7 +184,7 @@ public class STTextViewController: NSViewController, STTextViewDelegate, ThemeAt
     /// ScrollView's bottom inset using as editor overscroll
     private var bottomContentInsets: CGFloat {
         let height = view.frame.height
-        var inset = overScrollRatio * height
+        var inset = editorOverscroll * height
 
         if height - inset < lineHeight {
             inset = height - lineHeight

Tests/CodeEditTextViewTests/STTextViewControllerTests.swift

@@ -33,7 +33,7 @@ final class STTextViewControllerTests: XCTestCase {
             font: .monospacedSystemFont(ofSize: 11, weight: .medium),
             theme: theme,
             tabWidth: 4,
-            overScrollRatio: 0.5
+            editorOverscroll: 0.5
         )
     }
 
@@ -68,27 +68,27 @@ final class STTextViewControllerTests: XCTestCase {
                                  width: 100,
                                  height: 100)
 
-        // overScrollRatio: 0
+        // editorOverscroll: 0
         XCTAssertEqual(scrollView.contentView.contentInsets.bottom, 0)
 
-        controller.overScrollRatio = 0.5
+        controller.editorOverscroll = 0.5
         controller.reloadUI()
 
-        // overScrollRatio: 0.5
+        // editorOverscroll: 0.5
         XCTAssertEqual(scrollView.contentView.contentInsets.bottom, 50.0)
 
-        controller.overScrollRatio = 1.0
+        controller.editorOverscroll = 1.0
         controller.reloadUI()
 
-        // overScrollRatio: 1.0
+        // editorOverscroll: 1.0
         XCTAssertEqual(scrollView.contentView.contentInsets.bottom, 87.0)
     }
 
     func test_editorOverScroll_ZeroCondition() throws {
         let scrollView = try XCTUnwrap(controller.view as? NSScrollView)
         scrollView.frame = .zero
 
-        // overScrollRatio: 0
+        // editorOverscroll: 0
         XCTAssertEqual(scrollView.contentView.contentInsets.bottom, 0)
     }
 }