@softwarefactory-project/re-ansi

    0.4.0 • Public • Published

    re-ansi

    Ansi code to HTML

    Features

    re-ansi supports:

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

    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.4.0

    • Add support for underline and line-through text decoration
    • Add support for lighter font style

    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

    Install

    npm i @softwarefactory-project/re-ansi

    DownloadsWeekly Downloads

    11

    Version

    0.4.0

    License

    Apache-2.0

    Unpacked Size

    48.1 kB

    Total Files

    6

    Last publish

    Collaborators

    • tristanc