https://github.com/chawuciren/vim-phpformat
https://github.com/chawuciren/vim-phpformat
Last synced: 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/chawuciren/vim-phpformat
- Owner: chawuciren
- Created: 2017-02-13T08:22:04.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2017-08-31T07:48:33.000Z (almost 8 years ago)
- Last Synced: 2025-03-03T07:32:16.624Z (3 months ago)
- Language: PHP
- Size: 53.7 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
Vim-phpfmt
==========
***[This project follows a Code of Conduct.](https://github.com/phpfmt/code-of-conduct)***
Inspired by vim-php-cs-fixer. This plugin integrates [phpfmt](https://github.com/phpfmt/fmt).
This plugin will execute the `fmt.phar` command on the directory or file (depends on which command you call). See options to know how to customize that.
The plugin comes with `phpfmt fmt.phar` embedded, it should suffice.
If you see any improvement or question, please, contribute or create an issue.
**Keeping up-to-date**:
This plugin updates `fmt.phar` during VIM opening. If this fails, please open an issue stating what happens and possible logs.
**Options available**:
```viml
let g:phpfmt_on_save = get(g:, 'phpfmt_on_save', 1) " format on save (autocmd)
let g:phpfmt_php_path = "php" " Path to PHP
"let g:phpfmt_prepasses_list = "AutoPreincrement,JointToImplode"
"let g:phpfmt_passes_list = "ReturnNull"
let g:phpfmt_enable_default_mapping = 1 " Enable the mapping by default (pcd)
"let g:phpfmt_indent_with_space = 4 " use spaces instead of tabs for indentation
"let g:phpfmt_enable_auto_align = 1 " Enable auto align of = and =>
"let g:phpfmt_visibility_order = 1 " Fixes visibiliy order for method in classes - PSR-2 4.2
"let g:smart_linebreak_after_curly = 1 " Convert multistatement blocks into multiline blocks
```
Default mapping is `pcf` (formats a file) and `pcd` (formats the whole directory of the file).
If you want to change it, update `plugin/phpfmt.vim` file, editing these lines:
```viml
nnoremap pcd :call PhpFmtFixDirectory()
nnoremap pcf :call PhpFmtFixFile()
```
# Installation
Via **[Vundle](https://github.com/gmarik/vundle)**, add:
```viml
Bundle 'dericofilho/vim-phpfmt'
```
Open VIM and execute:
`:PluginInstall`
Via **[Pathogen](https://github.com/tpope/vim-pathogen)**, do:
```bash
cd ~/.vim/bundle
git clone [email protected]:dericofilho/vim-phpfmt.git
```
Via **[vim-plug](https://github.com/junegunn/vim-plug)**, add:
```
Plug 'phpfmt/vim-phpfmt'
```
Open VIM and execute:
`:PlugInstall`