README.md

smartargs

A simple scala library to parse your command line arguments.

Accepted argument format

--name peppo --age 26 --play-bass true

Why smartargs?

• smartargs usage adoption is super fast and light, you just need to follow the accepted argument format.

• you can map your command line arguments directly into domain object, just write your own converter for your own business class

Usage

Basic object conversion

import holydrinker.smartargs.core.SmartArgs
import holydrinker.smartargs.converters.DefaultConverters._

// args = Array("--name", "peppo", "--age", "27", "--play-bass", "true")
def main(args: Array[String]){
  val smartargs = SmartArgs(args)
  val name = smartargs.getAs[String]("name")
  val age = smartargs.getAs[Int]("age")
  val canPlayBass = smartargs.getAs[Boolean]("play-bass")
}

Basic sequence conversion

import holydrinker.smartargs.core.SmartArgs
import holydrinker.smartargs.converters.DefaultConverters._

object BasicSequenceConversion {

  def main(args: Array[String]): Unit = {
    val realArgs = Array("--artists", "Dave-Grohl,Simon-Neil")
    val smartArgs = SmartArgs(realArgs)
    val artists = smartArgs.getAs[Seq[String]]("artists")
    println(artists) // this prints: Seq(Dave-Grohl, Simon-Neil)
  }

}

Custom object conversion

import holydrinker.smartargs.converters.SmartConverter
import holydrinker.smartargs.core.SmartArgs

/* Defining your own business object */
case class Person(name: String, age: Int, canPlayBass: Boolean)

/*
Define you own converter

You know that you are gonna pass the person argument like this
--person peppo_27_true
*/
object PersonConverter {
  implicit val personConverter = new SmartConverter[Person] {
    override def convert(arg: String): Person = {
      val split = arg.split("_")
      Person(
        name = split(0),
        age = split(1).toInt,
        canPlayBass = split(2).toBoolean)
    }
  }
}

/* Putting things together */
object BusinessObjectConverterUsage {
  import PersonConverter._

  // args = Array("--person", "peppo_27_true")
  def main(args: Array[String]): Unit = {
    val smartargs = SmartArgs(args)
    val person = smartargs.getAs[Person]("person")
    println(s"Name: ${person.name} Age: ${person.age} CanPlayBass: ${person.canPlayBass}")
  }
}

Custom sequence conversion

import holydrinker.smartargs.core.SmartArgs
import holydrinker.smartargs.converters.DefaultConverters._
import holydrinker.smartargs.converters.SmartConverter

case class Artist(name: String, surname: String)

object Artist {
  implicit val artistConverter = new SmartConverter[Artist] {
    override def convert(arg: String): Artist = {
      val split = arg.split("-")
      Artist(name = split(0), surname = split(1))
    }
  }
}

object CustomSequenceConversion {

  def main(args: Array[String]): Unit = {
    val realArgs = Array("--artists", "Dave-Grohl,Simon-Neil")
    val smartArgs = SmartArgs(realArgs)

    implicit val seqArtistConverter = converter[Artist]
    val artists = smartArgs.getAs[Seq[Artist]]("artists")

    println(artists) // this prints: Seq(Artist(Dave,Grohl), Artist(Simon,Neil))
  }

}