Skip to content

gkhn/SectionCommentVSCode

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

2 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Section Comment

Generate ASCII art section comments in VS Code / Cursor.

Features

  • Insert decorative ASCII art comments to mark sections in your code
  • Auto-detects language and uses appropriate comment style (block or line)
  • Customizable fill character, spacing, and comment preference
  • Auto-loads letter patterns from alphabet/ folder

Usage

  1. Press Cmd+Shift+C (Mac) or Ctrl+Shift+C (Windows/Linux)
  2. Enter your section name
  3. ASCII art comment is inserted at cursor position

Or use Command Palette: Insert Section Comment

Example Output

/*
##    ## ######## ##       ##        ######  
##    ## ##       ##       ##       ##    ## 
########  ######  ##       ##       ##    ## 
##    ## ##       ##       ##       ##    ## 
##    ## ######## ######## ########  ######  
*/

Settings

Setting Default Description
sectionComment.fillChar # Character used to fill ASCII art
sectionComment.letterSpacing 1 Space between letters
sectionComment.spaceSize 4 Width of space character
sectionComment.preferLineComments false Prefer line comments over block

Adding New Characters

Add a .txt file to the alphabet/ folder:

  1. For letters/numbers: Use the character as filename (e.g., a.txt, 5.txt)
  2. For special characters: Use _name.txt format

Each file should contain exactly 7 lines of ASCII art using # as the fill character.

Special Character Filenames

Filename Character
_dash.txt -
_plus.txt +
_equals.txt =
_exclaim.txt !
_question.txt ?
_at.txt @
_hash.txt #
_dollar.txt $
_percent.txt %
_amp.txt &
_star.txt *
_lparen.txt (
_rparen.txt )
_lbracket.txt [
_rbracket.txt ]
_lbrace.txt {
_rbrace.txt }
_pipe.txt |
_colon.txt :
_semicolon.txt ;
_comma.txt ,
_dot.txt .
_quote.txt '
_dquote.txt "
_backtick.txt `
_tilde.txt ~
_caret.txt ^
_underscore.txt _

Development

# Install dependencies
npm install

# Compile TypeScript
npm run compile

# Watch mode
npm run watch

Installation

From VSIX

# Package the extension
npx vsce package

# Install
code --install-extension section-comment-1.0.0.vsix

For Development

  1. Open this folder in VS Code
  2. Press F5 to launch Extension Development Host
  3. Test the extension in the new window

About

Section Comment VSCode plugin

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors