@bufferings/review.js-vscode NPM

ReVIEW.js for VSCode

このリポジトリは review.js-vscode のフォークです。

このコミットからフォークしています。 https://github.com/yfakariya/review.js-vscode/tree/eded6f8d6812445386e82916459ef81c40a30fb4

修正点

0.19.25: 他の章を参照している場合、章番号のプレビューをスキップするように修正（プレビューは無視してアウトラインが欲しかった）
0.19.24: 他の章を参照している場合に出るエラーを無視するように修正
0.19.23: 囲み記事にキャプションを指定してもエラーにならないように修正

以下 review.js-vscode のREADME.mdです。

このリポジトリは ReVIEW.js のフォークです。

VS Code プラグインのプレビューで問題となる不具合を修正しています。このリポジトリは、本家の開発が再開した場合、（必要に応じて本家へのPull Requestを経て）閉鎖される可能性があります。フォークしたバージョンはv0.16.0のリリース後のコミット 23401fe6298a8236ab8dc7875c1edb2ce508f538 です。

謝辞

オリジナルの ReVIEW.js の作者およびコントリビューターの皆様に対し、この場を借りて敬意と感謝の意を表します。

本家との違い

Windows上のVSCodeで開発できるように修正
v0.18.0
- 以下の要素の動作を改善
  - チャプターに連番が出力されるように修正
  - @<hd>{...} の内容が常にその要素を含むチャプターの名前になっていた問題を修正
  - @<hd>{...} で別の章を参照するとクラッシュする問題を修正
  - テキスト形式のRuby版との互換性の向上
  - @<idx>{...} と @<hidx>{...} のサポート（テキストとHTMLしかないので、ほぼ「エラーにならない」だけ）
  - @<note>{...} のサポート
  - 囲み記事のRuby版との互換性の向上
  - リストにコメントを含めたときに最後のコメントの後ろのコンテンツが出力されない問題
  - リストにコメントを含めたときにコメントの直前の改行が改行コードLFの場合に出力されない問題
  - リストにコメントを含めたときにコメントの前後で行番号がリセットされる問題
- いくつかのライブラリをアップグレード
  - npm audit で問題となったパッケージ
  - tslint と typescript
v0.19.0
- //table 内で @<br>{} を使った場合にクラッシュする問題を修正
- @<title>{章ID}、@<chap>{章ID}、@<chapref>{章ID} が動作していない問題を修正
- 章のタイトルにインライン要素を使用していた場合のHTML版の <title> タグにインライン要素そのものが出てしまう問題を修正
- インライン要素のコンテンツで } を出せるように変更（エスケープのサポートの追加）
- インライン要素のフェンス記法を追加
- インラインコメント（@<comment>{...}）とブロックコメント（//comment{ ... //}）のRubyとの互換性の向上
- //table 記法の実装。
  - テキスト形式では表の前後の空行の数にRubyとの非互換があります。
  - 表の各行の前後の空白文字のトリムについて非互換があります。Ruby版はASCII範囲の空白文字をトリムしますが、review.js-vscodeはUnicodeで空白と定義されている文字（たとえば全角空白）もトリムします。
- ネストされたインライン要素を禁止
  - これは、vscodeのRe:VIEW拡張では表示できたがRubyを使用してPDFを作成した時にエラーになったといった事故を防ぐために禁止しました。
- draft オプションの追加。これはRuby版 review-compiler の --draft と同様に、インラインコメントとブロックコメントの出力に影響します（#@# で始まるコメントには影響しません）。
- inproc オプションの追加。拡張やプラグインとしてNode.js上で使用される場合にプロセスを終了しようとしなくなります。
v0.19.1
- インライン要素を含むキャプションを持つラベル付きチャプターへの @<hd>{...} 要素を記述するとクラッシュする問題を修正。
v0.19.2
- //table 記法でインライン要素しかないセルが続くと正しく出力できない問題を修正。
- //table 記法で前の行の最後と次の行の最初のいずれかまたは両方がインライン要素だと正しく出力できない問題を修正。
- //table 記法でインライン要素とテキストが混ざったセルがあると正しく出力できない問題を修正。

以下、本家の Readme のコピーとなります。

What is ReVIEW?

Composition system for Japanese environment. ReVIEW is flexible and powerful more than Markdown and textile.

ReVIEW.js is implemented by TypeScript :)

ReVIEWとは？

ReVIEW のJavaScript実装です。 Node.js上とモダンなWebブラウザ上で動作することを目指します。

ドキュメント

現状

それなりに多くの構文をサポートしています。現状Ruby版で使えて、ReVIEW.jsで使えない記法は以下の通りです。

texequation ブロック記法
m インライン記法
bibpaper ブロック記法
bib インライン記法
graph ブロック記法
tsize ブロック記法
table ブロック記法
table インライン記法

サポートしている変換先はTextとHTMLのみです。 LaTeXやPDF, EPUBなどはサポートしていません。

また、部(Part)のサポートは部分的です。部があっても処理できますが、単に章として扱われます。

インストール

npm または bower が利用できます。用途にあったものを利用してください。こちらにサンプルを用意してあります。

開発方法

./setup.sh を叩きます。その後、grunt で /bin に実行可能なJSが出力されます。 grunt test, grunt test-browser, grunt-karma でテストを実行することができます。

協力

今貰えると嬉しい手助けはいくつかあります。

test/fixture/valid へのファイルの追加
DefaultAnalyzerが対応する構文の追加
各種Builderの実装 (LaTeXとか)
説明文の改善
- ja.ts を書き換えればできます。
バグを見つけたら報告してください
- 報告は日本語で良いです。日本語向けの組版システムだし。

構文追加のための最初の一歩

構文のノード構築部分を追加する lib/parser/analyzer.ts の DefaultAnalyzer に構文用のメソッドを追加します。 analyzer.tsの末尾にある TODO 以下のものの実装をすすめます。 analyzer.tsの中でinlineが先頭になっているものが簡単に実装できる。実装はまわりのメソッドを参考に。
出力部分を追加する lib/builder/ のなかに出力用ファイルがあります。 htmlBuilder.ts,textBuilder.ts のファイルにも1と同様に同名のメソッドを追加します。メソッド名＿pre,メソッド名＿postの関数を用意した場合にはメソッドの実行前、実行後にそれぞれ処理が実行されます。まずはテキストのデータを表示してみましょう。テキストのデータを取り出したい場合は以下の様に記述すると文字の部分が取得できます。

process.out(nodeToString(process,node));

nodeの中に文字列があるので構築されたnodeを利用して出力を作りましょう。

nodeの処理を大きく変更したい場合はpre(もしくはサフィックスなし)でリターンすると trueを返すと処理を続行する false を返すと処理打ちきって次のノードを処理を行う関数を返すとその関数でノードの評価を行うことができる。 TODO:図を入れる