search

lxc-jp / incus-ja

Powerful system container and virtual machine manager
https://incus-ja.readthedocs.io/ja/latest/
Apache License 2.0
1 stars 0 forks source link

textlintのルールについて相談 #1

Open hnakamur opened 11 months ago

hnakamur commented 11 months ago

現状の仮設定は https://github.com/lxc-jp/incus-ja/blob/3cc86e39501bda6bdb511e31f1811e30058f735e/.textlintrc.json のようにしています。

ただ、とりあえず適当に入れたので、すでにコンフリクトが出ています。

lostandfound/textlint-rule-ja-hiragana-fukushi: Check easy-to-read Fukushi(adverbs) written in Hiragana than Kanji.で副詞をひらがなに開く一方、https://github.com/lxc-jp/textlint-prh-rules/blob/711e00793d9d69eeda04d68a796b6d9afb6d5748/media/WEB%2BDB_PRESS.yml#L774-L775では「もっとも」を「最も」と感じにしています（ただし、その下を見ると「尤も」は「もっとも」とひらがなに開くルールです）。

これに関してはtextlint-rule-ja-hiragana-fukushiを外そうと思います。

が、そもそも大枠をどうするかについてもご意見をいただきたいです。

とりあえずたたき台として私の案を以下に書きます。

別にこれにこだわりがあるわけはないです。統一されていることが重要だと思いますので、違うルールでも全然構わないです。 最初に決めてしまったほうが、統一を維持しやすいので決めてしまいたいところです。必要なら後からでも変更はできるでしょうけど、変更とレビューの手間はそれなりにかかると思います。

ベースはWEB+DB PRESS以外には以下の2つを見つけました。

ICS MEDIAさんはカタカナの最後の長音記号は省略しないルールなので、採用する場合はそれを変える必要があるかもしれません。

あとはベースなしで一から作るという手もあるかもしれませんが、それはそれで大変そうな気がします。

tenforward commented 11 months ago

私は自分の書く文章では書くスタイルはどうするか決めていますが、一般的にどちらであるべきという強い思いはないので、WEB+DB PRESSルールに従うで良いと思います。 @hnakamur さんがおかきになったルール案で問題ないと思います。

hnakamur commented 11 months ago

@tenforwardさん、コメントありがとうございます。

WEB+DB PRESSルールは止めようと思います

実は早速問題が出まして https://github.com/lxc-jp/incus-ja/blob/staging/doc/contributing.md?plain=1#L64C128-L64C132 の「基づいて」がひっかかって「もとづいて」にせよとのことなのですが、なんと「もとづいて」にすると「基づいて」にせよと無限ループになってしまいました。

他のルールと衝突しているのかと思い、WEB+DB PRESS以外は全て消してみたのですが相変わらずでした。 さらにyamlファイルを見てみたのですが、どう修正すればよいかわからない状態です。

https://github.com/lxc-jp/textlint-prh-rules/blob/711e00793d9d69eeda04d68a796b6d9afb6d5748/media/WEB%2BDB_PRESS.yml#L11-L16 を見ると非公開なものを許可頂いて持ってきたもののようですし、最終コミット日も4年前と古いです。今後更新されないことを考えるとこれをベースにするのはよくなさそうな気がしてきました。

ten_forwardさんのスタイルを教わりたいです

実は先程 https://github.com/lxc-jp/incus-ja/blob/staging/doc/tutorial/first_steps.md を訳していたのですが、@tenforwardさんが翻訳されたオンラインデモとほとんど同じだと途中で気づいて、そちらからほぼコピーさせていただきました。そのとき、私の訳より@tenforwardさんの訳のほうが読みやすいと思いました。

私は自分用のメモはよく書いているのですが、他の方向けの説明をわかりやすく書くのは苦手ですし、プロの方の校正を受けたこともないです。その点@tenforwardさんはいろいろ経験されていると思います。

とういことで、@tenforwardさんの決めているスタイルを教えていただけないでしょうか。

https://github.com/lxc/linuxcontainers.org/pull/663/files を見ると上に書いたルールと違うところは以下のあたりでしょうか。

hnakamur commented 11 months ago

第53回　Linuxカーネルのコンテナ機能 - cgroup v2から使うCPUの帯域幅制限（1） | gihyo.jpを拝見すると、こちらでは英数と日本語の間に半角スペース無しなんですね。

個人的には1単語のときは英語と日本語の間に半角スペース入れないほうが見やすいけど、2単語になると入れないと 「あなたのPull Requestが」みたいなときに「あなたのPull」と「Requestが」という塊に見えて気持ち悪いかなという印象です。

hnakamur commented 11 months ago

@tenforwardさんの以下の本を参考にするのが良いということに気づきました。

こちらを参考にルールを作成中です。

hnakamur commented 11 months ago

独自ルールのベースを作りました。 https://github.com/lxc-jp/incus-ja/commit/18623fc20eb4bc1a5df08cdc7e3d812ada9bac95 今後、適宜追加・変更していこうと思います。

hnakamur commented 11 months ago

英語と日本語の間にスペースを入れる入れないはtextlintでスペースを入れる入れないを統一するルール | Web Scratchでいろいろ設定できるようです。