vim-jp / vim-jp/vimdoc-ja-working

vimdoc整形用の推奨Vim設定を決める

Open
#54 9 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Vim Script
Stars
84
Forks
61
Avg merge
2d 19h
Merged PRs (30d)
35

Description

https://github.com/vim-jp/vimdoc-ja-working/pull/52#issuecomment-262116823 より派生

  • プラグイン
    autofmt
  • autofmt用設定
set formatexpr=autofmt#japanese#formatexpr()    " kaoriya版では設定済み
let autofmt_allow_over_tw = 1    " 全角文字がぶら下がりで1カラムはみ出すのを許可
  • Vimオプション設定

'formatoptions'のデフォルト値 "tcq" (Kaoriya版は "tcqmM")
推奨値は "tcpm" ?

set formatoptions+=m             " (mを加えて)文字コードが 255 より後のマルチバイト文字の間でも改行する
set formatoptions-=M             " (Mを外して)行の連結時にマルチバイト文字の前後に空白を挿入する

set fileencoding=utf-8 fileformat=unixset encoding=utf-8も推奨?

あとset autoindentはしておいた方が良い?

決まったらVim ドキュメント翻訳者の手引きに反映させましょう。
まずは意見出し。

Contributor guide

No contributing guide indexed for this repository

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.

Research direction

Start with the linked pull-request comment and review the proposed autofmt plugin and Vim settings in the issue. Resolve which formatting, encoding, and indentation settings should be recommended, then update the Vim documentation translators' Guide wiki page once the community reaches a decision.

Written by the indexing model from the issue text.

Assessment

Tech stack
vim
Domain
documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.