スキップしてメイン コンテンツに移動

denops.vim を使って初めてvim-pluginを作った。MarkdownをHTMLに変換してクリップボードにコピーする。

denops.vim を使って初めてプラグインを作った

これはVim 駅伝 7 月 28 日 の記事です。 次回は、7 月 31 日に投稿される予定です。

Markdown ファイルを HTML に変換して、クリップボードにコピーしたい

こういう Vim プラグインをずっと探していた。だが、あまりにも需要がないので誰も作っていなかった。

denops-markdown2html

だから、作った。

インストール方法

vim-plug の場合は、

Plug 'vim-denops/denops.vim'
Plug 'ArcCosine/denops-markdown2html'

dein.vim の場合は、

call dein#add('vim-denops/denops.vim')
call dein#add('ArcCosine/denops-markdown2html')

これでインストール出来る。

その他設定

set clipboard+=unnamed

クリップボードを連携させる設定をしておく。 既に設定済みならば、この記述は要らない。

使い方

:DenopsMarkdown2Html

このコマンドを実行する事で、カレントバッファの Markdown を HTML に変換してクリップボードにコピーしてくれる。

開発経緯

このブログの読者で、記憶の聡明な方ならば、10 年くらい前にmarkdown.plを導入した話を覚えているだろう。当時は、perl の markdown 変換ツールが一番メジャーだった。

それから数年後には、nodejs のmarked.jsをベースに変換するツールを使っていた。

どちらのケースも、カレントバッファをツール（markdown.pl,marked.js）に渡して、出力結果をクリップボードにコピーするという動きをしていた。 これらの処理には幾つか不満点があった。

  1. 一時ファイルを生成していた
  2. vimrc に直接書いていてダサかった
  3. perl をインストールする必要があった
  4. nodejs をインストールした上で、npm install コマンドを最初に実行する必要があった。

一時ファイルを生成していた

一時ファイルを、c:\temp\xxmarkdown.html みたいな名前にして、生成していた。 これは僕自身の技術力が無い事が原因で、バッファ経由で外部ツールの結果を保存する術を知らなかったからだ。 多分、Vim のコマンドでそういうの出来る処理あると思う。 今回のプラグイン開発にあたっては、この一時ファイル生成を辞めることに成功した。

余談であるが、Windows の Vim→WSL 上の Vim への移行にあたり、この一時ファイルのパスが Windows と WSL で表記が違うためにかなり苦労した。 これは Vim の問題というより Windows の問題。 Windows 以外なら、多分問題にならないような些細な話だと思う。 いずれにせよ、今回開発したプラグインでこういった煩わしさから開放されるようになった。

vimrc に直接書いていた

やっている処理は非常に簡単なので、数行程度の vimrc で実現出来ることだったが、環境移行するたびに毎回 vimrc をコピペするのはダサいなと感じていた。 プラグインマネージャーで管理出来るなら断然そっちの方が楽だし、どの環境でも同じように使える。 これを止められるようになったのはデカい。

perl をインストールする必要があった

この perl インストール時期はせいぜい 3 年くらいだったが、perl を普段遣いしなくなる時期だっただけに、perl バイナリのインストールは非常に煩わしかった。面倒 of 面倒。 denops に関しても、Deno のインストールが必要だが、

curl -fsSL https://deno.land/x/install/install.sh | sh

このコマンド一発で最新版を入れられる楽さ＆Deno のパッケージ関連の扱いやすさも相まって Deno のインストールには抵抗が少ない。

nodejs をインストールした上で、npm install コマンドを最初に実行する必要があった

nodejs は普段使いしているので、nodejs のインストールはともかく、npm install をやるのは正直面倒だった。 環境構築するたびに毎回それをやるのはダルい。 特に、npm install は、深淵までファイルを持ってくるので、Deno のインストールより遅いんじゃないかという錯覚すら感じる。 実際には、Deno のインストールの方が遅いんだけれど、こいつは 1 回だけやればいい。 パッケージ単位で実行しなくていいので、マジで楽。 perl の所でも書いたが、とにかくパッケージの取り回しがやりやすいのは、Deno の魅力の一つ。 これを Vim でもさっくり使える denops.vim は本当に素晴らしいプラグインだと思う。

つまずきポイント

とはいえ、順風満帆に開発が進んだ訳では無い。 最初に、deno markdown で検索するとhttps://deno.land/x/markdown@v2.0.0が出てくるが、こいつが denops.vim のプラグインで使えない。理由は、とあるスクリプト内で window オブジェクトを触っている場所があるからだ。 ほかにも、https://github.com/denoland/deno-gfmが出てくるが、こいつも同じスクリプトを参照してるので、denops.vim では簡単には動作しない。 この問題を解決するのに 3 日くらい掛かった。 結局、denoland で marked を検索したら、https://deno.land/x/marked@1.0.1が見つかった。これを使えば、markdown を HTML に変換出来る。

この辺の格闘をしつつ、次はバッファからのコピー。 ただ、これは色々なプラグインが実装してたので、それをそのままパクって実装した。

const content = (await denops.call(
    "getbufline",
    await denops.call("bufnr"),
    1,
    "$"
)) as string[];

これで、バッファの文字列の配列が取得できる。 後は、marked 経由で変換すればやりたい事が概ね出来た。 最後の出力に関しては

await denops.cmd("enew");
await denops.call("setline", 1, html.split(/\n/));
await denops.cmd("% yank");
await denops.cmd("bdelete!");

と、コマンドゴリ押しで実装。 もっと綺麗な実装方法があるかもしれないが、とりあえずはこれで行けるかなという感じ。 やってる事は、作業用バッファを開いて、生成した HTML をそのバッファに出力して、それをレジスタにコピーして、バッファを消す。 たったこれだけだ。

たったこれだけのスクリプトを開発するのに 1 週間近く掛かった。 marked にたどり着くのに本当に時間が掛かった。 この辺は、自分が詳しくない畑の技術だったのが大きな要因だと思う。 恐らく、nodejs 系だったらさっくり良い方法を見つけていたと思うので、経験値の差が如実に出たなという感じ。

最後に

denops.vim を使って初めて実用的な vim-plugin を作った。 これで、堂々と Vim 使えますと言える。 開発そのものは、NeoVim でやってるけれど。

この HTML は、denops-markdown2html で出力されました。

ラベル:

コメント

コメントを投稿

このブログの人気の投稿

Let's note CF-SZ6にGoogle Play入りChromeOSを入れて、超軽量Chromebookを手に入れた

Let's note CF-SZ6にGoogle Play入りChromeOSをインストールする 先日、 魔が差して 、 Let's note CF-SZ6の中古 をポチってしまった。なんとなく ChromeOS に触りたくなり、中古のやっすいPCに入れたらええんちゃうんという心の声に逆らえなくなった。 で、一旦ChromeOS Flexを入れて使ってみたんだけれど、やっぱりGoogle Playのアプリが入れられないのはNG。 自分が欲しかったのは、Google Playが使えるChromeOSなんやという事で、 ネットのインストール記事 を探して、入れることにした。 ほぼ、そこの記事通りにインストールしているが、自分なりのアレンジも加えているので、参考にする人は参考にしていただきたい。 手順は下記の通り 軽量Linuxをダウンロードする 対応しているChromeOSのバージョンを調べ、ダウンロードする Brunchをダウンロードする Rufusをダウンロードする USBメモリーに軽量Linuxをインストールし、ChromeOSをコピペする USBメモリーから、実際に軽量Linuxを起動して、インストールコマンドを実行する 軽量Linuxをダウンロードする インストール作業用として、軽量LinuxをUSBメモリーに構築する。 Linux Mint がオススメという事なので、こいつをダウンロードする。 ダウンロードページ にアクセスし、Xfce Editionをダウンロード。 ダウンロードが完了すると、 linuxmint-21.3-xfce-64bit.iso みたいなファイルが出来上がっている。 対応しているChromeOSのバージョンを調べ、ダウンロードする 自分が購入した Let's note CF-SZ6 は、Core i5-7200Uとの事なので、7世代目のCPUとなる。 この7世代目のCPUに対応しているのは、board: rammusのバージョンになる。 https://cros.tech/ にアクセスし、 rammus を検索すると、対応するChrome OSのバージョンが出てくるので、これをダウンロードする。 自分は、 stable バージョンの 126 をダウンロードした。 ダウン...
コメントを投稿
続きを読む

Windows版gVimをアンインストールした日

Windows 版 gVim をアンインストールした話 以前に、 Windows11 on WSL2 + wezterm + Neovim = 最強開発環境 という痛々しい記事を書いたのだが、その続きの記事と言っても過言ではない。 この記事は Vim 駅伝 の 3 月 1 日の記事である。 前回はぺりーさんの netrw を使うために という記事だった。 次回は kuuote さんの Vim 側の組み込みプラグインを無効化するハック という記事である。 gVim との付き合い 思い返してみると、gVim との付き合いは大分長くなった。エディタとしては 自分の人生の中で最も長く付き合ってきたエディタ と言える。Vim のインターフェースとして gVim を何度も使ってきた。自分の手持ちのマシンは Windows なので、必然的に gVim を選択肢として選ぶ必要があった。 gVim の良さは何か。それは、Windows とのシームレスな関係であり、Windows OS の機能をそのまま使いたい場合に有用である。かつての自分にとってこの部分は非常に重要であった。具体的には、印刷機能と画面半透明化機能であり、これが無いとやってられないという認識であった。 しかし、時代が進み、自分の技術力の向上や考え方の変化、さらに Vim 周りのプラグインの更新が進むと gVim で運用していく事がだんだんと億劫になっていったというのが事実である。故に、 WSL2 上で動く Neovim の快適さに心が打ち震えた のである。 技術力の向上に伴う考え方の変化 かつての自分は 何でも gVim で処理したいな と考えていた。メールを見たり天気を見たり、Twitter を見たりするのに、gVim を活用していた。かつての Emacs 使いの guru のような立ち位置を目指していたというのがある。2000 年代初頭にインターネットに多少なりとも触れていた人ならば、「それ Pla」という古の単語を思い浮かべるかもしれない。この概念を持ち出すのはあまりにも古すぎるが、結局言いたいのは、 1 つの手法で全部をこなす という考え方だ。ネットを見るのにわざわざブラウザに切り替えるのはもったいないという今となっては情熱に似た何かを当時は多くの人が持っていた。 しかし、自分自身の技術力...
コメントを投稿
続きを読む

翼の騎士正体考察

翼の騎士正体考察 最新刊の宣伝 先日、 最新18巻が発売された 。七ツ星 魔人 ヴァンデル も残るは、ノア、ベルトーゼ、ロディーナと3体まで減り物語も佳境に入ったと言える。今巻は、新生ビィト戦士団の結成と魔人博士ノアとの邂逅までが描かれているのだが、いやあ、そう来たかぁという落ちで、何も情報無しで読むとめっちゃビックリすると思う。 最新刊読んでいない人は今すぐ購入して読もう。 翼の騎士について 翼の騎士の初登場は（恐らく）7巻P94。シルエットのみの登場。本格的な登場は9巻のP31以降。 本格登場から、ゼノン戦士団の才牙を十分以上に使いこなしていて、正体は一体誰なのだろうと考えさせられるキャラだ。 翼の騎士は ゼノン戦士団を良く知っている ゼノン戦士団の才牙を使いこなせる 武器としてミニガンを持っている（9巻P82） 武器として長剣（？）を持っている（12巻P115） 長剣と天力を使って弓矢のように放つことが出来る？（12巻P126） クルスと同時に存在してるページがある（＝クルスではない）（11巻P123） 才牙は持っていない 時間制限がある（12巻P138） 時間になったり、一定上のダメージを受けると光になって消える（12巻P140） ビィトは素顔を知っている（16巻P61） グランシスタ王と顔見知り（18巻P63） といった要素が挙げられているが、決定打は今のところ無い。 とは言え、ここまで出揃った要素について考えると、幾つかの候補が挙げられる 翼の騎士の正体候補 上記の要素から、翼の騎士の正体は基本的に ゼノン戦士団 の誰かである事は確実だろう。 その場合、候補は三人になる。 ゼノン アルサイド ブルーザム 候補1 ゼノン ベルトーゼとの戦いで光となって消えてしまった ゼノン が翼の騎士の正体と考える読者は多いだろう。 王道でひねり無く行くならば、ゼノンで良い気がする。 ゼノンほどの能力があれば、ゼノン戦士団の才牙を使いこなせるというのも納得だし、光となって消えるのも、回想シーンからある程度納得の行く材料として挙げられる。 しかしながら、ゼノン（＝実の兄）との再開なのに、思った以上にビィトが喜んでいないというのが個人的には引っかかっている。三条陸氏は何もひねらずに伏線回収するよりも、 一捻り入れ...
コメントを投稿
続きを読む