Re:VIEW support for Atom

Re:VIEW is flexible document format/conversion system. It is used primarily in Japan.

本パッケージはRe:VIEWサポートをAtomに追加するためのものです。依存しているreview.jsの開発が進むにつれこちらもリッチになっていきます。

利用方法

インストール方法

Atomの設定画面で language-review と検索してインストールするか、apm install language-review を実行してください。

簡単にAtomやlanguage-reviewをインストールするためのスクリプトも用意しておきました。 Mac環境でのみ動作を確認しています。

$ curl -L https://github.com/vvakame/language-review/raw/master/install.sh | bash

.reファイルの編集

.re ファイルを編集する時に、grammarをRe:VIEWに設定してください。

機能の呼び出し

language-reviewには .re ファイルの編集支援の他に、いくつかの機能があります。

Toggle Preview は現在開いている .re ファイルのプレビューを表示します。 review.jsによりコンパイルし表示し、独自のCSSを当てているため、実際に出力する際には大きな差異が発生するでしょう。文法が正しいかを確かめたり、文章の分量調整などの参考程度に使ってください。

Toggle Outline は現在開いている .re ファイルのアウトラインを表示します。好きな見出しを選んでジャンプすることもできます。

Toggle Syntax List はreview.jsがサポートする構文の一覧が表示されます。これ以外の資料として、Re:VIEWのフォーマットガイドなどを利用してください。

校正機能の利用

language-reviewにはprhが組み込まれています。 .re ファイルと同じディレクトリに設定ファイルを prh.yml という名前で配置してください。 .re ファイルの編集時にルールにしたがって修正案を表示してくれます。

開発方法

$ git clone git@github.com:vvakame/language-review.git
$ cd language-review
$ apm link --dev .
$ apm links
# 全く同じ表示にはならないが同じようなニュアンスだったらOK
~/.atom/dev/packages (1)
└── language-review -> ${pwd}
~/.atom/packages (0)
└── (no links)
$ ./setup.sh
# 依存関係が解決される
$ atom --dev .
# 適当に開発する

ビルドにgruntを使うため、npm install -g grunt-cliを実行しておいてください。

ビルドにはgruntを実行してください。

テストにはgrunt testを実行してください。

デバッグログを出力するにはPackageの設定でDebugオプションをONにしてください。

ライセンス

本パッケージはMITライセンスで配布しています。

本パッケージはApache License Version 2.0で配布されているyanzmのSublime Text2用Re:VIEWプラグインの成果物(review.tmLanguage)を含みます。本パッケージはApache License Version 2.0で配布されているatom-lintパッケージの成果物を真似したものを含みます。

kanzmrsw / language-review