Shell Banner Comments

Vladimir Mikulic

|
148 installs
| (1) | Free
An extension that provides a nice commenting style for the configuration files & shell scripts.
Installation
Launch VS Code Quick Open (Ctrl+P), paste the following command, and press enter.
Copied to clipboard
More Info

Shell Banner Comments

Quick Note

This repo is a fork of the original "Hermes Comments" extension. I've just replaced the default segments(*, /, =) with a hash sign(#), because I mainly use it for my config files(.zshrc, .zprofile...)

As I said, this is a slightly modified version to suit my personal needs. If you have any bugs, don't bother yourself reporting them. I likely won't fix them.

Features

Using shortcuts you can now turn a selected text into one of three possible formats, centered, left justified or subsection.

The shortcuts are:

  • alt+shit+p Creates a centered title
  • alt+shift+l Creates a left justified title
  • alt+shift+o Creates a subtitle
  • alt+shift+; Creates a separator line

Customizing the comments

You can decide which characters will be used to create the comments using the settings, just copy paste the following lines into your settings.json file:

"hermes-comments.maximum": 50,
"hermes-comments.fill": "-",
"hermes-comments.frame": "^",
"hermes-comments.title": "`",
"hermes-comments.separator": "$",

maximum is the maximum level of alignment , i.e the horizontal width of a title.

fill is the character used to fill the empty space in a frame.

When a comment contains the special characters @ or \ the frame is different.

title defines the character used for Doxygen documented frames.

separator defines the character used for the separator bar.

Known Issues

It won't handle comments whose length is bigger than the maximum length of characters (90 by default).

None more known, please report bugs, issues and feature requests to the github repository.

Release Notes

1.0.3

  • Modified the way the special comments are generated to prevent them from messing the Doxygen documentation.

1.0.2

  • Corrected a bug where spacing lines would get deleted

1.0.1

  • Added support for pre-existing comments.
  • Added the option to customize the characters used to make a frame.
  • Added a special frame that is created for comments containing the word author

1.0.0

Initial release of hermes comments

Enjoy!