Skip to content

michalliu/sourcebeautify.vim

master
Switch branches/tags
Code

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
 
 
 
 

sourcebeautify.vim

Beautify your source code in Vim. It supports Windows/Linux/Mac up to vim 8.0

Language support:

More language support is well welcomed, your can develop it by pure javascript, see Customization section for more info.

Installation

First, Install dependencies:

  1. jsruntime.vim
  2. jsoncodecs.vim

Then, Copy plugin/sourcebeautify to vimfiles/plugin

Notice:

Sourcebeautify is a filetype plugin. By default VIM can't detect json filetype automaticly. You can either add following code to your vimrc to solve the problem or install json.vim

au BufRead,BufNewFile *.json setf json

Usage

<Leader>sb

Your <Leader> key is often \

Customization

  1. jsbeautify options

    Take a look at beautify-css.run.js, this file contains following code

     css_beautify(%s);
    

    %s refers to the codes before beautify, the other part is pure javascript, for example

     css_beautify(%s,{indent_char:'\t'});
    

    javascript beautifier options, html beautifier options, css beautifier options, jsonlint options

  2. add more language support

    If you wants this plugin to support cpp file, you should create beautify-cpp.js and beautify-cpp.run.js.

    These two files should be written by pure javascript, then modify sourcebeautify.vim add declaration and alias

     " sourcetype that support by this plugin
     let s:beautifiers.supportedSourceType={
     \'javascript':1,
     \'css':1,
     \'html':1
     \}
    
     " sourcetype name alias
     let s:beautifiers.supportedSourceTypeAlias={
     \'javascript':['js'],
     \'html':['xhtml','htm']
     \}
    

Contributors

  1. Einar Lielmanis - author of js-beautify provides beautifier of javascript,html,css file
  2. Zach Carter - author of jsonlint provides error checker and beautifier of JSON file
  3. Vadim Kiryukhin - author of vkBeautify provides XML and SQL beautifier

About

Beautify your javascript,html,css source code inside Vim

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published