[textlint] This rules provide tech word checking for web engineer.
JavaScript
Latest commit 36dbdce Mar 18, 2016 @azu 5.0.0

README.md

textlint-rule-spellcheck-tech-word textlint rule Build Status

This rule module for azu/textlint.

This rule provide tech word checking for web engineer.

Installation

npm install textlint-rule-spellcheck-tech-word

Usage

npm i --save-dev textlint textlint-rule-spellcheck-tech-word
textlint --rule spellcheck-tech-word file.md

Example

See example/

$ textlint --rule spellcheck-tech-word README.md

textlint-rule-spellcheck-tech-word/example/README.md
  3:4  error  Java Script => JavaScript

✖ 1 problem

Fixable

textlint rule

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

FAQ

Q. azu/textlint-plugin-JTF-styleと衝突する

A. カタカナの表記ルールが異なるために両方のルールを適応すると衝突することがあります

例)

  • インターフェイス (JTFスタイルガイド)
  • インタフェース (WEB+DB)

JTFスタイルガイドが参照する外来語(カタカナ)表記ガイドラインazu/technical-word-rulesの辞書が含むWEB+DB PRESS用語統一ルールで異なるため発生しています。

そのため、jtf-styleの一部ルールを無効化するか、どちらか片方を利用するように設定する必要があります。

Contributing

  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

License

MIT