google / google/vim-codefmt

Add more examples of autocmds and NoAutoFormatBuffer to help

未关闭
#52 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看
enhancement
主要语言
Vim Script
星标
1.1k
派生
102
PR 合并指标
30 天内没有已合并 PR

描述

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`.

贡献指南

打开贡献指南

调研方向

首先找到关于 autocmds 和 :NoAutoFormatBuffer 的现有文档,然后将其中当前的指导与 issue 中列出的四种场景进行比较。添加涵盖路径排除、按文件类型设置默认 formatter、特定路径的 formatter 以及手动禁用 buffer 的实用示例;当四种用例都得到清晰记录后即可完成。

由索引模型根据 Issue 内容生成。

评估

技术栈
vim
领域
documentation
Issue 类型
文档
难度
2/5
预计耗时
1-3 小时
活跃度
停滞
描述清晰度
基本清楚
新手友好度
48/100

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。