textlint-rule-ja-space-around-link

リンクの周りをスペースで囲むかどうかを決めるtextlintルール

リンクとはTxtASTのLink nodeのことです。

このルールでは、リンクの前後が日本語である場合に半角スペースを入れるかを決定します。 オプションでスペースの有無を決定できます。

[README](README.md) と日本語の間はスペースを空ける
[README](README.md)と日本語の間はスペースを空けない

Install

Install with npm:

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

Usage

Via .textlintrc(Recommended)

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

Via CLI

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

Options

• before: boolean
  • デフォルト: false
  • trueなら、Linkの前に半角スペースを入れる
• after: boolean
  • デフォルト: false
  • trueなら、Linkの後に半角スペースを入れる

デフォルト値は次のようになります。

{
    "rules": {
        "ja-space-around-link": {
            "before": false,
            "after": false
        }
    }
}

Fixable

textlint --fixの自動修正に対応しています。

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

• github/0x6b

License

MIT © 0x6b

Change Log

All notable changes to this project will be documented in this file. See Conventional Commits for commit guidelines.

2.4.2 (2024-04-24)

Note: Version bump only for package textlint-rule-preset-ja-spacing

2.4.1 (2024-04-20)

Note: Version bump only for package textlint-rule-preset-ja-spacing

2.4.0 (2024-04-20)

Features

• ja-space-between-half-and-full-width: add allows option (#64) (76da132)

2.3.1 (2024-03-10)

Bug Fixes

• fix space after question rule's error message (#61) (614c35c)

Features

• add ja-space-around-link to preset (#53) (6d51772)

2.3.0 (2023-01-23)

Features

• space-between-half-and-full-width: add an option to ignore numbers and apply only to alphabets (#45) (4eec7ed)

2.2.0 (2021-07-22)

Features

• space-between-half-and-full: add option to lint styled nodes (#30) (fcbaa66)

2.1.3 (2021-05-16)

Note: Version bump only for package textlint-rule-preset-ja-spacing

2.1.2 (2021-05-06)

Bug Fixes

• space-around-link: リンクの後にスペースを強制する処理が正常に動作していない不具合を修正 (#27) (3f8c438)

2.1.1 (2021-05-05)

Bug Fixes

• space-around-code: インラインコードの後にスペースを強制する処理が正常に動作していない不具合を修正 (#26) (02573de)

2.1.0 (2021-02-25)

Features

• rule: add textlint-rule-ja-space-around-link (#22) (1d35645)

2.0.2 (2020-09-09)

Bug Fixes

• support LinkReference types (#17) (55ac641)