border-comment-builder v1.0.0-beta.0

Border comment builder

What is this?

This is a tool that transforms text you put in stdin into a nice border like that:

/*
 * +---------------------+
 * | Nice block comment! |
 * +---------------------+
 */

You can insert that thing anywhere in your source code. It would be good to use it in a begin part of your source code.

Written in Node.js.

Launching app

Install app globally:

npm i -g border-comment-builder --unsafe-perm=true

And after that border-comment-builder terminal command will be available.

You can also start app with parameters:

border-comment-builder --type python --input comment.txt --output out.txt

echo and pipe calls help you get result on single line situation:

echo "Only single line comment" | border-comment-builder --type twig

JS API usage

You can tweak borders whatever you want.

A BorderCommentBuilder constructor gets an object of params and returns compiled string.

An example:

const resultString = new BorderCommentBuilder({
  text: "123\n456",
  sideSymbolLeft: "< ",
  sideSymbolRight: " >",
  cornerSymbol: "U",
}).build();

Compiled string will be:

/*
 * U-----U
 * < 123 >
 * < 456 >
 * U-----U
 */

Types of comments (predefined)

js and also by default

/*
 * +-------+
 * | a b c |
 * +-------+
 */

c

  //
  // +-------+
  // | a b c |
  // +-------+
  //

pascal

  (*
   * +-------+
   * | a b c |
   * +-------+
   *)

python

  #
  # +-------+
  # | a b c |
  # +-------+
  #

html

<!--
    -- +-------+
    -- | a b c |
    -- +-------+
    -->

twig

  {#
   # +-------+
   # | a b c |
   # +-------+
   #}

All these borders defined in pre-defined-borders.json file.

CLI util arguments

The text of comment sets line-by-line from cli, but also can be read from file.

When you finish writing the text press any of EOF combination (Ctrl+D in Unix-like systems and Ctrl+Z in Win).

Additional commands

• npm run build generates build directory.

• npm run clean removes build directory.

• npm run test launches Mocha test utility to check some costructor calls going right.