読者です 読者をやめる 読者になる 読者になる

RedPen を使った linter-redpen

Atom の Package linter-redpen を作りました。

以前もこのような RedPen を使った Package を書いていたので第二弾という感じです。

f:id:griffin-stewie:20160403210051p:plain

特徴

"何行目の何文字目" までナビゲート

以前作った redpen package は文書の問題箇所を列挙し、クリックすることで該当行にジャンプすることが出来ました。しかし、具体的な場所(何文字目)までのナビゲーションには対応出来ていませんでした。そこで Atom で使っている他の Lint 系 Package と同じようにピンポイントの場所までナビゲートしてくれるようなものを作りました。

他の linter-XXX ファミリーに準拠した形で linter serviceAPI を使って実装しました。

redpen-server サポート

RedPen にはサーバー機能があります。このサーバーには REST API が実装されています。linter-redpen では通常、RedPen をローカルにインストールしてもらいそのコマンドを叩くのですが、サーバー API を利用する形でも RedPen を利用できるようにしています。設定は通常 redpen コマンドへのパスを入力する 設定項目 Path for RedPen CLIhttp://localhost:8080 のような API サーバーの URL を入力します。

f:id:griffin-stewie:20160403210217p:plain

利用想定としては、以下のような感じです。

  1. ローカルマシン内でサーバーを起動させて使う
    • 文書量とかによるかも知れませんが都度 Command を叩くよりも高速
  2. 社内 LAN 内でサーバーを起動させて使う
    • RedPen 自身をインストールしなくても使えるので技術に疎い人にも使ってもらいやすい

RedPen というツールを試してみたいというのであれば http://redpen.herokuapp.com/ を設定しても良いですがサーバーの負荷もあるので出来れば RedPen をインストールするか自身が管理する環境にサーバーを起動して使うようにしてください。

redpen pacage との違い

指摘箇所が画面下部に一覧で表示されるところは同じです。redpen package のみの特徴として RedPen CLI の実行はユーザー任意のタイミングでできるところです。linter-redpen は Linter Service に依存しているため実行タイミングがコントロールできません。

まとめ

ブログなどテキストを書くことが多い人はぜひ使ってみてください。既存の redpen package も引き続きメンテはしていこうと思っているのでお好きな方をどうぞ。