vim/vim-autoformat
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Update README.markdown

Browse Source
This commit is contained in:
Chiel 2012-12-02 21:19:14 +01:00
parent 60242efee6
commit 8879715161
1 changed files with 11 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
README.markdown
View File

@ -17,14 +17,15 @@ Bundle "Chiel92/vim-autoformat"
How to use How to use
---------- ----------
To be able to use automatic code formatting, you have to install an external program that can format code of the programming language you are using. To be able to use automatic code formatting, you have to install an external program that can format code of the programming language you are using.
Normally, it suffices to make the formatprogram either globally available or to put it in the ```formatters``` folder. Normally, it suffices to make the formatprogram either globally available or to put it in the `formatters/` folder.
In some cases this is inconvenient to accomplish and therefore sometimes alternative installation methods are supported. In some cases this is inconvenient to accomplish and therefore sometimes alternative installation methods are supported.
It is said explicitly if this is the case. It is said explicitly if this is the case.
When you have succeed installing the formatters you need, you can format visually selected code with ```gq```. When you have succeed installing the formatters you need, you can format visually selected code with `gq`.
For more info type ```:help gq```. For more info type `:help gq`.
You can also format the whole buffer with the command ```:Autoformat```. You can also format the whole buffer with the command `:Autoformat`.
For convenience it is recommended that you assign a key for this, like so: For convenience it is recommended that you assign a key for this, like so:
```vim ```vim
noremap <F7> :Autoformat<CR> noremap <F7> :Autoformat<CR>
``` ```
@ -33,10 +34,10 @@ noremap <F7> :Autoformat<CR>
Supported formatprograms Supported formatprograms
------------------------ ------------------------
Here is a list of formatprograms that are currently supported. Here is a list of formatprograms that are currently supported.
* ```astyle``` for __C#, C++, C and Java__. * `astyle` for __C#, C++, C and Java__.
It's probably in your distro's repository, so you can download it as a regular package. It's probably in your distro's repository, so you can download it as a regular package.
* ```jsbeautify``` (the python version) for __Javascript__. * `jsbeautify` (the python version) for __Javascript__.
This one can also installed as a vundle package (if you use the vundle plugin). This one can also installed as a vundle package (if you use the vundle plugin).
To do so, put this in your .vimrc: To do so, put this in your .vimrc:
@ -44,15 +45,15 @@ To do so, put this in your .vimrc:
Bundle "einars/jsbeautify" Bundle "einars/jsbeautify"
``` ```
* ```autopep8``` for __Python__. * `autopep8` for __Python__.
It's probably in your distro's repository, so you can download it as a regular package. It's probably in your distro's repository, so you can download it as a regular package.
If you find yourself in need of support for another formatprogram, simply add a configuration file in the folder ```ftplugin```. If you find yourself in need of support for another formatprogram, simply add a configuration file in the folder `vim-autoformat/ftplugin/`.
You can take the existing ones as an example. You can take the existing ones as an example.
Oh, and be sure to send me a patch. :) Oh, and be sure to send me a patch. :)
How can I change the behaviour of formatters? How can I change the behaviour of formatters?
--------------------------------------------- ---------------------------------------------
Every formatter is called from a script in the *vim-autoformat/ftplugin/* directory. Every formatter is called from a script in the `vim-autoformat/ftplugin/` directory.
E.g. the file that calls the C# formatter is named *vim-autoformat/ftplugin/cs.vim*. E.g. the file that calls the C# formatter is named `vim-autoformat/ftplugin/cs.vim`.
You can change the arguments passed to the formatter there. You can change the arguments passed to the formatter there.