Skip to content

Sauloxd/font-ascii

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

80 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

fontascii

Font Ascii

An Awesome Logger That will log an ASCII phrase for you! Import and use it in your code, or just use the CLI (command line interface)

howtouse

How to use

Easy! Just type this in your project

npm i --save font-ascii

or

npm i -g font-ascii

Using - CLI

If you installed globally, just: font-ascii 'Hello World'

Otherwise, use it like: $(npm bin)/font-ascii 'Hello World'

Using - Importing

You can import it on your project like this:

//ES6 Flavour
import formPhrase from 'font-ascii';

//Old fashioned
var formPhrase = require('font-ascii').default;

Using

formPhrase('Awesome Phrase');

Configuration

Typeface

Per default, it will use a random font, but you can choose one of the following: (if there is a typo, it will fallback to a random font!)

  • Acrobatic
  • Alpha
  • Avatar
  • Big
  • BigMoneyne
  • BigMoneynw
  • BigMoneyse
  • BigMoneysw
  • Blocks
  • Bulbhead
  • Cards
  • Chiseled
  • Crawford2
  • Crazy
  • DancingFont
  • Diagonal3d
  • Doh
  • Doom
  • EftiWall
  • Epic
  • Firefontk
  • FireFonts
  • FlowerPower
  • FunFace
  • FunFaces
  • Ghost
  • Graceful
  • Graffiti
  • Impossible
  • Isometric1
  • Isometric2
  • Isometric3
  • Isometric4
  • JSBracketLetters
  • LilDevil
  • Merlin1
  • Modular
  • Ogre
  • PatorjkCheese
  • PatorjkHeX
  • Rectangles
  • Slant
  • SlantRelief
  • Small
  • SmallIsometric1
  • SmallSlant
  • Soft
  • Standard
  • StarWars
  • SubZero
  • SwampLand
  • Sweet
  • Train
  • Twisted
  • Varsity
  • WetLetts

And pass it like:

formPhrase('Hello', { typeface: 'Diagonal3d' });

or

font-ascii Hello -t Diagonal3d

or

font-ascii Hello --typeface Diagonal3d

Color

You can choose one of these defaults color. Otherwise it's always random:

  • 'red'
  • 'green'
  • 'yellow'
  • 'blue'
  • 'magenta'
  • 'cyan'
  • 'white'
  • 'gray'
  • 'grey'
formPhrase('Hello', { typeface: 'Diagonal3d', color: 'red' });

or

font-ascii Hello -c red

or

font-ascii Hello --color red

Object

const config = {
  typeface: STRING,
  color: STRING,
  verbose: BOOLEAN,
};

Contributing

It's a random idea I had and done in my free time, so probably it contains a lot of bugs, but feel free to open a PR with any optimization! Anything would be awesome!

And ISSUES, open them if you find anything wrong.

LOTS AND LOTS of kudos to this guys, and his awesome site:

Patorjk

There you'll find shit ton of other fonts.

Development

First clone the repo:

git clone [email protected]:Sauloxd/font-ascii.git

Enter the cloned repo and install dependencies! Make sure you are using yarn (since its my package manager of choice) - How to install yarn

cd font-ascii
yarn install

Just call this command!

yarn start hello

And it will call the development version of this project!

There is no currently easy way to test the compiled version, so we must believe the @babel power :)

About

Print a magical phrase using node!

Resources

Stars

Watchers

Forks

Packages

No packages published