azu / textlint-rule-spellcheck-tech-word

[Deprecated] メンテナンスしていません。

Deprecated: Proofdictを使っているためメンテナンスしていません。

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

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

textlint-rule-spellcheck-tech-word's Issues

Rename: textlint-rule-spellcheck-tech-word

spellcheck-tech-word-textlint-rule -> textlint-rule-spellcheck-tech-word

ref textlint/textlint#12

非推奨である旨をnpmパッケージに設定する

本ルールが非推奨であることはREADMEを見ないと分からないので、npmパッケージにその旨を設定すると気づきやすくて良いかと思います。

参考: https://docs.npmjs.com/deprecating-and-undeprecating-packages-or-package-versions

wrong `fix` command

column, lineベースだと、一つの行で複数のHitした時のfixがズレている。(lineを考慮してない)

Deactivate rule when english sentence given

Because they look proper english words as misspellings.

> textlint content/*.md content/post/*.md -f pretty-error
spellcheck-tech-word:  blog =>  ブログ
/home/travis/build/randompaper/randompaper.co/content/post/2015-07-05-hugo-paper.md:8:18
                         v
    7. 
    8. When I created my blog, there are no well simplified [Hugo](http://gohugo.io) theme around the world. I need to a theme that just don't interupt reading experience. [Hugo Paper](https://github.com/uetchy/hugo-paper) is made for that.
    9. 
                         ^
spellcheck-tech-word:  blog =>  ブログ
/home/travis/build/randompaper/randompaper.co/content/post/2015-07-05-hugo-paper.md:10:24
                               v
     9. 
    10. # How to integrate your blog
    11. 

WEB+DBの辞書を分離

初期の流れから https://github.com/azu/technical-word-rules にはWeb+DBが含まれている。
Web+DBの辞書には単語じゃなくてスタイルも含まれているので、

• Web+DBそのもの
• Web+DB - スタイル

を作成し、textlint-rule-spellcheck-tech-word にはスタイルを含めないようにする