(Translated by https://www.hiragana.jp/)
GitHub - textlint-ja/textlint-rule-preset-japanese: textlint rule preset for Japanese.
Skip to content

textlint-ja/textlint-rule-preset-japanese

Repository files navigation

textlint-rule-preset-japanese Actions Status: test

textlint rule preset for Japanese.

日本語にほんごけのtextlint ruleのpresetです。

目的もくてき

  • 一般いっぱんてき文書ぶんしょ利用りようするためのルールしゅう
  • れてもあやま検知けんちすくないルールに限定げんていする
    • あきらかな誤爆ごばくがある場合ばあいは、Issueをててください
  • スタイル(スペースの有無うむなど)に関連かんれんするルールはふくめない

技術ぎじゅつてき文章ぶんしょうくためによりきびしいルールをもとめるほうつぎのプリセットを参照さんしょうしてください。

Installation

npmコマンドを使つかってインストールできます。

npm install textlint-rule-preset-japanese

安定あんていばんは、半年はんとし(1がつと7がつ)にいち更新こうしんされます。

つぎのように@nextをつけることで、次期じきバージョンをインストールしてためせます。 安定あんていばん次期じきバージョンの差分さぶんVersion PackagesのPR確認かくにんできます。

npm install textlint-rule-preset-japanese@next

このpresetは以下いかのルールをふくんでいます。

Usage

Via .textlintrc

{
    "rules": {
        "preset-japanese": true
    }
}

Options

{
    "rules": {
        // それぞれのルールのデフォルト
        "preset-japanese": {
             // https://github.com/textlint-ja/textlint-rule-max-ten
             // 一文いちぶん使つかえる"、"のかず
             "max-ten": {
                 "max": 3
             },
             // https://github.com/takahashim/textlint-rule-no-doubled-conjunctive-particle-ga
             // 逆接ぎゃくせつ接続せつぞく助詞じょし「が」が、どう一文いちぶんちゅうふくすうかい出現しゅつげんしていないかどうか
             // e.g.) 今日きょう早朝そうちょうから出発しゅっぱつしたが、定刻ていこくにはわなかったが、無事ぶじ会場かいじょう到着とうちゃくした。
             "no-doubled-conjunctive-particle-ga": true,
             // https://github.com/takahashim/textlint-rule-no-doubled-conjunction
             // おな接続詞せつぞくし連続れんぞくして出現しゅつげんしていないかどうか
             "no-doubled-conjunction": true,
             // https://github.com/textlint-ja/textlint-rule-no-double-negative-ja
             // じゅう否定ひてい検出けんしゅつ
             "no-double-negative-ja": true,
             // https://github.com/textlint-ja/textlint-rule-no-doubled-joshi
             // じゅう助詞じょし検出けんしゅつ
             // 連続れんぞくしておな助詞じょし場合ばあいのみを検出けんしゅつ
             "no-doubled-joshi": {
                 "min_interval": 1
             },
             // https://github.com/azu/textlint-rule-sentence-length
             // 一文いちぶん最大さいだいなが
             "sentence-length": {
                 "max": 100
             },
             // https://github.com/textlint-ja/textlint-rule-no-dropping-the-ra
             // ら言葉ことば使用しようしない
             "no-dropping-the-ra": true,
             // https://github.com/azu/textlint-rule-no-mix-dearu-desumasu
             // ぶんけいたい(ですます調ちょう)、常体じょうたい(である調ちょう)のチェック
             "no-mix-dearu-desumasu": true,
             // https://github.com/azu/textlint-rule-no-nfd
             // ホ゜ケット エンシ゛ン
             // のような、Mac OS XでPDFやFinderからのコピペで発生はっせいする濁点だくてんのチェック
             "no-nfd": true,
             // https://github.com/textlint-rule/textlint-rule-no-invalid-control-character
             // 制御せいぎょ文字もじ検出けんしゅつ
             "no-invalid-control-character": true,
             // https://github.com/textlint-rule/textlint-rule-no-zero-width-spaces
             // ゼロぶくスペースの検出けんしゅつ
             "no-zero-width-spaces": true,
             // https://github.com/xl1/textlint-rule-no-kangxi-radicals
             // かんひろし部首ぶしゅ検出けんしゅつ
             "no-kangxi-radicals": true
        }
    }
}

Semantic Versioning Policy

つぎのルールでバージョンが更新こうしんされます。

  • Patch リリース
    • かくルールのバグ修正しゅうせい (警告けいこくらす方向ほうこうへの修正しゅうせい)
    • ドキュメントの改善かいぜん
    • 内部ないぶてき変更へんこう (リファクタリングやテストの改善かいぜんなど)
    • リリース失敗しっぱいさいリリース
  • Minor リリース
    • かくルールのバグ修正しゅうせい (警告けいこくやす方向ほうこうへの修正しゅうせい)
    • しんオプションの追加ついか
    • 既存きそんルールの推奨すいしょう
  • Major リリース
    • プリセットへのルールの追加ついか
    • プリセットからルールの削除さくじょ
    • 既存きそんのオプション変更へんこう

textlint-rule-preset-japaneseは、6ヶ月かげつごとにmajorアップデートをおこないます。

更新こうしん内容ないようReleases page参照さんしょうしてください。

Community

質問しつもん以下いかのGitterでおねがいします。

Gitter

そののルール

Contributing

  1. Fork it!
  2. Create your feature branch: git checkout -b my-new-feature
  3. Commit your changes: git commit -am 'Add some feature'
  4. Push to the branch: git push origin my-new-feature
  5. Submit a pull request :D

License

MIT