Git Product home page Git Product logo

ansi-interpolator's Introduction

ansi-interpolator Build Status

A scala (2.11+) macro based ansi interpolator.

It has two advantages over non-macro interpolators:

  • is faster and lighter (brings no extra dependency at runtime)
  • detects syntax issues at compile time

Usage

Add the following dependency to your SBT project:

"org.backuity" %% "ansi-interpolator" % "1.1" % "provided"

Note about provided: see this stackoverflow answer for a better SBT dependency scope.

Import the AnsiFormatter and use the ansi interpolator:

import org.backuity.ansi.AnsiFormatter.FormattedHelper

ansi"Text containing ansi tags such as %bold{bold text} or %underline{can be %yellow{nested}}"

Here is the list of supported tags:

  • bold
  • underline
  • italic (may not work on every terminal)
  • blink (may not work on every terminal)

And color tags:

  • black
  • red
  • green
  • yellow
  • blue
  • magenta
  • cyan
  • white

Syntax errors are detected at compile time

[error] .../Main.scala:17: Unsupported tag underlin
[error]     println(ansi"Please %underlin{underline this : $str}")
[error]                          ^

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.