textlint rule check if write abbreviations within parentheses.
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
src
test
.gitignore
.travis.yml
LICENSE
README.md
package.json
yarn.lock

README.md

textlint-rule-abbr-within-parentheses Build Status textlint fixable rule

textlint rule check that abbreviations within parentheses.

Write abbreviations within parentheses.

Ths Object Management Group(OMG) maintains specifications for the Unified Modeling Language(UML).

Examples

OK:

This is Open Source Software(OSS)
これはOpen Source Software(OSS)なルールです
JavaScript(JS)

NG:

LTS(Long-Term Support)
JS(JavaScript)
This rule is OSS(Open Source Software)
これはOSS(Open Source Software)なルールです

Install

Install with npm:

npm install textlint-rule-abbr-within-parentheses

Usage

Via .textlintrc(Recommended)

{
    "rules": {
        "abbr-within-parentheses": true
    }
}

Via CLI

textlint --rule abbr-within-parentheses README.md

Reference

English

Japanese

最初に正式名称を書き、繰り返す書くので次から略すという意味合いで、略称を括弧内に書きます。

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