Vim-php-cs-fixer

Integrate php-cs-fixer.

This plugin will execute the php-cs-fixer command on the directory or file (depends on which command you call). See options to know how to customize that.

Options available:

" If php-cs-fixer is in $PATH, you don't need to define line below
" let g:php_cs_fixer_path = "~/php-cs-fixer.phar" " define the path to the php-cs-fixer.phar

" If you use php-cs-fixer version 1.x
let g:php_cs_fixer_level = "symfony"                   " options: --level (default:symfony)
let g:php_cs_fixer_config = "default"                  " options: --config
" If you want to define specific fixers:
"let g:php_cs_fixer_fixers_list = "linefeed,short_tag" " options: --fixers
"let g:php_cs_fixer_config_file = '.php_cs'            " options: --config-file
" End of php-cs-fixer version 1 config params

" If you use php-cs-fixer version 2.x
let g:php_cs_fixer_rules = "@PSR2"          " options: --rules (default:@PSR2)
"let g:php_cs_fixer_cache = ".php_cs.cache" " options: --cache-file
"let g:php_cs_fixer_config_file = '.php_cs' " options: --config
let g:php_cs_fixer_allow_risky = "yes"      " options: --allow-risky
" End of php-cs-fixer version 2 config params

let g:php_cs_fixer_php_path = "php"               " Path to PHP
let g:php_cs_fixer_enable_default_mapping = 1     " Enable the mapping by default (<leader>pcd)
let g:php_cs_fixer_dry_run = 0                    " Call command with dry-run option
let g:php_cs_fixer_verbose = 0                    " Return the output of command if 1, else an inline information.
" let g:php_cs_fixer_ignore_env = 1               " Ignoring any environment requirements

Default mapping is <leader>pcd

If you want to change it:

nnoremap <silent><leader>pcd :call PhpCsFixerFixDirectory()<CR>
nnoremap <silent><leader>pcf :call PhpCsFixerFixFile()<CR>

If you want to add fix on save functionality, add this string to the end of ~/.vimrc:

autocmd BufWritePost *.php silent! call PhpCsFixerFixFile()

Installation

Via Vundle, add:

Bundle 'stephpy/vim-php-cs-fixer'

Via Pathogen, do:

cd ~/.vim/bundle
git clone [email protected]:stephpy/vim-php-cs-fixer.git

To see how to install php-cs-fixer, look at php-cs-fixer repository.

If you see any improvement or question, contribute or create an issue