textlint-rule-spellcheck-tech-word
v5.0.0
Published
textlint rule: spell check technical word for japanese.
Downloads
11,264
Readme
textlint-rule-spellcheck-tech-word
This rule module for azu/textlint.
This rule provide tech word checking for web engineer.
- azu/technical-word-rulesの辞書を使ったtextlint用のルールです
- WEB+DB PRESS用語統一ルールやJavaScript関連の用語などを含んでいます。
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 --fix
での自動修正に対応しています。
FAQ
Q. azu/textlint-plugin-JTF-styleと衝突する
A. カタカナの表記ルールが異なるために両方のルールを適応すると衝突することがあります
例)
- インターフェイス (JTFスタイルガイド)
- インタフェース (WEB+DB)
JTFスタイルガイドが参照する外来語(カタカナ)表記ガイドラインとazu/technical-word-rulesの辞書が含むWEB+DB PRESS用語統一ルールで異なるため発生しています。
そのため、jtf-style
の一部ルールを無効化するか、どちらか片方を利用するように設定する必要があります。
Contributing
- 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
License
MIT