textlint-ja / textlint-rule-preset-ja-spacing

スペース周りのスタイルを扱うtextlintルールプリセット
https://textlint-ja.github.io/textlint-rule-preset-ja-spacing/
MIT License
73 stars 14 forks source link

プリセットに含まれるすべてのルールを有効にする方法の説明を改善して欲しい #24

Closed kyanny closed 3 years ago

kyanny commented 3 years ago

README.mdデフォルト設定の項目にはには以下のように記載されています。

次のように設定することで、プリセットに含まれるすべてのルールを有効にできます。

{
    "rules": {
        "preset-ja-spacing": {
            "ja-space-around-code": {
                "before": false,
                "after": false
            }
        }
    }
}

しかし、上記の設定では ja-space-between-half-and-full-width は有効になりません(検証用プロジェクト)。 (なお、ここでは「有効になる」を「スペースを常に入れる("space":"always")」の状態という意味であると解釈しています)

ja-space-between-half-and-full-width は .textlintrc 内で明示的に有効する必要があるのだと思いますが、これは README.md の記載内容と一致していないので、ドキュメントを修正して欲しいです。

azu commented 3 years ago

(なお、ここでは「有効になる」を「スペースを常に入れる("space":"always")」の状態という意味であると解釈しています)

いえ、ja-space-around-codeのデフォルト値がfalseなので、設定することでja-space-around-codeを有効化できるという意味合いですね。(ja-space-around-codeはpresetに含まれていますが、デフォルトが無効であるという話ですね)。

azu commented 3 years ago

https://github.com/textlint-ja/textlint-rule-preset-ja-spacing/commit/ff66db25da212b8c087c7bfaf3646f4990338658 でREADMEを更新しました。

kyanny commented 3 years ago

なるほど、掛っている対象を読み間違えていたようです。更新後の README は理解しやすくなりました。ありがとうございました!