インラインコードの周りをスペースで囲むかどうかを決めるtextlintルール
インラインコードとはTxtASTのCode nodeのことです。
このルールでは、インラインコードの前後が日本語である場合に半角スペースを入れるかを決定します。 オプションでスペースの有無を決定できます。
`code` と日本語の間はスペースを空ける
`code`と日本語の間はスペースを空けない
Install with npm:
npm install textlint-rule-ja-space-around-code
Via .textlintrc(Recommended)
{
"rules": {
"ja-space-around-code": true
}
}Via CLI
textlint --rule ja-space-around-code README.md
before:boolean- デフォルト:
false trueなら、Codeの前に半角スペースを入れる
- デフォルト:
after:boolean- デフォルト:
false trueなら、Codeの後に半角スペースを入れる
- デフォルト:
デフォルト値は次のようになります。
{
"rules": {
"ja-space-around-code": {
"before": false,
"after": false
}
}
}textlint --fixの自動修正に対応しています。
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.
- Fork it!
- Create your feature branch:
git checkout -b my-new-feature - Commit your changes:
git commit -am 'Add some feature' - Push to the branch:
git push origin my-new-feature - Submit a pull request :D
MIT © azu