atsuyaw / textlint-launcher4ja

textlint導入・実行ツール
1 stars 0 forks source link
batch proofing-tools textlint textlint-config textract

textlint-lancher4ja

textlint導入・実行ツール

Features

Installation

指示されてtextlintを使う人

  1. 予めnode.jsをインストールしておく。
  2. ./install_textlint_plugins.batを実行する。
    *SmartScreenによってブロックされたら[詳細情報] > [実行]を選択する。
  3. 校正したいファイルを./run_textlint.batにD&Dすると校正結果がコンソールに表示される。
    *若干時間が掛かります。

マネージャー

  1. releaseから.zipをダウンロードする。
  2. 通常のtextlintの環境を展開する。
  3. npm i -D textractを実行する。
  4. 初めにダウンロードしたファイルのpackage.jsonを作成されたpackage.jsonに差し替える。
  5. フォルダを配布する。

Background of development

後輩のドキュメントを事前に校正しておいてほしい。
私はtextlintを使うのですが,後輩は知らない。

それで後輩のPC上にtextlintの環境を構築してCUI操作なしで校正させるツールが必要になりました。
同様の用途を想定したツールとしてGUIで動作する文書校正ツール GUI tool for textlinting.があります。
GUIもきれいで便利なのですが,ruleの導入をやろうとすると自前でbuildすることになり,ちょっとハードルでした。
現状においてはtextlintを使うというところに辿り着くのは,マネージャーがtextlintをCUIで使えるという状況が大半であり,後輩とか部下は詳しいことを知らないけど校正は掛けておいてほしい,という感じではないでしょうか。

その際に普段通りの設定作業をすれば配布も簡単で環境構築にはCUI操作が不要ということが求められる機能です。
つまり,package.jsonをマネージャーが設定し,CUIなしでこれをインストールできればそれで十分というわけです。
結局やっていることは前述のツールと全く同じでtextracttextlintが走っているだけですが。

npm desktop managerとかnpm-guiを使えばマネージャーの操作もCUIレスでできるようになるかも…
まァ誰か詳しい人がいる環境で使うべき,という気はしますが。

軽率にプルリク・issue立ててください!