Skip to content

feat: JTF日本語標準スタイルガイド 第3.0版に更新#157

Open
3w36zj6 wants to merge 12 commits intotextlint-ja:masterfrom
3w36zj6:feature/update-to-v3
Open

feat: JTF日本語標準スタイルガイド 第3.0版に更新#157
3w36zj6 wants to merge 12 commits intotextlint-ja:masterfrom
3w36zj6:feature/update-to-v3

Conversation

@3w36zj6
Copy link
Copy Markdown
Contributor

@3w36zj6 3w36zj6 commented Jan 2, 2026

close #70

@3w36zj6
Copy link
Copy Markdown
Contributor Author

3w36zj6 commented Jan 2, 2026

第2.2版でのルール名はx.y.z.rule-nameという形式で表現されていましたが、第3.0版での表記に合わせてx.y.z rule-nameのように統一すべきでしょうか?

@3w36zj6 3w36zj6 marked this pull request as ready for review January 2, 2026 14:08
@azu
Copy link
Copy Markdown
Member

azu commented Jan 5, 2026

第2.2版でのルール名はx.y.z.rule-nameという形式で表現されていましたが、第3.0版での表記に合わせてx.y.z rule-nameのように統一すべきでしょうか?

あまり強い理由はないですが、 . に変えるメリットは特にないので、.のままで良いのかなとは思います。

ルール名の変更をすると、ユーザーのオプション名の変更もしないと意図した動き方にならないというのだけちょっと気になっています。
textlintが無効なオプションをおそらく無視しちゃうと思うので、オプションをマイグレーションできるといいのですが、そもそもルールに互換性がない場合は、無理にマイグレーションも必要ない感じがしますね。
v2 ... v3 は互換性ない変更が結構ある感じですかね?

💭 オプションの値は"3.3.かっこ類と隣接する文字の間のスペースの有無"だけですが、どちらかというユーザーがルールを無効にするために falseを指定してるケースが多いはずなので、番号を変えると無効だったルールが復活してしまうので、それをうまく維持する設定を伝えたいという意図です。

1.2.3 的な番号だと毎回ずれてしまうので、ルールにidをつけられると一番良い気がするんですが、数が多すぎて考えるのが難しくて一回諦めたんですよね。(ルール名が変わってしまったらだめなのかもというので番号を入れたのかもしれない…)
idを考えるのを諦めるケースだと、v2の1.2.3はv3の2.1.3 みたいな対応表を管理できればマイグレーションはできるかなと思います。
https://angular.dev/update-guide?v=20.0-21.0&l=1
みたいなイメージで、textlintrcの設定を貼り付けて、fromとtoのバージョンを指定したら設定を書き換えるようなページが一つあれば良かったりするのかなとは思います。

TODO

  • オプションの指定からは番号を消す or オプションの指定の番号は維持する
    • どっちの場合もマイグレーション方法は必要
  • リリースノートとかにもv2...v3の差分をまとめる必要がある

@3w36zj6
Copy link
Copy Markdown
Contributor Author

3w36zj6 commented Feb 26, 2026

旧版の「3.2. カタカナ語間のスペースの有無」のルールを消していましたが、「2.1.7 カタカナ複合語」として再度追加しました。

v2 ... v3 は互換性ない変更が結構ある感じですかね?

ルールの中身の変更は「2.2.1 ひらがなと漢字の使い分け」のみで、辞書に軽微な変更があります。

また、ルールの番号の変更が非常に多いです。旧版の「3 文字間のスペース」が「2.3 文字間のスペース」に変更され、これ以降のルールの番号がすべて変更されているため、マイグレーションガイド(スクリプト)は私も必須だと思います。

マイグレーションが必須のアップデートなため、ルールの表記ゆれをガイドに揃える、あるいはidを独自に命名するのならここが良いタイミングだと思います。個人的に記号が含まれるルール名(3.3.5.二重引用符" "など)はtextlintの設定で扱いづらく感じるので、ルール名はガイドの表記を尊重しつつ使いやすいようにアレンジしたほうが良さそうに思います。

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

JTFスタイルガイド 3.0

2 participants