Feature Suggestion: Output FIGlet as Code Comment.

[suchislife801]

Often I find myself code commenting FIGlet outputs and wanted to post a feature suggestion.

Normally, FIGlet is used like this:

import { text } from "https://x.nest.land/deno-figlet@0.0.5/mod.js";

const figletText = await text("getuser", "banner");

Standard output with 2 empty lines at the start and 2 empty lines at the end.

                                                       
  ####   ######  #####  #    #   ####   ######  #####  
 #    #  #         #    #    #  #       #       #    # 
 #       #####     #    #    #   ####   #####   #    # 
 #  ###  #         #    #    #       #  #       #####  
 #    #  #         #    #    #  #    #  #       #   #  
  ####   ######    #     ####    ####   ######  #    # 
                                                       

I propose an alternate comment function for comments, like this:

async function comment(source: string, font: string): Promise<string> {
  const figletText = await text(source, font);
  const transformText = figletText.split("\n").slice(1, -2).map((
    line: string,
  ) => ` * ${line}`);

  const figletComment = `/**\n${transformText.join("\n")}\n */`;

  return figletComment;
}

const figletComment = await comment("getuser", "banner");

console.log(figletComment);

Transformed output with 0 empty lines at the start and 0 empty lines at the end.

/**
 *   ####   ######  #####  #    #   ####   ######  #####  
 *  #    #  #         #    #    #  #       #       #    # 
 *  #       #####     #    #    #   ####   #####   #    # 
 *  #  ###  #         #    #    #       #  #       #####  
 *  #    #  #         #    #    #  #    #  #       #   #  
 *   ####   ######    #     ####    ####   ######  #    # 
 */

[denyncrawford]

Hi @suchislife801 sorry for the delayed response. I don't know if this should be part of the core library but I guess is a nice idea to add a formatting module for the outputs. Please make a PR if you feel ok with it.