Git Product home page Git Product logo

re-ansi's Introduction

re-ansi

Ansi code to HTML

Features

re-ansi supports:

  • Cursor movement: \n, line erase and \r line erase
  • SGR parameter: italic, bold, underline and line-through
  • 3/4 bits color code

re-ansi removes styles on new lines, so that a <br /> can't be nested inside <span style> elements.

For details, see the AnsiCode.parse function.

Install

Add to your package.json:

npm install @softwarefactory-project/re-ansi

Or using yarn:

yarn add @softwarefactory-project/re-ansi

Add to your bsconfig.json:

"bs-dependencies": [
+  "@softwarefactory-project/re-ansi"
]

Usage

In reason:

let log = "green color: \x1b[01m\x1b[01;32mOK\x1b[00m";

[@react.component]
let make = () => {
  <Ansi log />
}

In javascript:

import Ansi from "@softwarefactory-project/re-ansi";

let make = () => (
  <Ansi log="content..." />;
);

Contribute

Contributions are most welcome, for example the project needs help to:

  • support more ANSI code.
  • enable custom colors, such as solarized, by changing the fourBitColors function to a property.

Get started by running:

git clone https://github.com/softwarefactory-project/re-ansi
cd re-ansi
yarn install
yarn start

Then build and run tests with yarn test.

Make sure to read about React and Reason too.

Changes

0.6.0

  • Fix support for bright colors.

0.5.0

  • Add support for [m and [K.

0.4.0

  • Add support for underline and line-through text decoration.
  • Add support for lighter font style.
  • Add initial support for color reset.

0.3.0

  • Add unique keys to react list elements.
  • Create a href elements for http links.

0.2.1

  • Fix Ansi.parse to return the full document instead of the last line.

0.2.0

  • Fix a recursion limit in Ansi.parse for log bigger than 10MB.

0.1.3

  • Initial release.

re-ansi's People

Contributors

tristancacqueray avatar aladjadj avatar sf-project-io avatar

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.