Add example to override = mappings in codefmt docs

Open
#12 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
55/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Stale
Tech stack
vim
Domain
documentation

Research direction

Start with the codefmt help documentation and its existing formatting guidance. Add the supplied VimL example for overriding the = mappings, then document what users should expect and the caveats of applying it to selected filetypes; confirm the example is readable and consistent with the surrounding help text.

Written by the indexing model from the issue text.

Description

enhancement

Some filetypes have terrible default indenting logic (using the = mapping) and also have a formatter fast enough and robust enough to drop in as the formatting implementation for the = mapping. You can do this by adding something like the following to your vimrc:

function s:AddCodefmtEqualMapping() abort
  " Replace all the various ={motion} keys to codefmt
  nnoremap <buffer> = :set opfunc=codefmt#FormatMap<CR>g@
  nnoremap <buffer> == :FormatLines<CR>
  vnoremap <buffer> = :FormatLines<CR>
endfunction
augroup codefmt_equal
  autocmd FileType cpp,proto call s:AddCodefmtEqualMapping()
augroup END

We should add an example like this into the codefmt help and explain what to expect + caveats when you use it.

Dominant language
Vim Script
Stars
1.1k
Forks
102
No merged PRs in 30d

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from google/vim-codefmt

All issues in google/vim-codefmt

Similar issues

More Documentation issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.