google / google/vim-codefmt

Add more examples of autocmds and NoAutoFormatBuffer to help

Open
#52 0 comments 0 reactions 0 assignees View on GitHub
enhancement
Dominant language
Vim Script
Stars
1.1k
Forks
102
PR merge metrics
No merged PRs in 30d

Description

Would be nice to have some practical examples in the docs of how to:
- Auto-format some filetype excluding certain paths.
- Configure default formatter by filetype w/o enabling auto-format.
- Auto-format w/ different formatters at different paths.
- Auto-format but manually disable in some buffers with `:NoAutoFormatBuffer`.

Contributor guide

Open the contributing guide

Research direction

Start by locating the existing documentation for autocmds and :NoAutoFormatBuffer, then compare its current guidance with the four scenarios listed in the issue. Add practical examples covering path exclusions, per-filetype default formatters, path-specific formatters, and manual buffer disabling; done means all four use cases are documented clearly.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.