giant-comment-headers

Create giant comment headers with figlets to better read your headers on the minimap


Install
apm install giant-comment-headers@1.8.1

Documentation

Giant Comment Headers

Atom package to convert the selected text to ASCII art using FIGlet and then comment it.

The chosen figlet font (banner3) is perfect for minimap visualization. Commenting supports several file extensions:

  • js
  • sh
  • yml, yaml
  • coffee
  • html
  • md
  • php
  • vb

Select some text to convert something like this:

hello

into something like this:

<!--
##     ## ######## ##       ##        #######
##     ## ##       ##       ##       ##     ##
##     ## ##       ##       ##       ##     ##
######### ######   ##       ##       ##     ##
##     ## ##       ##       ##       ##     ##
##     ## ##       ##       ##       ##     ##
##     ## ######## ######## ########  #######
-->

you can also Toggle Borders to put a border around the text to add more distinction in the minimap:

<!--#########################################################################
##     ## ######## ##       ##        #######
##     ## ##       ##       ##       ##     ##
##     ## ##       ##       ##       ##     ##
######### ######   ##       ##       ##     ##
##     ## ##       ##       ##       ##     ##
##     ## ##       ##       ##       ##     ##
##     ## ######## ######## ########  #######
##########################################################################-->

Note that Toggle Borders determines border size based on your editors preferred line length, Atom's default is 80 as shown above.

The difference is slight and completely based on user preference:

Border vs. No Border Example

Usage

To convert text, select the text you wish to convert, and do any of the following:

  • Press ctrl-shift-del or
  • Select Giant Comment Headers: Convert in the command palette or
  • Select Packages -> Giant Comment Headers -> Convert from the main menu or
  • Right click on the selected text, and select Giant Comment Headers: Convert from the context menu

To create comment borders around text to help distinguish sections in the minimap do the following:

  • Select Packages -> Giant Comment Headers -> Toggle Borders from the main menu
  • Run the Convert command on your text as detailed above

To set a custom font, set giant-comment-headers.font in your atom config file, as such:

"giant-comment-headers":
  font: "Colossal"

See existing fonts in the figlet font database.

Credits

Based on the following packages: