Change name from Catacript to GatOS

.github/workflows/ci.yml

@@ -83,11 +83,11 @@ jobs:
 
       - name: Make target directories
         if: github.event_name != 'pull_request' && (startsWith(github.ref, 'refs/tags/v') || github.ref == 'refs/heads/main')
-        run: mkdir -p catscript/.js/target catscript/.native/target catscript/.jvm/target project/target
+        run: mkdir -p gatos/.native/target gatos/.js/target gatos/.jvm/target project/target
 
       - name: Compress target directories
         if: github.event_name != 'pull_request' && (startsWith(github.ref, 'refs/tags/v') || github.ref == 'refs/heads/main')
-        run: tar cf targets.tar catscript/.js/target catscript/.native/target catscript/.jvm/target project/target
+        run: tar cf targets.tar gatos/.native/target gatos/.js/target gatos/.jvm/target project/target
 
       - name: Upload target directories
         if: github.event_name != 'pull_request' && (startsWith(github.ref, 'refs/tags/v') || github.ref == 'refs/heads/main')
@@ -244,7 +244,7 @@ jobs:
       - name: Submit Dependencies
         uses: scalacenter/sbt-dependency-submission@v2
         with:
-          modules-ignore: catscript-examples_2.13 catscript-examples_3 rootjs_2.13 rootjs_3 docs_2.13 docs_3 rootjvm_2.13 rootjvm_3 rootnative_2.13 rootnative_3
+          modules-ignore: gatos-examples_2.13 gatos-examples_3 rootjs_2.13 rootjs_3 docs_2.13 docs_3 rootjvm_2.13 rootjvm_3 rootnative_2.13 rootnative_3
           configs-ignore: test scala-tool scala-doc-tool test-internal
 
   site:

README.md

@@ -1,9 +1,9 @@
-# Catscript 😸
+# GatOS 😸
 ### _Making scripts in Scala much easier!_
-![Continuous Integration](https://github.com/typelevel/catscript/workflows/Continuous%20Integration/badge.svg)
+![Continuous Integration](https://github.com/typelevel/gatos/workflows/Continuous%20Integration/badge.svg)
 
 ## Overview 
-Catscript is a library for working with files (and soon processes) using pure [`IO`](https://typelevel.org/cats-effect/docs/getting-started), designed to make things much easier. 
+GatOS (that's Spanish for Cats!) is a library for working with files (and soon processes) using pure [`IO`](https://typelevel.org/cats-effect/docs/getting-started), designed to make things much easier. 
 
 **Before**
 ```scala 3
@@ -23,29 +23,29 @@ It does this by drastically reducing the complexity of the `Files' API and getti
 
 ## Getting Started
 
-You can use Catscript in a new or existing Scala 2.13.x or 3.x project by adding it to your `build.sbt` file:
+You can use GatOS in a new or existing Scala 2.13.x or 3.x project by adding it to your `build.sbt` file:
 
 ```scala
 libraryDependencies ++= List(
-  "org.typelevel" %% "catscript" % latest
+  "org.typelevel" %% "gatos" % latest
 )
 ```
 
 ## Example
-Catscript is a library to perform common script operations such as working with processes and files while maintaining referential transparency! 
+GatOS is a library to perform common script operations such as working with processes and files while maintaining referential transparency! 
 
 ```scala 3 mdoc:reset
 import cats.effect.{IO, IOApp, ExitCode}
 
-import catscript.*
-import catscript.syntax.path.*
+import gatos.*
+import gatos.syntax.path.*
 
 object Main extends IOApp: 
 
   def run(args: List[String]): IO[ExitCode] = 
     for
       home   <- userHome
-      config = home / ".catscript" / "config.conf"
+      config = home / ".gatos" / "config.conf"
       _         <- config.createFile
       _         <- config.write("scripting.made.easy = true")
       newconfig <- config.read

build.sbt

@@ -16,13 +16,13 @@ ThisBuild / githubWorkflowJavaVersions := Seq(JavaSpec.temurin("17"))
 
 ThisBuild / crossScalaVersions := Seq("2.13.18", "3.3.7")
 
-lazy val root = tlCrossRootProject.aggregate(catscript, examples)
+lazy val root = tlCrossRootProject.aggregate(gatos, examples)
 
-lazy val catscript = crossProject(JVMPlatform, JSPlatform, NativePlatform)
+lazy val gatos = crossProject(JVMPlatform, JSPlatform, NativePlatform)
   .crossType(CrossType.Pure)
-  .in(file("catscript"))
+  .in(file("gatos"))
   .settings(
-    name := "catscript",
+    name := "gatos",
     libraryDependencies ++= List(
       "org.typelevel" %% "cats-core"   % "2.13.0",
       "org.typelevel" %% "cats-effect" % "3.7.0",
@@ -41,16 +41,16 @@ lazy val catscript = crossProject(JVMPlatform, JSPlatform, NativePlatform)
 lazy val examples = project
   .in(file("examples"))
   .enablePlugins(NoPublishPlugin)
-  .dependsOn(catscript.jvm)
+  .dependsOn(gatos.jvm)
   .settings(
-    name                 := "catscript-examples",
+    name                 := "gatos-examples",
     Compile / run / fork := true
   )
 
 lazy val docs = project
   .in(file("site"))
   .enablePlugins(TypelevelSitePlugin)
-  .dependsOn(catscript.jvm)
+  .dependsOn(gatos.jvm)
   .settings(
     libraryDependencies += "co.fs2" %% "fs2-scodec" % "3.13.0",
     laikaConfig := LaikaConfig.defaults

docs/examples/index.md

@@ -71,7 +71,7 @@ import cats.effect.{IO, IOApp}
 
 import fs2.io.file.Path
 
-import catscript.syntax.path.*
+import gatos.syntax.path.*
 
 object Scores extends IOApp.Simple:
 
@@ -105,7 +105,7 @@ import cats.effect.{IO, IOApp}
 
 import fs2.io.file.Path
 
-import catscript.Catscript
+import gatos.Gatos
 
 object Scores extends IOApp.Simple:
 
@@ -123,10 +123,10 @@ object Scores extends IOApp.Simple:
 
   def run: IO[Unit] =
     for
-      lines  <- Catscript.readLines(path)
+      lines  <- Gatos.readLines(path)
       scores <- lines.traverse(parseScore(_).liftTo[IO])
       _      <- IO(scores.foreach(score => println(score.show)))
-      _      <- Catscript.appendLine(path, Score("daniela", 100).show)
+      _      <- Gatos.appendLine(path, Score("daniela", 100).show)
     yield ()
 
 end Scores
@@ -206,7 +206,7 @@ Here, the complete script:
 import cats.effect.{IO, IOApp}
 import fs2.io.file.Path
 
-import catscript.syntax.path.*
+import gatos.syntax.path.*
 
 object Uppercase extends IOApp.Simple:
 
@@ -228,7 +228,7 @@ end Uppercase
 import cats.effect.{IO, IOApp}
 import fs2.io.file.Path
 
-import catscript.syntax.Catscript
+import gatos.syntax.Gatos
 
 object Uppercase extends IOApp.Simple:
 
@@ -237,8 +237,8 @@ object Uppercase extends IOApp.Simple:
 
   def run: IO[Unit] =
     for
-      file <- Catscript.read(path)
-      _    <- Catscript.write(upperPath, file.toUpperCase)
+      file <- Gatos.read(path)
+      _    <- Gatos.write(upperPath, file.toUpperCase)
     yield ()
 
 end Uppercase
@@ -270,7 +270,7 @@ end Uppercase
 
 ## Places
 
-Catscript can handle binary files in custom binary formats since it includes [scodec](https://scodec.org/). In this example, we are going to create a binary file with a list of places.  
+GatOS can handle binary files in custom binary formats since it includes [scodec](https://scodec.org/). In this example, we are going to create a binary file with a list of places.  
 
 We start by defining type representations of the data we are going to work with:  
 
@@ -326,7 +326,7 @@ import fs2.io.file.Path
 import scodec.codecs.*
 import scodec.Codec
 
-import catscript.syntax.path.*
+import gatos.syntax.path.*
 
 object Place extends IOApp.Simple:
 
@@ -358,7 +358,7 @@ import fs2.io.file.Path
 import scodec.codecs.*
 import scodec.Codec
 
-import catscript.syntax.Catscript
+import gatos.syntax.Gatos
 
 object Place extends IOApp.Simple:
 
@@ -368,11 +368,11 @@ object Place extends IOApp.Simple:
 
   def run: IO[Unit] =
     for
-      exists <- Catscript.exists(path)
+      exists <- Gatos.exists(path)
              // Equivalent of doing `if (exists) IO.unit else path.createFile`
-      _      <- Catscript.createFile(path).unlessA(exists)
-      _      <- Catscript.writeAs[Place](path, Place(1, "Michael Phelps"))
-      place  <- Catscript.readAs[Place](path)                                
+      _      <- Gatos.createFile(path).unlessA(exists)
+      _      <- Gatos.writeAs[Place](path, Place(1, "Michael Phelps"))
+      place  <- Gatos.readAs[Place](path)                                
       _      <- IO.println(place)
     yield ()
 

docs/examples/solutions.md

@@ -7,7 +7,7 @@ This section offers possible solutions to the documentation's exercises. Refer t
 ```scala mdoc:compile-only
 import cats.effect.{IO, IOApp}
 import fs2.io.file.Path
-import org.typelevel.catscript.syntax.path.*
+import org.typelevel.gatos.syntax.path.*
 
 object ReadingSolution extends IOApp.Simple:
 
@@ -28,7 +28,7 @@ end ReadingSolution
 ```scala mdoc:compile-only
 import cats.effect.{IO, IOApp}
 import fs2.io.file.Path
-import org.typelevel.catscript.syntax.path.*
+import org.typelevel.gatos.syntax.path.*
 
 object WritingSolution extends IOApp.Simple:
 
@@ -50,7 +50,7 @@ end WritingSolution
 ```scala mdoc:compile-only
 import cats.effect.{IO, IOApp}
 import fs2.io.file.Path
-import org.typelevel.catscript.syntax.path.*
+import org.typelevel.gatos.syntax.path.*
 
 object LinesSolution extends IOApp.Simple:
 
@@ -72,7 +72,7 @@ end LinesSolution
 ```scala mdoc:compile-only
 import cats.effect.IO
 import fs2.io.file.Path
-import org.typelevel.catscript.syntax.path.*
+import org.typelevel.gatos.syntax.path.*
 
 extension (path: Path) 
   def createFileAndDirectories: IO[Unit] = 
@@ -88,7 +88,7 @@ extension (path: Path)
 import cats.syntax.all.*
 import cats.effect.IO
 import fs2.io.file.Path
-import org.typelevel.catscript.syntax.path.*
+import org.typelevel.gatos.syntax.path.*
 
 extension (path: Path) 
   def deleteIfChubby(threshold: Long): IO[Boolean] = 
@@ -104,7 +104,7 @@ extension (path: Path)
 ```scala mdoc:compile-only
 import cats.effect.{IO, Resource}
 import fs2.io.file.Path
-import org.typelevel.catscript.syntax.path.*
+import org.typelevel.gatos.syntax.path.*
 
 def makeTempFile: Resource[IO, Path] = 
   Resource.make(createTempFile)(p => p.deleteIfExists.void)

docs/index.md

@@ -1,31 +1,31 @@
-# Catscript 😸
+# GatOS 😸
 **Making scripts in pure Scala much easier!**
 
 ## Getting Started
 
-You can use Catscript in a new or existing Scala 2.13.x or 3.x project by adding it to your `build.sbt` file:
+You can use GatOS in a new or existing Scala 2.13.x or 3.x project by adding it to your `build.sbt` file:
 
 ```scala
 libraryDependencies ++= Seq(
-  "org.typelevel" %% "catscript" % "@VERSION@"
+  "org.typelevel" %% "gatos" % "@VERSION@"
 )
 ```
 
 ## Example
-Catscript is a library to perform common script operations such as working with processes and files while maintaining referential transparency! 
+GatOS is a library to perform common script operations such as working with processes and files while maintaining referential transparency! 
 
 ```scala 3 mdoc:reset
 import cats.effect.{IO, IOApp, ExitCode}
 
-import catscript.*
-import catscript.syntax.path.*
+import gatos.*
+import gatos.syntax.path.*
 
 object Main extends IOApp: 
 
   def run(args: List[String]): IO[ExitCode] = 
     for
       home   <- userHome
-      config = home / ".catscript" / "config.conf"
+      config = home / ".gatos" / "config.conf"
       _         <- config.createFile
       _         <- config.write("scripting.made.easy = true")
       newconfig <- config.read

docs/introduction/index.md

@@ -2,20 +2,20 @@
 
 ## Which API should I use?
 
-In Catscript, you have two different ways of doing things:
+In GatOS, you have two different ways of doing things:
 
-- First, if you prefer a more concise syntax, use the extension methods (e.g. `path.read()`) by importing the `catscript.syntax.path.*` package. 
+- First, if you prefer a more concise syntax, use the extension methods (e.g. `path.read()`) by importing the `gatos.syntax.path.*` package. 
 
-- If you prefer calling static methods, use direct method calls on the `Catscript` object (e.g., `Catscript.read(path)`). You can also import all the functions inside the `catscript.Catscript` package if you don't want to call the `Catscript` object every time (e.g., `read(path)`). 
+- If you prefer calling static methods, use direct method calls on the `Gatos` object (e.g., `Gatos.read(path)`). You can also import all the functions inside the `gatos.Gatos` package if you don't want to call the `Gatos` object every time (e.g., `read(path)`). 
 
-In this documentation we'll call the methods on the `Catscript` objects in the static variant to differentiate them from the extension ones.  
+In this documentation we'll call the methods on the `Gatos` objects in the static variant to differentiate them from the extension ones.  
 
 @:select(api-style)
 
 @:choice(syntax)
 
 ```scala 3
-import catscript.syntax.all.*
+import gatos.syntax.all.*
 
 val path = Path("data/test.txt")
 
@@ -28,13 +28,13 @@ yield ()
 @:choice(static)
 
 ```scala 3
-import catscript.Catscript
+import gatos.Gatos
 
 val path = Path("data/test.txt")
 
 for
-  file <- Catscript.read(path)
-  _    <- Catscript.append(path, "I'll place this here.")
+  file <- Gatos.read(path)
+  _    <- Gatos.append(path, "I'll place this here.")
 yield ()
 ```
 
@@ -44,11 +44,11 @@ Which one you should use really depends on your preferences and choices; if you
 
 ## Imports
 
-If you just want to start scripting right away, importing `catscript.*` will do the trick; it imports all the extension methods and functionality you need, such as types and functions, to start working right away.
+If you just want to start scripting right away, importing `gatos.*` will do the trick; it imports all the extension methods and functionality you need, such as types and functions, to start working right away.
 
-But if you want more concise functionality, the `catscript.syntax.path.*` will only import the extension methods.
+But if you want more concise functionality, the `gatos.syntax.path.*` will only import the extension methods.
 
-For the static methods, the `catscript.Catscript` will provide the functions to work with files, if that is your preferred style.
+For the static methods, the `gatos.Gatos` will provide the functions to work with files, if that is your preferred style.
 
 
 ## Talking about computations