ayayatter

GitHub Repository

これはなに？

伺かのSHIORIの一つであるYAYAのスクリプト用のフォーマッターです。開発版になります。

先行作品として、apxxxxxxeさんのformatyayaがあります。

機能はUTF-8の辞書ファイルをフォーマットします。(その他の文字コードの辞書については対応検討中です)

これを使うのに必要なもの

Node.js(と付属のnpm)

使い方の基本

まず、このレポジトリをダウンロードして、置きたい場所に展開しておいてください。

レポジトリのダウンロードは、レポジトリトップのCodeボタンの中にあるDownload ZIPから行なえると思います。

展開したディレクトリの場所を、仮にpath/to/ayayatterとします。

`path/to/ayayatter`から起動する方法

コマンドプロンプト、PowerShellなどのシェルで、path/to/ayayatterに移動します。
npm install とし、必要なファイルをインストールします。
npm exec ayayatterと入力し、決定します
使い方が出てくるので、npm exec ayayatter -- と入力し、次に使いたい機能を入力して使用します。

例:

PS path\to\ayayatter> npm exec ayayatter -- --version
0.1.0

どこからでも使えるようにする方法

コマンドプロンプト、PowerShellなどのシェルで、path/to/ayayatterに移動します。
npm install とし、必要なファイルをインストールします。
npm linkと入力して決定すると、シェルでayayatterと入力すると、どこからでも使えるようになります。
ayayatterと入力し、出てきた使い方にそって、次に使いたい機能を入力して使用します。

例: 登録

PS path\to\ayayatter> npm link

例: 使用

PS anywhere\you\want> ayayatter --version
0.1.0

登録を解除したい場合は、シェル上のどこでもいいので、npm unlink -g ayayatterと入力して決定してください。

例: 登録解除

PS anywhere\you\want> npm unlink -g ayayatter

詳細な使い方

ここからの例は全て、どこからでも使えるようにする方法を使っています。

概略

Usage: ayayatter [options] [command]

Options:
  -V, --version              output the version number
  -h, --help                 display help for command

Commands:
  stdin|s <string>           stdin input contents of a yaya dic
  input|i [options] <input>  path to input dic.file
  help [command]             display help for command

`stdin`コマンドの例

<というシェルの機能を使うので、使えるシェルが限られるのですが、

$ ayayatter stdin < path/to/yaya_dict.txt

とすると、path/to/yaya_dict.txtをフォーマットした結果をシェルに出力します。

`input`コマンドの使い方と例

使い方

Usage: ayayatter-input [options]

Options:
  -V, --version              output the version number
  -f, --force                force over-writing (default: false)
  -e, --encoding <encoding>  encoding of input dic file (default: "utf8")
  -h, --help                 display help for command

例

PS anywhere\you\want> ayayatter input -e utf8 path/to/yaya_dict.txt

-fや--forceオプションを付けていない場合、フォーマット結果をシェルに出力します。付けている場合は、入力されたファイルに結果を上書きします。

開発者向け: ビルド方法

$ npm install
$ npm run build-parser
$ npm run build

ライセンス

MITにて配布いたします。

作成者

月波清火 (tukinami seika)

GitHub

tukinami/ayayatter