textlint-rule-abbr-within-parentheses

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

• Which would you place in parentheses: the expansion or the abbreviation? - English Language & Usage Stack Exchange
• APA Style Blog: An Abbreviations FAQ
• Q&A: Why you shouldn't put acronyms in parentheses
• The IBM Style Guide: Conventions for Writers and Editors - Francis DeRespinis, Peter Hayward, Jana Jenkins, Amy Laird, Leslie McDonald, Eric Radzinski - Google ブックス

Japanese

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

• Microsoft Word - 執筆ガイドライン20151109訂正.docx - denshi-m2.pdf
• Logical Skill の深い話 略語の表記
• 略語 : abbreviation と acronym - 職業プログラマの休日出勤

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/azu
• twitter/azu_re

License

MIT © azu