# asciify

> Plain text awesomizer. A hybrid npm module and CLI for turning plain text into ascii art.

Latest version **1.3.5** (published 2014-02-04) · BSD license · 0 weekly downloads

## Install

```sh
npm install asciify
pnpm add asciify
yarn add asciify
bun add asciify
```

Provides the command `asciify`.

## Health

**Score 23/100 (F)** — status: abandoned.

Positive: has types package; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.3.5 |
| Published | 2014-02-04 |
| First published | 2013-03-15 |
| Weekly downloads | 0 |
| License | BSD |
| TypeScript types | separate (@types/asciify) |
| Module format | CommonJS |
| Dependencies | 3 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 125 |
| Author | olizilla |
| Maintainers | olizilla, alanshaw |
| Keywords | ascii, art, figlet, banner, text |

## Links

- npm: https://www.npmjs.com/package/asciify
- Repository: https://github.com/olizilla/asciify
- Issues: https://github.com/olizilla/asciify/issues
- npm.io page: https://npm.io/package/asciify

## Dependencies (3)

- [pad](https://npm.io/package/pad.md) 0.0.4
- [chalk](https://npm.io/package/chalk.md) ~0.3.0
- [optimist](https://npm.io/package/optimist.md) ~0.6.0

## Alternatives

- [d3-force-3d](https://npm.io/package/d3-force-3d.md) — 1.0M weekly downloads
- [ng2-charts](https://npm.io/package/ng2-charts.md) — 486.8K weekly downloads
- [@arcgis/core](https://npm.io/package/@arcgis/core.md) — 257.8K weekly downloads
- [react-sparklines](https://npm.io/package/react-sparklines.md) — 249.3K weekly downloads
- [react-native-gifted-charts](https://npm.io/package/react-native-gifted-charts.md) — 182.3K weekly downloads

## Recent versions

- 1.3.5 (latest) — 2014-02-04
- 1.3.4 — 2014-02-04
- 1.3.3 — 2013-10-27
- 1.3.2 — 2013-06-07
- 1.3.1 — 2013-06-07
- 1.3.0 — 2013-06-06
- 1.2.0 — 2013-04-03
- 1.0.1 — 2013-03-15
- 1.0.0 — 2013-03-15

## README

ASCIIFY
=======
A hybrid npm module and CLI for turning plain text into ascii art. A pure JS figlet tool to make all your banners better.

                                        __________________________  ______________
                                        \__    ___/\_   _____/\   \/  /\__    ___/
    Takes text, awesomizes it, returns    |    |    |    __)_  \     /   |    |   
                                          |    |    |        \ /     \   |    |   
                                          |____|   /_______  //___/\  \  |____|   
                                                           \/       \_/           

[![NPM](http://nodei.co/npm/asciify.png)](http://nodei.co/npm/asciify/)

[![Dependency Status](https://david-dm.org/olizilla/asciify.png)](https://david-dm.org/olizilla/asciify)
[![Build Status](https://travis-ci.org/olizilla/asciify.png)](https://travis-ci.org/olizilla/asciify)

## Getting started

Install [Node.js](http://nodejs.org/) (tested on 0.8 and 0.10)

Install `asciify` and gasp:
    
    npm install -g asciify

    asciify "Boom" -f larry3d
     ____                                   
    /\  _`\                                 
    \ \ \L\ \    ___     ___     ___ ___    
     \ \  _ <'  / __`\  / __`\ /' __` __`\  
      \ \ \L\ \/\ \L\ \/\ \L\ \/\ \/\ \/\ \ 
       \ \____/\ \____/\ \____/\ \_\ \_\ \_\
        \/___/  \/___/  \/___/  \/_/\/_/\/_/
                                        

For a really good time call:

    asciify -a "All The Fonts!"


Or use it as a node module:

    asciify('Awesome', function(err, res){ console.log(res) });
       _____                                                     
      /  _  \  __  _  __  ____    ______  ____    _____    ____  
     /  /_\  \ \ \/ \/ /_/ __ \  /  ___/ /  _ \  /     \ _/ __ \ 
    /    |    \ \     / \  ___/  \___ \ (  <_> )|  Y Y  \\  ___/ 
    \____|__  /  \/\_/   \___  >/____  > \____/ |__|_|  / \___  >
            \/               \/      \/               \/      \/ 


And again with the font option:

    asciify('Fonts?', {font:'3-d'}, function(err, res){ console.log(res) });

     ********                     **            **** 
    /**/////                     /**           **//**
    /**        ******  *******  ******  ******/** /**
    /*******  **////**//**///**///**/  **//// //  ** 
    /**////  /**   /** /**  /**  /**  //*****    **  
    /**      /**   /** /**  /**  /**   /////**  //   
    /**      //******  ***  /**  //**  ******    **  
    //        //////  ///   //    //  //////    //   


Now with color support thanks to [chalk](https://github.com/sindresorhus/chalk) and @jlowgren

  asciify(
    'Make it come out green', 
    {color:'green'}, 
    function(err, res){ console.log(res)}
  );

**Bonus method**

    asciify.getFonts(function (err, fonts) { fonts.forEach( console.log ) )

## Thanks to

- [figlet-js][] which does the magic
- [optimist][], smoothing the choppy waters of CLI argument parsing.
- [node-tap][], robot friendly test codez, and all the wonders of npm.

[figlet-js]: https://github.com/scottgonzalez/figlet-js
[optimist]: https://github.com/substack/node-optimist
[node-tap]: https://github.com/isaacs/node-tap

## Developing

```shell
 git submodule init
 git submodule update
 npm install
 npm test
```

## Release History

* 1.3.5 - Fix chalk dependency mix up
* 1.3.4 - Add `color` option to pick your font color (DO NOT USE)
* 1.3.3 - Add maxWidth option to allow output truncation
* 1.3.2 - Update figlet-js with falsy input validation
* 1.3.1 - Update figlet-js with unknown char fixes
* 1.3.0 - Adds input validation and a getFonts method
* 1.2.0 - Asciify now a good node citizen, callback takes an error as first arg.
* 1.0.1 - IT BEGINS. ASCII BANNERS NOW MANDTORY.

---
_Source: https://npm.io/package/asciify · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._