Catscript 😸

Making scripts in Scala much easier!

Overview

Catscript is a library for working with files (and soon processes) using pure IO, designed to make things much easier.

Before

Files[IO]
  .readUtf8(path)
  .evalMap(IO.println(_))
  .compile
  .drain

After

path.read >>= IO.println 

It does this by drastically reducing the complexity of the `Files' API and getting rid of difficult concepts that are not so necessary for scripting.

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:

libraryDependencies ++= List(
  "org.typelevel" %% "catscript" % latest
)

Example

Catscript is a library to perform common script operations such as working with processes and files while maintaining referential transparency!

import cats.effect.{IO, IOApp, ExitCode}

import catscript.*
import catscript.syntax.path.*

object Main extends IOApp: 

  def run(args: List[String]): IO[ExitCode] = 
    for
      home   <- userHome
      config = home / ".catscript" / "config.conf"
      _         <- config.createFile
      _         <- config.write("scripting.made.easy = true")
      newconfig <- config.read
      _         <- IO.println(s"Loading config: $newconfig")
    yield ExitCode.Success
    
end Main