#printing

app figlet-comment

Simple tool to quickly create banner to use as comments

6 releases (3 breaking)

0.4.0 Sep 18, 2024
0.3.0 Sep 5, 2024
0.2.2 Aug 22, 2024
0.1.0 Aug 14, 2024

#22 in #printing

Download history 115/week @ 2024-08-11 355/week @ 2024-08-18 22/week @ 2024-08-25 143/week @ 2024-09-01 7/week @ 2024-09-08 140/week @ 2024-09-15 15/week @ 2024-09-22 9/week @ 2024-09-29 1/week @ 2024-10-06

165 downloads per month

MIT license

8KB
52 lines

crates.io

figlet-comment

Simple tool to quickly create banner to use as comments.

Installation

cargo install figlet-comment

Usage

After installation the command can be used as follow:

Simple tool to quickly create banner to use as comments.

Usage: figlet-comment [OPTIONS] <TEXT>...

Arguments:
  <TEXT>...

Options:
      --style <STYLE>  [default: //] [possible values: //, %, #]
      --no-stdout      Disable printing to stdout
      --no-clipboard   Disable adding to clipboard
  -h, --help           Print help
  -V, --version        Print version

In case no comment style is specified, it default to --style //. It is possible to use c++, rust, latex, python, ruby for <STYLE>. By default, the resulting text is display on the terminal and copied to the clipboard.

Examples

figlet-comment Some text!
figlet-comment --style rust Some text!
figlet-comment --style c++ Some text!

Which result in:

//  ____                         _            _   _ 
// / ___|  ___  _ __ ___   ___  | |_ _____  _| |_| |
// \___ \ / _ \| '_ ` _ \ / _ \ | __/ _ \ \/ / __| |
//  ___) | (_) | | | | | |  __/ | ||  __/>  <| |_|_|
// |____/ \___/|_| |_| |_|\___|  \__\___/_/\_\\__(_)
//                                                  
figlet-comment --style python Some text!
figlet-comment --style ruby Some text!

Which result in:

#  ____                         _            _   _ 
# / ___|  ___  _ __ ___   ___  | |_ _____  __ |_| |
# \___ \ / _ \| '_ ` _ \ / _ \ | __/ _ \ \/ / __| |
#  ___) | (_) | | | | | |  __/ | ||  __/>  <| |_|_|
# |____/ \___/|_| |_| |_|\___|  \__\___/_/\_\\__(_)
#                                                  
figlet-comment --style latex Some text!

Which result in:

#  ____                         _            _   _ 
# / ___|  ___  _ __ ___   ___  | |_ _____  __ |_| |
# \___ \ / _ \| '_ ` _ \ / _ \ | __/ _ \ \/ / __| |
#  ___) | (_) | | | | | |  __/ | ||  __/>  <| |_|_|
# |____/ \___/|_| |_| |_|\___|  \__\___/_/\_\\__(_)
#                                                  

Dependencies

~1–12MB
~154K SLoC