Skip to content

Latest commit

 

History

History

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

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
src
src
 
 
test
test
 
 
CHANGELOG.md
CHANGELOG.md
 
 
LICENSE
LICENSE
 
 
README.md
README.md
 
 
package.json
package.json
 
 

README.md

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

半角文字と全角文字のスペースについてのtextlintルール

半角文字と全角文字にスペースを入れるかどうかを指定できます。

デフォルトでは、半角文字と全角文字の間にスペースを入れません。("never")

OK: これはUnicode
NG: これは Unicode

全角文字には、句読点（、。）も含まれていますがデフォルトでは、有効であるため無視されます。

OK: これも、Unicode。

Install

Install with npm:

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

Usage

Via .textlintrc(Recommended)

{
    "rules": {
        "ja-space-between-half-and-full-width": {
            "space": "never"
        }
    }
}

Via CLI

textlint --rule ja-space-between-half-and-full-width README.md

Options

  • space: "always" || "never" || string[]
    • デフォルト: "never"
    • スペースを常に 入れる("always") or 入れない("never")
    • Array 形式での指定も可能: ["alphabets", "numbers", "punctuation"]
      • 対象としたい物のみ指定する
      • 例えば、数値と句読点（、。）を例外として扱いたい場合は以下
        • ["alphabets"]
  • lintStyledNode: boolean
  • allows: string[]
    • デフォルト: []
    • 例外として扱う文字列の配列
    • RegExp-like Stringも指定可能
  • （非推奨）exceptPunctuation: boolean
    • デフォルト: true
    • 句読点（、。）を例外として扱うかどうか
    • 代わりに space オプションを用いて ["alphabets", "numbers"] と指定する
{
    "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コマース"]
    }

Changelog

See Releases page.

Running tests

Install devDependencies and Run npm test:

npm i -d && npm test

Contributing

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: git commit -am 'Add some feature'
  4. Push to the branch: git push origin my-new-feature
  5. Submit a pull request :D

Author

License

MIT © azu