README.md

[WIP] aozora-parser.js

青空文庫テキストフォーマットのパーサー (試験実装中...)

HTMLやEPUBへのコンバータは含まれないので、別途用意する必要があります。

使い方

var parser = require('./dist/aozora-parser')

var text = 'これは注記［＃「注記」に傍点］です。'
var result = parser.parse(text)

開発

開発の趣旨は以下の2つ。

• JavaScript版のパーサを作成すること
• 中間形式としてのAST(抽象構文木)を確定すること

準備

• インストール: $ npm install
• テスト: $ npm test

文法の編集

ファイル監視の開始をするには、次のコマンドを打ちます。

$ npm start

この状態で、

• aozora-parser.pegjs
• test/sandbox/source.txt

のどちらかを編集すると、自動的にtest/sandbox/output.jsonが更新されるので、3画面を開いて進めると良さそうです。(パーサーもdist/aozora-parser.jsに出力されています)

PEGの文法に誤り(ループなど)があったりすると、監視が止まっていることがあります。その場合は、一旦Ctrl + Cでプロセスを止めて、再度npm startしてください。

文字コードについて

青空文庫のテキストファイルは、文字集合としてはJIS X 0201-1997とJIS X 0208-1997を、エンコーディング（符号化方式）としてはShift_JISを使っています（JIS X 0201・JIS X 0208に含まれない文字については注記記法を使って表記します）。 このパーサでは、青空文庫のテキストファイルをShift_JISのテーブルを使いUTF-8に変換したファイルを入力ファイルとして扱うことを想定しています。そのため、UTF-8の日本語のテキストファイルであっても、JIS X 0201・0208以外の文字を使ったテキストファイルを処理しようとした場合、予期せぬ挙動をすることがあります。

Licenses

• aozora-parser.pegjs: BSD @kawabata氏のLISP版を元に、@takahashimさんのgistを経由して移植しました。
• その他: MIT