More user visible types into top-level package

Users will have to interact with Eof, Timeout, and Key. They shouldn't need to import things from `terminus.effect`, so move these types into `terminus`.
creativescala · Feb 7, 2025 · 04ae00e · 04ae00e
1 parent bb08941
commit 04ae00e
Show file tree

Hide file tree

Showing 15 changed files with 17 additions and 20 deletions.
diff --git a/core/jvm/src/main/scala/terminus/JLineTerminal.scala b/core/jvm/src/main/scala/terminus/JLineTerminal.scala
@@ -19,9 +19,7 @@ package terminus
 import org.jline.terminal.Terminal as JTerminal
 import org.jline.terminal.TerminalBuilder
 import org.jline.utils.InfoCmp.Capability
-import terminus.effect.Eof
 import terminus.effect.TerminalKeyReader
-import terminus.effect.Timeout
 
 import scala.concurrent.duration.Duration
 

diff --git a/core/jvm/src/main/scala/terminus/Prompt.scala b/core/jvm/src/main/scala/terminus/Prompt.scala
@@ -16,9 +16,6 @@
 
 package terminus
 
-import terminus.effect.Eof
-import terminus.effect.Key
-
 import scala.annotation.tailrec
 
 // The only keys we care about

diff --git a/core/native/src/main/scala/terminus/NativeTerminal.scala b/core/native/src/main/scala/terminus/NativeTerminal.scala
@@ -17,7 +17,6 @@
 package terminus
 
 import terminus.effect.AnsiCodes
-import terminus.effect.Eof
 import terminus.effect.WithEffect
 
 import scala.scalanative.libc

diff --git a/core/native/src/main/scala/terminus/Prompt.scala b/core/native/src/main/scala/terminus/Prompt.scala
@@ -17,7 +17,6 @@
 package terminus
 
 import terminus.effect.Ascii
-import terminus.effect.Eof
 
 enum KeyCode {
   case Down

diff --git a/.../src/main/scala/terminus/effect/Key.scala → .../shared/src/main/scala/terminus/Key.scala b/.../src/main/scala/terminus/effect/Key.scala → .../shared/src/main/scala/terminus/Key.scala
@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 
-package terminus.effect
+package terminus
 
 /** Enumeration describing the key presses we recognize from the terminal */
 enum Key {

diff --git a/core/shared/src/main/scala/terminus/KeyReader.scala b/core/shared/src/main/scala/terminus/KeyReader.scala
@@ -16,9 +16,6 @@
 
 package terminus
 
-import terminus.effect.Eof
-import terminus.effect.Key
-
 trait KeyReader {
 
   /** Block waiting for a key. */

diff --git a/core/shared/src/main/scala/terminus/NonBlockingReader.scala b/core/shared/src/main/scala/terminus/NonBlockingReader.scala
@@ -16,9 +16,6 @@
 
 package terminus
 
-import terminus.effect.Eof
-import terminus.effect.Timeout
-
 import scala.concurrent.duration.Duration
 
 trait NonBlockingReader {

diff --git a/core/shared/src/main/scala/terminus/Peeker.scala b/core/shared/src/main/scala/terminus/Peeker.scala
@@ -16,9 +16,6 @@
 
 package terminus
 
-import terminus.effect.Eof
-import terminus.effect.Timeout
-
 import scala.concurrent.duration.Duration
 
 trait Peeker {

diff --git a/core/shared/src/main/scala/terminus/Reader.scala b/core/shared/src/main/scala/terminus/Reader.scala
@@ -16,8 +16,6 @@
 
 package terminus
 
-import terminus.effect.Eof
-
 trait Reader {
   def read(): effect.Reader ?=> Eof | Char =
     effect ?=> effect.read()

diff --git a/...rc/main/scala/terminus/effect/Types.scala → ...hared/src/main/scala/terminus/Types.scala b/...rc/main/scala/terminus/effect/Types.scala → ...hared/src/main/scala/terminus/Types.scala
@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 
-package terminus.effect
+package terminus
 
 // Miscellaneous types that don't fit elsewhere.
 

diff --git a/core/shared/src/main/scala/terminus/effect/KeyReader.scala b/core/shared/src/main/scala/terminus/effect/KeyReader.scala
@@ -16,6 +16,9 @@
 
 package terminus.effect
 
+import terminus.Eof
+import terminus.Key
+
 trait KeyReader extends Effect {
   def readKey(): Eof | Key
 }
diff --git a/core/shared/src/main/scala/terminus/effect/NonBlockingReader.scala b/core/shared/src/main/scala/terminus/effect/NonBlockingReader.scala
@@ -16,6 +16,9 @@
 
 package terminus.effect
 
+import terminus.Eof
+import terminus.Timeout
+
 import scala.concurrent.duration.Duration
 
 trait NonBlockingReader extends Effect {

diff --git a/core/shared/src/main/scala/terminus/effect/Peeker.scala b/core/shared/src/main/scala/terminus/effect/Peeker.scala
@@ -16,6 +16,9 @@
 
 package terminus.effect
 
+import terminus.Eof
+import terminus.Timeout
+
 import scala.concurrent.duration.Duration
 
 trait Peeker extends Effect {

diff --git a/core/shared/src/main/scala/terminus/effect/Reader.scala b/core/shared/src/main/scala/terminus/effect/Reader.scala
@@ -16,6 +16,8 @@
 
 package terminus.effect
 
+import terminus.Eof
+
 trait Reader extends Effect {
   def read(): Eof | Char
 }
diff --git a/core/shared/src/main/scala/terminus/effect/TerminalKeyReader.scala b/core/shared/src/main/scala/terminus/effect/TerminalKeyReader.scala
@@ -16,6 +16,10 @@
 
 package terminus.effect
 
+import terminus.Eof
+import terminus.Key
+import terminus.Timeout
+
 import scala.concurrent.duration.*
 
 /** An implementation of KeyReader that interprets the standard terminal escape