スペース周りのスタイルを扱うtextlintルール集
Switch branches/tags
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
packages
test
.babelrc
.gitignore
.travis.yml
README.md
lerna.json
package.json

README.md

textlint-rule-spacing Build Status

textlintのスペース関連のmonorepoです。

日本語周りにおけるスペースの有無を決定するtextlintルールプリセットを提供します。

Install

Install with npm:

npm install textlint-rule-preset-ja-spacing

Usage

Via .textlintrc(Recommended)

{
    "rules": {
        "preset-ja-spacing": true
    }
}

Via CLI

textlint --preset preset-ja-spacing README.md

それぞれのルールは個別のモジュールであるため、必要なルールのみをインストールすることも可能です。

ルール一覧

textlint-rule-ja-space-between-half-and-full-width

半角文字と全角文字の間にスペースを入れるかどうかのルール デフォルトはスペースを入れない。

textlint-rule-ja-space-around-code

インラインコードの周りにスペースを入れるかを決めるルール

textlint-rule-ja-no-space-between-full-width

全角文字同士の間のスペースについてのtextlintルール。 全角文字どうしの間にスペースを入れません。

textlint-rule-ja-nakaguro-or-halfwidth-space-between-katakana

カタカナ語間の区切り文字についてのtextlintルール。 カタカナ語間は中黒または半角スペースを用いてカタカナ語を区切ります。

textlint-rule-ja-no-space-around-parentheses

かっこの外側、内側ともにスペースを入れないようにするルール

textlint-rule-ja-space-after-exclamation

文末に感嘆符を使用し、後に別の文が続く場合は、直後に全角スペースを挿入します。 文中に感嘆符を使用する場合はスペースを挿入しません

textlint-rule-ja-space-after-question

文末に疑問符を使用し、後に別の文が続く場合は、直後に全角スペースを挿入します。 文中に疑問符を使用する場合はスペースを挿入しません。

デフォルト設定

デフォルトでは、次のような設定になっています。

{
    "rules": {
        "preset-ja-spacing": {
             "ja-nakaguro-or-halfwidth-space-between-katakana": true,
             "ja-no-space-around-parentheses": true,
             "ja-no-space-between-full-width": true,
             "ja-space-between-half-and-full-width": {
                 "space": "never"
             },
             "ja-space-after-exclamation": true,
             "ja-space-after-question": true,
             "ja-space-around-code": false,
         }
    }
}

またデフォルトでは、textlint-rule-ja-space-around-codeは無効になっています。

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

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

関連

JTFスタイルガイドに含まれているルールと大部分は共通しています。 以下のプリセットを利用している場合は重複するルールがあります。

開発フロー

  1. packagesに作成ルール名でディレクトリを作成
  2. 作成したディレクトリに通常のnpmモジュール作成と同一のフローで作成

その後、packages全体について操作したい場合はlernaを使います。

全てのpackagesのnpm install:

npm run bootstrap

Tests

以下のコマンドで全てのルールのテストを実行できます。

npm i -d && npm test

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