patorjk / figlet.js Goto Github PK

Hello there, first of all, thanks for this awesome package which enhances all our CLI tool 👍

Problem Statement

We would like to develop a more robust CLI tool using Webpack & TypeScript. Everything is setup and works properly but I'm running into some errors with figlet integration.

Context

Here is my setup for the project, I will create a boilerplate if needed on Github.
But right now, I can share the webpack.config.js:

const path = require('path');

module.exports = {
  mode: 'development',
  entry: './src/index.ts',
  target: 'node',
  stats: {
    warnings: false // /!\ nunjucks as broken import, so webpack log warnings, disabling them for now...
  },
  module: {
    rules: [
      {
        test: /\.tsx?$/,
        use: 'ts-loader',
        exclude: /node_modules/
      }
    ]
  },
  resolve: {
    extensions: ['.tsx', '.ts', '.js']
  },
  output: {
    filename: 'bundle.js',
    path: path.resolve(__dirname, 'dist'),
    libraryTarget: 'commonjs'
  }
};

and the tsconfig.json

{
  "compilerOptions": {
    "target": "es2017",
    "module": "commonjs",
    "outDir": "./dist",
    "strict": true,
    "baseUrl": "./src/",
    "typeRoots": ["node_modules/@types"],
    "types": ["node"],
    "esModuleInterop": true,
    "inlineSourceMap": true,
    "experimentalDecorators": true,
    "emitDecoratorMetadata": true,
    "resolveJsonModule": true,
    "preserveSymlinks": true
  }
}

But when I want to use figlet there is some errors.

First, with a simple implementation:

import figlet from 'figlet';

console.log(chalk.greenBright(figlet.textSync('plop')));

This will throw an error because webpack doesn't achieve to resolve the fonts folder.

(node:12876) UnhandledPromiseRejectionWarning: Error: ENOENT: no such file or directory, open '/fonts/Standard.flf'
    at Object.openSync (fs.js:440:3)
    at Object.readFileSync (fs.js:342:35)
    at Function.figlet.loadFontSync (webpack:///./node_modules/figlet/lib/node-figlet.js?:48:23)
    at Object.me.textSync (webpack:///./node_modules/figlet/lib/figlet.js?:732:43)
    at main (webpack:///./src/index.ts?:27:52)
    at Object.eval (webpack:///./src/index.ts?:66:1)
    at eval (webpack:///./src/index.ts?:68:30)

I saw issues about this: #46 & #50 but the node: { __dirname: false } just don't work (or you have to copy the fonts folder at root of your project) & figlet.parseFont has no typing - see DefinitelyTyped/DefinitelyTyped#38318

import figlet from "figlet";
import banner3 from "figlet/importable-fonts/Banner3";

figlet.parseFont("Banner3", banner3);

Add to this, the solution with parseFont is the best I think but you have to declare all importable-fonts in the typing too or you will get this error: If the 'figlet' package actually exposes this module, consider sending a pull request to amend 'https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/figlet.ts(7016)

import figlet from "figlet";
import banner3 from "figlet/importable-fonts/Banner3";

figlet.parseFont("Banner3", banner3);

Possible Solution

I think we just need to update the typing of figlet on https://github.com/DefinitelyTyped/DefinitelyTyped/blob/master/types/figlet/index.d.ts

• add parseFont
• expose importable-fonts as a module

I'm not an expert on module typing with TypeScript that's why I create an issue & not a pull request in order to discuss the best way to create the typing.

Thanks for help 👍

I just spend a few days, debuging problems with rpm build in my project. I discover, that package was unable to build because of ' character in fonts name (node_modules/figlet/fonts/Patorjk's?Cheese.flf), it's causing some strange errors in building package.
Is there any possibility to change this font name to "PatorjksCheese.flf" or similar?

Fonts causing problems:

• node_modules/figlet/fonts/Patorjk's?Cheese.flf
• node_modules/figlet/importable-fonts/Patorjk's?Cheese.js

os: macOs 10.15.3
node: 8.9.4
Error: ENOENT: no such file or directory, open '/fonts/Standard.flf'
change another font type also get this error message

I made little script to get a overview over all fonts that are possible:

var fs = require('fs');

var figlet = require('figlet');

fs.readdirSync('./node_modules/figlet/fonts').forEach(function(font) {
    if (font.indexOf('.flf') == -1) return;

    figlet.text('abc ABC ...', {
        font: font.split('.')[0]
    }, function(err, data) {
        if (err) return console.log('Something went wrong...');

        console.log(font);
        console.log(data);
    });
});

when running figlet breaks on several of the included fonts with the following error:

undefined:1
undefined
^
SyntaxError: Unexpected token u
    at Object.parse (native)
    at D:\programming\strichliste\node_modules\figlet\lib\figlet.js:716:31
    at D:\programming\strichliste\node_modules\figlet\lib\node-figlet.js:24:13
    at Function.me.parseFont (D:\programming\strichliste\node_modules\figlet\lib\figlet.js:899:21)
    at D:\programming\strichliste\node_modules\figlet\lib\node-figlet.js:23:16
    at fs.js:266:14
    at Object.oncomplete (fs.js:107:15)

Is there anyway to use it in colors like red and blue?

Hi,
first of all: awesome node module!

Would it be possible for you to implement a Sync function that simply returns data instead of logging it to console? The Async way is fine, however that requires to work with promises which sometimes is overhead.

Thank you and regards
Phil

Hello,

It could be great to have a preview of all fonts.

For the moment I do this command:

figlet -l|xargs -I FONT sh -c 'echo "FONT:" && figlet -f "FONT" "Imhotep" && echo "-------------------------"'

which works great but it could be built-in.

Just got this error when using a custom font in NodeJS. Even the example 'Ghost' font doesn't work. And preloadFonts use fetch so it's for browser only.

I have code like this:

const { promisify } = require('util');
const figlet = require('figlet');
const render = promisify(figlet.text);

const config = {
    font: 'Colossal',
    width: 80,
    whitespaceBreak: true
};

module.exports = async () => {
    const text = 'Jakub T. Jankiewicz';
    return {
        wrap: await render(text, {...config, width: 12}),
        big: await  render(text, config)
    };
};

The issue with probably with line wrapping.

Running this on Ubuntu:

const figlet = require('figlet');

console.log(
  chalk.keyword('orange')(
    figlet.textSync('scooter-cli', {font: 'small slant', horizontalLayout: 'full', verticalLayout: 'controlled smushing'})
  ) + 'v' + chalk.white.bold(pkg.version) + '\n\n\n'
);

...results in the following error:

Error: ENOENT: no such file or directory, open '/home/ubuntu/dev/scooter/cli/node_modules/figlet/fonts/small slant.flf'

Not critical but thought I would report it.

https://github.com/cmatsuoka/figlet has a option :
-t terminal -- FIGlet asks your terminal how wide it is, and uses
this to determine when to break lines. Normally, FIGlet assumes
80 columns so that people with wide terminals won't annoy the
people they e-mail FIGlet output to.

How do I use this?

Actually , i had added a header text a time ago , Most probably with figlet !! (Bcause It Is Installed Now)
and now when i want to change the text ..
i open the bash.bashrc file but at the END there is no text added , and if i add the new one, terminal displays both,,
so can anyone tell me that how to remove the first one pls...
@patorjk

SCREENSHOT BELOW :

Using this in my node server gives the skewed output

import standard from "figlet/importable-fonts/Standard.js";
figlet.parseFont("Standard", standard);
figlet.text(
  "Anobisssss",
  {
    font: "Standard"
  },
  function(err, data) {
    console.log(data);
  }
);

While specifying without parseFont works fine, figlet("Anobis", { font: "Red Phoenix" }, (...))

Hi,
First, congrats for this great package, used by many IDE extensions!

In many of those extensions (eg. Banner Comments for VSCode), the default font is "ANSI Shadow".
The problem with this font is that it is not readable in the minimap on the right side.

The "ANSI Regular" solves the readability issue, unfortunately it is not included by default in your package.

The "ANSI Regular" can be found in https://github.com/xero/figlet-fonts or https://github.com/miguelmota/figlet-ansi-regular-font

It would be wonderful if you could add it and consequently make it available in all those extensions that depend on your package.
Thank you!

i successfully generated the words in cmd i wanted but i don't know how to use these in html comments of my page now i build them in sublime and copy them We should make some GUI interface for ease

Code : return next(err)

Error message : next is not function

I would love to contribute to this fantastic module and I think migrating to ES6 would minimize the codebase. Can I go ahead ?

I found the same issue(#73), but it is closed.

I examined the code, then found a few things.

1. In generateFigTextLines, nextFigChars.chars becomes undefined; It is because of breakWord.
2. When nextFigChars.chars is undefined, joinFigArray throws an Error.

The first thing is a more significant problem.
The code looks like this:

function breakWord(figChars, len, opts) {
        var result = {};
        for (var i = figChars.length; --i;) {
            var w = joinFigArray(figChars.slice(0, i), len, opts);
            if (figLinesWidth(w) <= opts.width) {
                result.outputFigText = w;
                if (i < figChars.length) {
                    result.chars = figChars.slice(i);
                } else {
                    result.chars = [];
                }
                break;
            }
        }
        return result;
    }

The return value, result, is sometimes not fully initialized.

Everything runs fine on MacOSX, but i moved my project to run a on Cent OS, and now I get this error. The rest of my project runs fine as well.

node server.js

{ Error: ENOENT: no such file or directory, open '/home/mitsuha/node_modules/figlet/lib/../fonts/colossal.flf'
    at Error (native)
  errno: -2,
  code: 'ENOENT',
  syscall: 'open',
  path: '/home/mitsuha/node_modules/figlet/lib/../fonts/colossal.flf' }

I can confirm the font exist, but not in that directory. They are in node_modules/figlet/fonts

Here is my code...

const figlet = require('figlet');

figlet('Mitsuha', {
            font: 'colossal',
        },
        (err, data) => {
            if (err) return console.log(err);
            console.log(data);
        });

When I include Figlet.js to the front-end using browserify, the whole thing stops working because of the fs module.

I tried to avoid calling methods that use fs mainly by preloading the fonts using preloadFonts method.

However, when using text or textSync methods the loadFontSync method gets triggered in node.js mode which does not check for already loaded fonts as in the case of browser mode

I created a stop-gap package that solves the problem initially,
https://github.com/websemantics/figlet-browserify but it would be nice to make necessary changes to the library to make it work in the browser regardless of the package manager,

I installed Figlet and inserted the sample code into my code via Copy & Paste.

var figlet = require('figlet');
 
figlet('Hello World!!', function(err, data) {
    if (err) {
        console.log('Something went wrong...');
        console.dir(err);
        return;
    }
    console.log(data)
});

The following message appears in the browser's console:

Something went wrong...

Error: FIGlet header contains invalid values.
    at Function.me.parseFont (http://localhost:1234/main.c138d377.js:1148:13)
    at http://localhost:1234/main.c138d377.js:1265:21

I've just got weird rendering of text "Terminal Chess" in Slant font when wrapping.

  ______                    _             __
 /_  __/__  _________ ___  (_)___  ____ _/ /
  / / / _ \/ ___/ __ `__ \/ / __ \/ __ `/ / 
 / / /  __/ /  / / / / / / / / / / /_/ / /  
/_/__\\\\\\/  /_/ /_/ /_/_/_/ /_/\__,_/_/   
  / ____/ /_  ___  __________               
 / /   / __ \/ _ \/ ___/ ___/               
/ /___/ / / /  __(__  |__  )                
\____/_/ /_/\___/____/____/                 

See the "e" letter. Reproducing demo https://codepen.io/jcubic/pen/JjGxvMY?editors=0010

The ivrit font has a weird behaviour. The text is printed as reversed text.

console.log(figlet.textSync('Logged In', {
  font: 'ivrit'
}));

        ___       _                        _
  _ __ |_ _|   __| | ___  __ _  __ _  ___ | |
 | '_ \ | |   / _` |/ _ \/ _` |/ _` |/ _ \| |
 | | | || |  | (_| |  __/ (_| | (_| | (_) | |___
 |_| |_|___|  \__,_|\___|\__, |\__, |\___/|_____|
                         |___/ |___/

i'm making a sample from figlet.js, after copying the sample code from repo got the following error:

any help will be appreciated :)

Rot13.php
B1FF.php

Im getting an "UNKNOWN" errorno -4094
Code:

    figlet("Test", function(err, data) {
        if (err) {
            console.log(err);
            return;
        }
        message.channel.send('```' + data + '```')
    })```

Error:
`{ [Error: UNKNOWN: unknown error, open '//../fonts/Standard.flf']
  errno: -4094,
  code: 'UNKNOWN',
  syscall: 'open',
  path: '//../fonts/Standard.flf' }
`

My App.tsx's constructor looks like the following in my react app

constructor() {
    super();
    figlet('Sezzle', 'Standard', function(err, data) {
      if (err) {
          console.log('Something went wrong...');
          console.dir(err);
          return;
      }
      console.log(data);
    });
  }

But the output in the console is

Error: FIGlet header contains invalid values.
    at Function.me.parseFont (eval at ./node_modules/figlet/lib/figlet.js (http://localhost:3000/main.js:969:1), <anonymous>:842:19)
    at eval (eval at ./node_modules/figlet/lib/figlet.js (http://localhost:3000/main.js:969:1), <anonymous>:951:31)
    at <anonymous>

I logged in the node module's parseFont function and I see that the headerData looks like this:
["<!doctype", "html>"] which is why the opts in the function is not being filled.

Please help.

This is quite possibly a figlet bug, not a problem with the converted font, but wanted to report here to check...

I've been using the 10 converted ANSI fonts with the original figlet. Most of them work fine, but Bloody renders text right-to-left. Sample output from showfigfonts:

Bloody :
                            ▓██   ██▓▓█████▄  ▒█████   ▒█████   ██▓     ▄▄▄▄
                             ▒██  ██▒▒██▀ ██▌▒██▒  ██▒▒██▒  ██▒▓██▒    ▓█████▄
                              ▒██ ██░░██   █▌▒██░  ██▒▒██░  ██▒▒██░    ▒██▒ ▄██
                              ░ ▐██▓░░▓█▄   ▌▒██   ██░▒██   ██░▒██░    ▒██░█▀
                              ░ ██▒▓░░▒████▓ ░ ████▓▒░░ ████▓▒░░██████▒░▓█  ▀█▓
                               ██▒▒▒  ▒▒▓  ▒ ░ ▒░▒░▒░ ░ ▒░▒░▒░ ░ ▒░▓  ░░▒▓███▀▒
                             ▓██ ░▒░  ░ ▒  ▒   ░ ▒ ▒░   ░ ▒ ▒░ ░ ░ ▒  ░▒░▒   ░
                             ▒ ▒ ░░   ░ ░  ░ ░ ░ ░ ▒  ░ ░ ░ ▒    ░ ░    ░    ░
                             ░ ░        ░        ░ ░      ░ ░      ░  ░ ░
                             ░ ░      ░                                      ░

const figlet = require("figlet")

const text = `


hello



world


`;

console.log(figlet.textSync(text));

yields the following output:

  _          _ _             
 | |__   ___| | | ___        
 | '_ \ / _ \ | |/ _ \       
 | | | |  __/ | | (_) |      
 |_| |_|\___|_|_|\___/     _ 
 __      _____  _ __| | __| |
 \ \ /\ / / _ \| '__| |/ _` |
  \ V  V / (_) | |  | | (_| |
   \_/\_/ \___/|_|  |_|\__,_|

So is there a way the blanks lines can be preserved?

Hi there,

Thanks for the library, ASCII art ftw 😄

That being said, my vulnerability check reported a problem with figlet because it found an old version of jQuery that has been flagged for security issues. I was surprised at first because I thought that the library has no dependency on jQuery but after inspecting the node_modules/figlet directory I noticed that the folder examples that contain jQuery is part of the NPM package.

Is there any plan to remove the examples folder from the distributed package?

Hi, thank you very much for this!

I'm testing the Ansi Figlet fonts (for example "Electronic") in the browser, if I print them in the console they appear good but within a <pre> block they are not properly rendered.

Is there any special css rules to apply for these cases?

This is more a css related issue but specifically for this project.
I insert the resulting computed ascii in a pre tag and the problem comes when I have long sentences that I'd like to break on multiple lines.
I've tried with this css as suggested here

pre {
  white-space: -moz-pre-wrap /* Mozilla, supported since 1999 */
  white-space: -pre-wrap /* Opera */
  white-space: -o-pre-wrap /* Opera */
  white-space: pre-wrap /* CSS3 - Text module (Candidate Recommendation) http://www.w3.org/TR/css3-text/#white-space */
  word-wrap: break-word /* IE 5.5+ */
}

but this breaks the formatting. I have to revert to pre { white-space: pre} or things won't work.

I was wondering if anyone has already encountered (and possibly solved) this issue.

Hi there, and thanks for a kick ass module.

I was wondering if there were any reason as to why you did not include all the same fonts from the website in this module. For example the "Ansi Figlet Fonts" that you have on http://patorjk.com/software/taag

If there is some kind of licence or something, or if there is another reason?

Getting following error when I change the font to ogre.

var figlet = require('figlet');

figlet.text('hello world', {
    font: 'ogre',
    horizontalLayout: 'default',
    verticalLayout: 'default'
}, function(err, data) {
    if (err) {
        console.log('Something went wrong...');
        console.dir(err);
        return;
    }
    console.log(data);
});

Error -

{ Error: ENOENT: no such file or directory, open '/home/thilina/node_modules/figlet/lib/../fonts/ogre.flf'
    at Error (native)
  errno: -2,
  code: 'ENOENT',
  syscall: 'open',
  path: '/home/thilina/node_modules/figlet/lib/../fonts/ogre.flf' }

I'm using Fedora 26 with; node v6.11.2.

Hi. Is it possible to enable support for Cyrillic in BLOODY font, me in my project really need it. I would be very grateful for the help, thank you in advance.

There are minor issues (grammatical) in the README.md file.
Example: 1, 2. There are more I guess 🤔

It is understandable that such issues are intuitive for native English speakers. But non-native speakers might have a wrong assumption while reading them and have trouble understaing.

When using the figlet on Gitlab runners the text get's a little messed up since always at the beginning of the line there is worker identifier ([0-0]) in that particular case. It would be nice if you can place empty line at the beginning/top of the figlet so this wouldn't happen.

This is how it looks like:

I use filget.js with ROT.js library (for rouge like games) and it modify Array prototype and it break figlet. This can be easy fixed. The problem is this line:

for(var i in fonts){
   me.parseFont(fonts[i], fontData[i]);
}

the loop should use hasOwnProperty to filter out stuff from prototype.

It seems that figlet is always adding padding to the beginning of a rendered word. Using Larry 3D, this is the output for "node-framework":

                          __                      ___                                                              __
                         /\ \                   /'___\                                                            /\ \
          ___     ___    \_\ \     __          /\ \__/  _ __    __      ___ ___      __   __  __  __    ___   _ __\ \ \/'\
        /' _ `\  / __`\  /'_` \  /'__`\ _______\ \ ,__\/\`'__\/'__`\  /' __` __`\  /'__`\/\ \/\ \/\ \  / __`\/\`'__\ \ , <
        /\ \/\ \/\ \L\ \/\ \L\ \/\  __//\______\\ \ \_/\ \ \//\ \L\.\_/\ \/\ \/\ \/\  __/\ \ \_/ \_/ \/\ \L\ \ \ \/ \ \ \\`\
        \ \_\ \_\ \____/\ \___,_\ \____\/______/ \ \_\  \ \_\\ \__/.\_\ \_\ \_\ \_\ \____\\ \___x___/'\ \____/\ \_\  \ \_\\_\
         \/_/\/_/\/___/  \/__,_ /\/____/          \/_/   \/_/ \/__/\/_/\/_/\/_/\/_/\/____/ \/__//__/   \/___/  \/_/   \/_/\/_/

Why is there a poopton of padding at the start of each line, and how can we turn that off?

I'm using figlet to draw a success banner in a prepublish hook,
I've been using it happily for quite a while, where the success banner choses a font in random - but I have encountered today the following error:

ERROR <proj>-compiler - processing ended { [Error: ENOENT, open '/opt/jenkins/jobs/<project>/workspace/node_modules/<utility-package>node_modules/figlet/lib/../fonts/Calvin.flf']
  errno: 34,
  code: 'ENOENT',
  path: '/opt/jenkins/jobs/<project>/workspace/node_modules/<utility-pkg>/node_modules/figlet/lib/../fonts/Calvin.flf' }
Error: ENOENT, open '/opt/jenkins/jobs/<project>/workspace/node_modules/<utility-pkg>/node_modules/figlet/lib/../fonts/Calvin.flf'
FATAL osg-rules-compiler:CLI - compilation complete with errors
npm ERR! weird error 1
npm ERR! not ok code 0

I could note that the font file for Calvin is missing on the disk...
I can see there Calvin S though...

maybe something is lost with names?

I would like to propose a couple additions to the taag site:

Allow the Test All button to only print fonts from specific font categories.

Allow the Test All button to only print fonts that are of a specified number of lines; equal to, greater than, less than. Each font declares how many lines (tall) it is, plus one, in its headers.

hi,
have you ever thought of making an synchronous way of calling the text function?

could be something like:

console.log(figlet.textSync('Boo!', { font:'Ghost'}));

which acts identically to the async version but returns the created text.

Horizontal is spelled horiontal on this line.

I got an error from typescript when using parseFont with the font from importable-fonts, following the instruction from #32:

import figlet from "figlet";
import banner3 from "figlet/importable-fonts/Banner3";

figlet.parseFont("Banner3", banner3);

On the 4th line: Property 'parseFont' does not exist on type 'typeof figlet'.

More information:

os: Windows 10
node: 10.12.0
figlet: ^1.2.4
typescript: 3.5.2

I don't see any export keyword in the figlet.js. I wonder if you can make a change so we can use it in native ES code? Thanks.

I'm curious if there are specific rhymes or reason for blank lines in some font character sets, or why some have whitepace padding on the right side or left and right side of some or all characters. Looking for the extended history explanations of how the renderers used to and currently work differently or the same, and what is ideal. I really would like to take out the blank line paddings, where every character has an extra blank line, ie, a 2 line font uses 3.

Hi,

Thanks for making this project!

Feel free to close as a non-issue, but: have you ever come across any online or command-line tools to convert ttf/otf fonts to flf files, maybe using some parameters for chars used / dithering / rendering / spacing?

(I don't know if this is only a problem in the web service, since I have only tested it there)

Using the Stick Letters font, the output is partially corrupted when typing z or Z.

Steps to reproduce:
http://patorjk.com/software/taag/#p=display&v=0&c=bash&f=Stick%20Letters&t=Customization

Expected output:

#   __        __  ___  __          __      ___    __       
#  /  ` |  | /__`  |  /  \  |\/| |  /  /\   |  | /  \ |\ | 
#  \__, \__/ .__/  |  \__/  |  | | /_ /~~\  |  | \__/ | \| 
#                                                          

Actual output:

#   __        __  ___  __          __      ___    __       
#  /  ` |  | /__`  |  /  \  |\/| |  / @ /\   |  | /  \ |\ | 
#  \__, \__/ .__/  |  \__/  |  | | /_ @/~~\  |  | \__/ | \| 
#                                     @@