---

Ⅰ. 插件描述

Beautify your javascript,html,css source code inside Vim

Ⅱ. 基本信息

创建日期：  2012-05-11 使用用户：  53 Github星：  81 插件作者：  yf liu

Ⅲ. 安装方法

使用Vundle管理器安装

在你的.vimrc下添加:

Plugin 'michalliu/sourcebeautify-vim'

… 然后在Vim中运行以下命令:

:source %
:PluginInstall

对于Vundle版本 < 0.10.2，请用上面的Bundle替换Plugin。

使用NeoBundle管理器安装

在你的.vimrc下添加:

NeoBundle 'michalliu/sourcebeautify-vim'

… 然后在Vim中运行以下命令:

:source %
:NeoBundleInstall

使用VimPlug管理器安装

在你的.vimrc下添加:

Plug 'michalliu/sourcebeautify-vim'

… 然后在Vim中运行以下命令:

:source %
:PlugInstall

使用Pathogen管理器安装

在终端中运行以下命令:

cd ~/.vim/bundle
git clone https://github.com/michalliu/sourcebeautify.vim

Ⅳ. 文档说明

sourcebeautify.vim

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

Language support:

• [x] Javascript,CSS,HTML by js-beautify
• [x] JSON by jsonlint
• [x] XML,SQL by vkBeautify

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](https://github.com/beautify-web/js-beautify/blob/v0.4.2/beautify.js), [html beautifier options](https://github.com/beautify-web/js-beautify/blob/v0.4.2/beautify-html.js), [css beautifier options](https://github.com/beautify-web/js-beautify/blob/v0.4.2/beautify-css.js), [jsonlint options](https://github.com/zaach/jsonlint)
   

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