Ⅰ. 插件描述
Ⅱ. 基本信息
|
Ⅲ. 安装方法
使用Vundle管理器安装
在你的.vimrc下添加:Plugin 'suzuki-hoge/table-converter'
… 然后在Vim中运行以下命令:
:source %
:PluginInstall
对于Vundle版本 < 0.10.2,请用上面的Bundle替换Plugin。
使用NeoBundle管理器安装
在你的.vimrc下添加:NeoBundle 'suzuki-hoge/table-converter'
… 然后在Vim中运行以下命令:
:source %
:NeoBundleInstall
使用VimPlug管理器安装
在你的.vimrc下添加:Plug 'suzuki-hoge/table-converter'
… 然后在Vim中运行以下命令:
:source %
:PlugInstall
使用Pathogen管理器安装
在终端中运行以下命令:cd ~/.vim/bundle
git clone https://github.com/suzuki-hoge/table-converter
Ⅳ. 文档说明
# table-converter
Vim上でcsvとmarkdownのテーブル記法の相互変換を行うVimプラグイン、および変換APIです
初期設定
スクリプト取得
$ git clone https://github.com/suzuki-hoge/table-converter.git
vimの設定ファイル(~/.vimrc)に設定を追記
`VimScript:~/.vimrc
let g:table_converter_root_path = '/path/to/dir/vim/table-converter'
source /path/to/dir/vim/table-converter/vim/commands.vim
## 使い方(Vimプラグイン)
### ToMarkdown
範囲選択中に`:ToMarkdown`と入力すると、現在編集しているファイルの一部を`csv`から`markdown`に変換して書き換えます
<img src="./demo/OK-ToMarkdown.gif" width="550px">
選択した行のカラム数がずれている等のエラー時には書き換えは行われません
<img src="./demo/NG-ToMarkdown.gif" width="550px">
+ このエラー時の挙動は他のコマンドも全て同様です
### ShowMarkdown
`ToMarkdown`と違い、変換結果は表示されるだけです
<img src="./demo/OK-ShowMarkdown.gif" width="550px">
+ `ShowMarkdown`で編集と確認を繰り返し、`ToMarkdown`を最後に実行すると良いです
### AppendMarkdownFromFile
`csv`ファイルを読み込み、カーソルの位置に`markdown`を展開します
デモ用の入力ファイル
$ cat ../samples/valid.csv
Title,Hero,Boss
MGS,Solid Snake,Liquid Snake
MGS2,Raiden,Solidus Snake
MGS3,Naked Snake,The Boss
<img src="./demo/OK-AppendMarkdownFromFile.gif" width="550px">
+ ある程度の大きさの新たなテーブルを作成する場合にはぜひご利用ください
### ToCsv
`ToMarkdown`の逆を行います
<img src="./demo/OK-ToCsv.gif" width="550px">
+ `csv`に変換するのは何らかの表計算ソフトで編集し直すためだと思われるので、縦揃えはされず隙間はつめて出力されます
+ 縦の揃っていない`markdown`に`ToCsv`と`ToMarkdown`を実行すると縦が揃います
### WriteCsvToFile
選択した範囲の`markdown`を`csv`に変換し、ファイルに書き出します
<img src="./demo/OK-WriteCsvToFile.gif" width="550px">
デモ用の出力ファイル
$ cat xxx/out.csv
Title,Hero,Boss
MGS,Solid Snake,Liquid Snake
MGS2,Raiden,Solidus Snake
MGS3,Naked Snake,The Boss
+ この例では出力先はマスクしていますが、実際にはフルパスが表示されます
+ `AppendMarkdownFromFile`とあわせてご利用ください
## 使い方(コマンドラインツール)
### to-markdown.py
標準入力で改行を含む文字列を受け取り、標準出力します
デモ用の入力ファイル
$ cat valid.csv
Title,Hero,Boss
MGS,Solid Snake,Liquid Snake
MGS2,Raiden,Solidus Snake
MGS3,Naked Snake,The Boss
実行
$ cat valid.csv | python to-markdown.py
| Title | Hero | Boss |
|---|---|---|
| MGS | Solid Snake | Liquid Snake |
| MGS2 | Raiden | Solidus Snake |
| MGS3 | Naked Snake | The Boss |
### to-csv.py
標準入力で改行を含む文字列を受け取り、標準出力します
デモ用の入力ファイル
$ cat valid.md
| Title | Hero | Boss |
|---|---|---|
| MGS | Solid Snake | Liquid Snake |
| MGS2 | Raiden | Solidus Snake |
| MGS3 | Naked Snake | The Boss |
実行
$ cat valid.md | python to-csv.py
Title,Hero,Boss
MGS,Solid Snake,Liquid Snake
MGS2,Raiden,Solidus Snake
MGS3,Naked Snake,The Boss
## 環境
| version
:-- | :--
Python | 2.7.5
Vim | 7.4.22