https://github.com/cometsong/commentframe.vim

Add Comments in Frames to the file you're editing, or Comments aligned on the Right side of a line. Customizable!
https://github.com/cometsong/commentframe.vim

comment vim vim-plugin

Last synced: about 3 hours ago
JSON representation

Add Comments in Frames to the file you're editing, or Comments aligned on the Right side of a line. Customizable!

• Host: GitHub
• URL: https://github.com/cometsong/commentframe.vim
• Owner: cometsong
• Created: 2012-04-18T08:43:30.000Z (over 12 years ago)
• Default Branch: master
• Last Pushed: 2020-02-19T18:35:32.000Z (over 4 years ago)
• Last Synced: 2023-03-12T06:03:45.048Z (over 1 year ago)
• Topics: comment, vim, vim-plugin
• Language: Vim script
• Homepage:
• Size: 13.7 KB
• Stars: 42
• Watchers: 3
• Forks: 5
• Open Issues: 0
• Metadata Files:
  • Readme: README

Awesome Lists containing this project

README

        
"~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~"

"                                 CommentFrame!                                "

"                                                                              "

"                      Copyright (c) 2012 Benjamin Leopold                     "

"                              All rights reserved.                            "

"                                                                              "

"                      Public Domain, same license as Vim.                     "

"        see: http://vimdoc.sourceforge.net/htmldoc/uganda.html#license        "

"~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~"

"~~~~~~~~~~~~~~~~~~~~~~~~~~~~ by cometsong  ~~~~~

"~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~"

"                                                                              "

" This is a simple plugin to generate fancy-looking comments/section dividers  "

" with centered titles and append them at the current cursor position.         "

"                                                                              "

" Also CommentRight => line of comment (customizable for diff langs) with      "

"      string arg put on right end of line.                                    "

"                                                                              "

" To customize further, unmapping of default keysets can be done, plus         "

" creating any new combinations of frame types by using the custom             "

" CommentFrameCustom and CommentRightCustom functions in your vimrc.           "

" See below for details.                                                       "

"                                                                              "

" For latest developments, any mods, pull requests, etc, see:                  "

"   https://github.com/cometsong/CommentFrame.vim                              "

"                                                                              "

"~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~"

"             inspired by: makesd/makecsd by Chase Venters script:             "

"             http://www.vim.org/scripts/script.php?script_id=3253             "

"~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~"

Plugin Configuration:

  `g:CommentFrame_SkipDefaultMappings`   let =1 to not use default keymaps

  `g:CommentFrame_TextWidth`             set global default width of comment

                                         frames and lines; always modifiable

					 using the `...Custom` functions

Basic Usage:

The default keymappings are setup for a custom function to create a CommentFrame

and also a CommentRight line.  All keymapping start with , all default

frames and right lines are 80 characters.

    Key     Command Name                Result

    ---     --------------------------  ----------------------------------------

    fcs     CommentFrameSlashes         border: //****************************//

    fcS     CommentFrameSlashStar       border: /******************************/

    fch     CommentFrameHashDash        border: #------------------------------#

    fcH     CommentFrameHashEqual       border: #==============================#

    fcq     CommentFrameQuoteDash       border: "------------------------------"

    fcQ     CommentFrameQuoteTilde      border: "~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~"

    frh     CommentRightHash            line: #~~~~~~~~~~~~~~~~~~~~~ title ~~~~~

    frs     CommentRightSlashes         line: //~~~~~~~~~~~~~~~~~~~~ title ~~~~~

    frS     CommentRightSlashStar       line: /*~~~~~~~~~~~~~~~~~~ title ~~~~~*/

    frq     CommentRightQuote           line: "~~~~~~~~~~~~~~~~~~~~~ title ~~~~~

These defaults can be unmapped, remapped or preserved, as you see fit or can be

not mapped at all using the config variable mentioned above.

New styles and keymappings can be added using the following lines in your vimrc: 

    command! -nargs=+ CommentFrameSlashMeDown :call CommentFrame#Custom('//', '//', 80, '*', '_', 0, )

    call CommentFrame#MapKeys('ni', 'cfs', ':CommentFrameSlashMeDown ""')

This will create a new command and a new key mapped in modes normal (n) and

insert (i) modes, as designeted in the first MapKeys arg, then 'cfC' as the keys

to map, and the command to be run with that keypress, or by using the command

from the ':' command line.

Below is the MapKeys call for direct access to the CommentFrameCustom 

command, if only a keymapping is desired, not another usable command.

    call CommentFrame#MapKeys("n", "mykeys", ":CommentFrameCustom '!','...',80,':','>',3,''")

Have fun stormin the castle!