figlet-comment

Crates.iofiglet-comment
lib.rsfiglet-comment
version0.4.0
sourcesrc
created_at2024-08-14 08:39:47.838419
updated_at2024-09-18 08:32:19.223886
descriptionSimple tool to quickly create banner to use as comments.
homepagehttps://gitlab.com/cyloncore/figlet-comment
repositoryhttps://gitlab.com/cyloncore/figlet-comment.git
max_upload_size
id1337030
size26,951
(cyrilleberger)

documentation

README

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:

#  ____                         _            _   _ 
# / ___|  ___  _ __ ___   ___  | |_ _____  __ |_| |
# \___ \ / _ \| '_ ` _ \ / _ \ | __/ _ \ \/ / __| |
#  ___) | (_) | | | | | |  __/ | ||  __/>  <| |_|_|
# |____/ \___/|_| |_| |_|\___|  \__\___/_/\_\\__(_)
#                                                  
Commit count: 0

cargo fmt