半角文字と全角文字のスペースについてのtextlintルール
npm install textlint-rule-ja-space-between-half-and-full-width半角文字と全角文字のスペースについてのtextlintルール
半角文字と全角文字にスペースを入れるかどうかを指定できます。
デフォルトでは、半角文字と全角文字の間にスペースを入れません。("never")
OK: これはUnicode
NG: これは Unicode
全角文字には、句読点（、。）も含まれていますがデフォルトでは、有効であるため無視されます。
OK: これも、Unicode。
Install with npm:
npm install textlint-rule-ja-space-between-half-and-full-width
Via .textlintrc(Recommended)
``json`
{
"rules": {
"ja-space-between-half-and-full-width": {
"space": "never"
}
}
}
Via CLI
`
textlint --rule ja-space-between-half-and-full-width README.md
- space: "always" || "never" || string[]
- デフォルト:
- スペースを常に 入れる() or 入れない("never")["alphabets", "numbers", "punctuation"]
- Array 形式での指定も可能:
- 対象としたい物のみ指定する
- 例えば、数値と句読点（、。）を例外として扱いたい場合は以下
-
- : boolean
- デフォルト:
- プレーンテキスト以外(リンクや画像のキャプションなど)を lint の対象とするかどうか (プレーンテキストの判断基準は textlint/textlint-rule-helper: This is helper library for creating textlint rule を参照してください)
-
- デフォルト:
- 例外として扱う文字列の配列
- RegExp-like Stringも指定可能
- （非推奨）: boolean
- デフォルト:
- 句読点（、。）を例外として扱うかどうか
- 代わりに オプションを用いて ["alphabets", "numbers"] と指定する
`json`
{
"rules": {
"ja-space-between-half-and-full-width": {
"space": "always"
}
}
}
space オプションに "punctuation" を含めない場合は、句読点に関しては無視されるようになります。
スペースは必須だが、日本語、[alphabet]。は許可する。
text: "これは、Exception。",
options: {
space: ["alphabets", "numbers"]
}
スペースは不要だが、日本語、 [alphabet] 。は許可する。
text: "これは、 Exception 。",
options: {
space: []
}
スペースは必須だが、Eコマースだけはスペースなしを許可する。
text: "例外的にEコマースはスペースなしでも通す",
options: {
space: "always",
allows: ["Eコマース"]
}
See Releases page.
Install devDependencies and Run npm test:
npm i -d && npm test
Pull requests and stars are always welcome.
For bugs and feature requests, please create an issue.
1. Fork it!
2. Create your feature branch: git checkout -b my-new-feature
3. Commit your changes:
4. Push to the branch:
5. Submit a pull request :D
MIT © azu