textlint-rule-ja-space-around-phrase

日本語テキスト内の全角文字と半角文字列の間のスペースをチェックするtextlintルールです。

ルール

このルールは以下のスペーシング規則を適用します：

1. 単語（スペースを含まない半角文字列）の場合

   • 全角文字と単語の間にはスペースを入れない
   • OK: これはtestです
   • NG: これは testです

2. フレーズ（スペースを含む半角文字列）の場合

   • 全角文字とフレーズの間にはスペースを入れる
   • OK: これは hello world です
   • NG: これはhello worldです

3. URLの場合

   • 全角文字とURLの間には常にスペースを入れる
   • OK: 詳細は https://example.com を参照
   • NG: 詳細はhttps://example.comを参照

4. メールアドレスの場合

   • 全角文字とメールアドレスの間には常にスペースを入れる
   • OK: メアドは [email protected] です
   • NG: メアドは[email protected]です

5. Markdownリンクの場合

   • [テキスト](URL)形式のリンクはスペース不要（括弧が視覚的な区切りを提供）
   • OK: これは[リンク](https://example.com)です

6. 記号の前後

   • 記号の直前・直後の半角文字列はスペースチェックの対象外
   • OK: （test）は正しい
   • OK: （hello world）と書く
   • OK: 「test」や。test、！test
   • 対象記号: .,;:!?()[]{}「」『』【】、。！？ など

Install

Install with npm:

npm install textlint-rule-ja-space-around-phrase

Usage

.textlintrc.jsonで設定（推奨）

{
    "rules": {
        "ja-space-around-phrase": true
    }
}

CLIで直接使用

textlint --rule ja-space-around-phrase README.md

Examples

正しい例

これはtestです
日本語textを含む
これは hello world です
日本語 test case を含む
詳細は https://example.com を参照
メアドは [email protected] です
これは[リンク](https://example.com)です

# 記号の前後はチェック対象外
（test）は正しい
（hello world）と書く
「test」や。test、！test

誤った例

これは testです
→ 全角文字とスペースを含まない半角文字列の間にはスペースを入れないでください

これはhello worldです
→ 全角文字とスペースを含む半角文字列の間にはスペースを入れる必要があります

詳細はhttps://example.comを参照
→ 全角文字とURLの間にはスペースを入れる必要があります

メアドは[email protected]です
→ メールアドレスと全角文字の間にはスペースを入れる必要があります

Development

Build

src/フォルダのソースコードをlib/フォルダにビルドします。

npm run build

Tests

test/フォルダのテストコードを実行します。 textlint-testerを使用してルールをテストします。

npm test