Add example to override = mappings in codefmt docs
まだ誰も着手していません。
評価
- 難易度
- 2/5
- 見積もり時間
- 1〜3時間
- 初心者へのやさしさ
- 55/100
- issue の種類
- ドキュメント
- 明瞭さ
- おおむね明確
- 活発さ
- 停滞
- 技術スタック
- vim
調査の方向性
codefmt のヘルプドキュメントと既存のフォーマットガイダンスから始めます。= mappings を上書きするために提供された VimL の例を追加し、ユーザーが期待すべき動作と、選択した filetype に適用する際の注意点を文書化します。例が読みやすく、周囲のヘルプテキストと一貫していることを確認してください。
索引モデルが issue の本文から書いたものです。
説明
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.
- 主要言語
- Vim Script
- スター
- 1.1k
- フォーク
- 103
- PR マージ指標
- 30日以内にマージされた PR はありません
環境構築
- Dockerfile・Docker Compose ファイルなし
- プルリクエストのテンプレートなし
- コントリビューションガイドを読む
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
google/vim-codefmt のほかの issue
-
Write a codefmt FAQオープンenhancement
難易度 1/5 1〜3時間 初心者へのやさしさ 68/100
google/vim-codefmt#53 ·
-
難易度 3/5 1〜2日 初心者へのやさしさ 45/100
google/vim-codefmt#247 ·
-
Add meson formatオープンnew formatter
難易度 3/5 1〜2日 初心者へのやさしさ 45/100
google/vim-codefmt#243 ·
-
難易度 3/5 1〜2日 初心者へのやさしさ 52/100
google/vim-codefmt#240 · コメント 1 件 ·
-
Add `:CodefmtInfo` command to report diagnostics to help users check config / diagnose problemsオープンenhancement
難易度 5/5 1週間以上 初心者へのやさしさ 35/100
google/vim-codefmt#234 · コメント 2 件 ·
google/vim-codefmt の issue をすべて見る
似ている issue
-
Reword steps in "proc_configure-project-server-for-network-synchronization-by-using-web-ui.adoc"オープン
難易度 2/5 1〜3時間 初心者へのやさしさ 65/100
theforeman/foreman-documentation#5571 · コメント 1 件 ·
メンテナーはふだん 1 日以内に返信
-
sync-en
難易度 2/5 1〜3時間 初心者へのやさしさ 75/100
メンテナーはふだん 1 日以内に返信
-
sync-en
難易度 1/5 1〜3時間 初心者へのやさしさ 84/100
メンテナーはふだん 1 日以内に返信
-
[oblt-aw][autodoc] Update docs for security org scaffolding and Docs AI menu permission changes対応中かも @github-actions が今日担当しました。 オープン
難易度 2/5 1〜3時間 初心者へのやさしさ 75/100
メンテナーはふだん 1 日以内に返信
-
Перевод устарел
難易度 2/5 1〜3時間 初心者へのやさしさ 68/100