Repository files navigation

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

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

• textlint-rule-preset-ja-spacing

Visit playground:

• https://textlint-ja.github.io/textlint-rule-preset-ja-spacing/

Install withnpm:

npm install textlint-rule-preset-ja-spacing

Via.textlintrc(Recommended)

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

Via CLI

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

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

半角文字と全角文字の間にスペースを入れるかどうかのルール。デフォルトでは、スペースを入れません。

全角文字同士の間のスペースについてのtextlintルール。デフォルトでは、全角文字どうしの間にスペースを入れません。

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

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

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

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

インラインコードの周りをスペースで囲むかどうかを決めるルール。デフォルトでは、インラインコードの周りをスペースで囲みません。

リンクの周りをスペースで囲むかどうかを決めるルール。デフォルトでは、リンクの周りをスペースで囲みません。

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

{"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,"ja-space-around-link":false         }    }}

またデフォルトでは、次のルールは無効の状態でプリセットに含まれています。

• textlint-rule-ja-space-around-code
• textlint-rule-ja-space-around-link

次のように設定することで、ルールを有効にできます。ルールのオプションについての詳細はそれぞれのパッケージのREADMEを参照してください。

{"rules": {"preset-ja-spacing": {"ja-space-around-code":true,"ja-space-around-link":true        }    }}

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

• textlint-rule-preset-JTF-style: JTF日本語標準スタイルガイド for textlint.

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

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

• Yarn
• Lerna · A tool for managing JavaScript projects with multiple packages.

次のコマンドでmonorepoの依存をインストール。

yarn install

textlint-rule-preset-ja-spacingのテストは事前に全てのパッケージのビルドが必要です。次のコマンドで全てのパッケージをビルドします。

yarn run build

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

yarn test

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

MIT