[[📒Articles]] > [[📒2024 Articles]] ![[2024-09-18.webp|cover-picture]] 人生で初めてつくった[[Neovimプラグイン]]、[[🦉ghostwriter.nvim]]について紹介させてください。 > [!info] > この記事は [[Vim駅伝]] #2024/09/18 の 参加記事です。 ## はじめに [[📚実践Vim]]に感銘を受け、[[Vim]]の道へと続く扉を開いてから、6年8ヶ月が経ちました。[[Vim]]といっても当時はまだ[[IntelliJ IDEA]]や[[VSCode]]をメインで使っており、[[Vim]]の思想やキーマップのみをつまみ食いしていましたが、昨年末には[[Neovim]]に入れ込んでしまいました。 <div class="link-card"> <div class="link-card-header"> <img src="https://publish-01.obsidian.md/access/35d05cd1bf5cc500e11cc8ba57daaf88/favicon-64.png" class="link-card-site-icon"/> <span class="link-card-site-name">minerva.mamansoft.net</span> </div> <div class="link-card-body"> <div class="link-card-content"> <p class="link-card-title">📘Neovimを使ったことがなかったころの君へ</p> <p class="link-card-description">2023年のおわり、1年のふりかえり記事を書こうとネタを考えながら帰路につき、いつもは見ないポストを開けるとそこには見慣れない1通の手紙が...。</p> </div> <img src="https://publish-01.obsidian.md/access/35d05cd1bf5cc500e11cc8ba57daaf88/%F0%9F%93%98Articles/attachments/2023-12-29.jpg" class="link-card-image" /> </div> <a class="internal-link" data-href="📘Articles/📘Neovimを使ったことがなかったころの君へ.md"></a> </div> %%[[📘Neovimを使ったことがなかったころの君へ]]%% 時の流れは速いもので、あれからもうすぐ1年です。上記のarticleを投稿したときは画面賑やかに[[coc.nvim]]を使っていましたが、今では[[nvim-lspconfig]]、[[conform.nvim]]、[[nvim-cmp]]を片手に開発しています。その辺のプラグイン事情については以下のarticleに書きました。 <div class="link-card"> <div class="link-card-header"> <img src="https://publish-01.obsidian.md/access/35d05cd1bf5cc500e11cc8ba57daaf88/favicon-64.png" class="link-card-site-icon"/> <span class="link-card-site-name">minerva.mamansoft.net</span> </div> <div class="link-card-body"> <div class="link-card-content"> <p class="link-card-title">📘あまり紹介されていないけど かけがえのないNeovimプラグインたち</p> <p class="link-card-description">Neovimプラグインの中で、日本語サイトでほぼ見かけないものに限定してお気に入りをいくつか紹介してきます。</p> </div> <img src="https://publish-01.obsidian.md/access/35d05cd1bf5cc500e11cc8ba57daaf88/%F0%9F%93%98Articles/attachments/2024-03-27.webp" class="link-card-image" /> </div> <a class="internal-link" data-href="📘Articles/📘あまり紹介されていないけど かけがえのないNeovimプラグインたち.md"></a> </div> %%[[📘あまり紹介されていないけど かけがえのないNeovimプラグインたち]]%% そんな私ですが、これまでにまだやり遂げていないことがありました。[[Vim]]および[[Neovim]]のプラグイン開発です。開発言語が[[VimScript]]や[[Lua]]と馴染みのない言語だったこと、欲しいプラグインは大体どなたかが既に開発されていることから、この道に踏み込めないでいました。 しかし、同僚のつよつよVimmerが退職されることになったので『この出来事を動機として何かを残せないか...』と考えた結果、[[Neovimプラグイン]]をつくってみることにしたのです。 ## つくったプラグイン [[🦉ghostwriter.nvim]]というプラグインをつくりました。 <div class="link-card"> <div class="link-card-header"> <img src="https://github.githubassets.com/favicons/favicon.svg" class="link-card-site-icon"/> <span class="link-card-site-name">GitHub</span> </div> <div class="link-card-body"> <div class="link-card-content"> <p class="link-card-title">GitHub - tadashi-aikawa/ghostwriter.nvim: A Neovim plugin to share Markdown task lists as Slack posts.</p> <p class="link-card-description">A Neovim plugin to share Markdown task lists a ... </p> </div> <img src="https://opengraph.githubassets.com/173e86b7605d77c7dd3fd3bc386b5b562df332c9c28708a72ef1dde77d70bef7/tadashi-aikawa/ghostwriter.nvim" class="link-card-image" /> </div> <a href="https://github.com/tadashi-aikawa/ghostwriter.nvim"></a> </div>  名前とロゴの通り、ゴーストが代筆するプラグインです。具体的には、[[Neovim]]で記載した内容を[[Slack]]に転記するプラグインです。 ## 機能一覧 [[🦉ghostwriter.nvim]]の主な機能(コマンド)は3つです。 - GhostwriterCopy - GhostwriterPost - GhostwriterWrite 本プラグインのメイン機能は **GhostwriterWrite** ですが、説明のしやすさから上記の順で説明していきます。 ## GhostwriterCopy `GhostwriterCopy`コマンドは、[[ビジュアルモード]]で選択したテキストを、[[Slack]]で投稿するために適した形に変換して[[クリップボードレジスタ]]に[[ヤンク]]する機能です。 たとえば、以下のように15~18行目を[[ビジュアルモード]]で選択します。 ![[Pasted image 20240917212531.png]] そのまま `GhostwriterCopy`コマンドを実行すると、[[クリップボードレジスタ]]に以下の値が入ります。 ``` *執筆* :loading: Vim駅伝 :loading: 執筆『Slackに進捗状況を共有できるNeovimプラグインをつくってみた』(9/18投稿分) ``` `## 執筆` が `*執筆*` に置き換わっているのは[[🦉ghostwriter.nvim]]のによるものです。[[Slack]]では `##` のような[[Markdown]]の見出しに対応していないため、太字表現に置換しています。 また、`- [~]` が `:loading:` に置き換わっているのは、以下設定によるものです。 ```lua config = function() require("ghostwriter").setup({ check = { { mark = "~", emoji = "loading" }, { mark = "x", emoji = "ok_green" }, { mark = "_", emoji = "rip" }, { mark = "-", emoji = "togowl_pause" }, { mark = " ", emoji = "circle-success" }, } }) end, ``` [[Slack]]では `- [ ]` や `- [x]` のような[[GitHub Flavored Markdown]]の[[Task list items (GFM)|Task list items]]に対応していないため、近しい表現の絵文字に置き換えています。今回の例は進行中を意味する `- [~]` であるため `:loading:` の絵文字に置き換わっています。 [[クリップボードレジスタ]]に入った値を[[Slack]]に貼り付けると、最終的に以下のような見栄えになります。 ![[2024-09-17-21-38-13.webp]] なお、表現を変える設定には以下のようなものがあります。 ```lua config = function() require("ghostwriter").setup({ -- 特定の正規表現にマッチする行の一部を置換する replacers = { { pattern = "202%d+_", replaced = " " }, { pattern = " %d%d:%d%d ", replaced = " " }, }, -- Task list items (GFM) の置換 check = { { mark = "x", emoji = "large_green_circle" }, { mark = " ", emoji = "white_circle" }, }, -- ビュレットの置換 (箇条書きマークの置換) bullet = { emoji = "small_blue_diamond", }, -- インデントの倍率 (Slackはインデント4なのでMarkdownが2だと2倍する必要あり) indent = { ratio = 2, }, -- ヘッダの場合は空行を1行挟んで少し間をつくる header = { before_blank_lines = 1, }, }) end, ``` 上記を一通り使ったもう1つの例を紹介します。 ![[Pasted image 20240917214700.png]] `GhostwriteCopy`コマンドの実行結果は以下のようになります。 ``` *Minerva* :circle-success: LuaLSまわり :ok_green: `@param` `@return` annotation :loading: `@async` annotation :small_blue_diamond: [参考](https://github.com/LuaLS/lua-language-server/wiki/Annotations#async) :circle-success: `hint.await` :small_blue_diamond: [参考](https://luals.github.io/wiki/settings/#hint) :circle-success: `async.void` でdiagnosticsが消えないの回避策 :circle-success: 締め切り *学習/環境強化* :circle-success: TypeScript/Web :circle-success: TypeScript 5.6を使ってみる :circle-success: VCaendarの事前調査 :circle-success: JSRを試す :circle-success: Nix :circle-success: [NixOSで最強のLinuxデスクトップを作ろう](https://zenn.dev/asa1984/articles/nixos-is-the-best) 読む :circle-success: Python :circle-success: uvを試す :circle-success: サンプルプロジェクトで挙動を確認 :circle-success: uvをJumeauxに取り込めるか検討する ``` テキストだとカオスかもしれませんが、[[Slack]]で見ればご覧の通りです。 ![[Pasted image 20240917214851.png]] ## GhostwriterPost `GhostwriterPost`コマンドは、[[ビジュアルモード]]で選択したテキストを、引数で指定したchannelへと投稿する機能です。投稿内容は `GhostwriterCopy`コマンドと同じロジックで変換されます。`GhostwriterCopy`コマンドのように、投稿前に[[Slack]]を開く必要がない分だけ気軽に素早く投稿できます。現在の投稿を確認する必要がなければオススメです。 使い方をREADMEから抜粋しました。 ``` GhostwriterPost <channel_name> [header] ``` | Parameter | Required | Description | | ------------ | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------- | | channel_name | true | The name used to identify the channel. This is `channel.name` specified in the config, and is different from the **actual slack channel name**. | | header | false | Header message to be added before the selected text. | ### channel_name `channel_name`にはconfigで`channel.name`に設定したchannelを一意に判別できる文字列を指定します。設定が以下であれば `times` か `task` です。`id` にはchannel IDを指定します。 ```lua config = function() require("ghostwriter").setup({ -- サンプルなので channel.id には適当な値を設定しています channel = { { name = "times", id = "C1C5MJ80F" }, { name = "task", id = "C06JRG10V2L" }, }, }) end, ``` `channel_name`の一覧は補完候補に表示されますので綴りは覚えなくても大丈夫です。投稿後の[[Slack]]については`GhostwriterCopy`のときと同じなので割愛します。 ![[2024-09-17-22-07-40.webm]] また、よく投稿するchannelにはあらかじめコマンドを設定しておきましょう。モードが[[ビジュアルモード]]でないと正しく動かない点だけ注意してください。 ```lua { keys = { { "<C-j>p", ":GhostwriterPost times", mode = { "v" } }, } } ``` ### header 2つ目のパラメーター `header` について説明します。`GhostwriterPost`コマンドでは、第2引数以降の空白を含むすべての文字列を選択メッセージに対するヘッダーとして扱い、冒頭に追加します。何を言っているのか分からないと思いますので、例を紹介します。 まず、[[ビジュアルモード]]で以下のテキストを選択します。 ```lua hoge ``` そして、以下のコマンドを実行します。 ``` GhostwriterPost times Vim駅伝用に書いたサンプルソースコードです 👍 ``` すると、[[Slack]]には以下のメッセージがポストされます。 ![[Pasted image 20240917221458.png]] [[Neovim]]を開いている状態で[[Neovim]]から何かを投稿したくなるシーンを考えると、私の場合は『タスクの進捗』『箇条書きで整理したメモ』『コードスニペット』が多いです。ただし、それらを**本体だけで投稿することはほぼありません**。大抵の場合、直前に但し書きが入ることでしょう。『本日の進捗です』『自分の認識はこんな感じなのですがどうでしょう?』『エラーになった部分のソースコードです』。 これらの但し書きは、あらかじめ[[Neovim]]に記入してから `GhostwriterPost`コマンドを実行することもできます。しかし、その場合はコマンド実行後に但し書きを削除するという手間が発生します。但し書きの内容は一文で済むことも多いため、それならばコマンド引数として入力できるようにしようと思った...ということです。 ## GhostwriterWrite これが3つ目、最後のコマンドです。本記事のタイトルは『Slackに進捗状況を共有できるNeovimプラグインをつくってみた』...ですが、その目的で最初に作成したのがこの `GhostwriterWrite`コマンドです。このコマンドは**かなりマニアックな挙動をする**ため、敢えて紹介を最後に回しました。最初に紹介するとマニアックすぎて離脱する方が増えそうに思えたからです。 ### 今までと同じこと/違うこと `GhostwriterWrite`コマンドは以下の点で、今まで紹介した2つのコマンドと同じような挙動をします。 - [[Markdown]]で書かれたテキストを設定に従って[[Slack]]に適した形式へ変換する - 変換したテキストを[[Slack]]に投稿する 一方、`GhostwriterWrite`コマンドがマニアックと言われる所以は以下2点です。 - 投稿されるテキストの範囲 - 投稿先と投稿のされ方 それぞれ掘り下げていきます。 ### 投稿されるテキストの範囲 `GhostwriterWrite`コマンドでは、**カレントバッファの2行目から`---`の区切り線が登場するまで**の範囲を[[Slack]]に投稿します。`---`の区切り線が出現しなければ[[バッファ (Vim)|バッファ]]の終端までとなります。 たとえば、以下の[[バッファ (Vim)|バッファ]]を開いているとしましょう。 ``` C180CJ5MF ## タスク - [ ] hoge - [ ] hoge - fuga - fuga --- ここは投稿されない ``` この場合、投稿されるテキスト(変換前)は以下のようになります。 ``` ## タスク - [ ] hoge - [ ] hoge - fuga - fuga ``` ### 投稿先と投稿のされ方 投稿先と投稿のされ方は**カレントバッファの1行目によってのみ**決まります。1行目には対応している以下4つのパターンのいずれかを記載する必要があります。 | No | パターン名 | 投稿のされ方 | | --- | -------------------- | ---------------------------- | | 1 | 投稿のURL | **指定投稿を削除し、同channelに新規投稿する** | | 2 | channelのURL | 指定channelに新規投稿する | | 3 | channel IDとtsのカンマ区切り | **指定投稿を削除し、同channelに新規投稿する** | | 4 | channel ID | 指定channelに新規投稿する | 各パターンの具体的な値です。 ```bash # パターン1 (投稿のURL) https://minerva.slack.com/archives/C2J10C5MF/p1722259290076499 # パターン2 (channelのURL) https://app.slack.com/client/TKY180702/C2J10C5MF # パターン3 (channel IDとtsのカンマ区切り) C2J10C5MF,1722347931.398509 # パターン4 (channel ID) C2J10C5MF ``` [[#投稿されるテキストの範囲]] で提示した例はパターン4 (channel ID) となります。 ### 『指定投稿を削除し、同channelに新規投稿する』ことの意義 パターン2と4..『指定channelに新規投稿する』についてはそこまで気になる点もないと思います。指定したchannelにバッファの投稿範囲をポストするだけです。 しかし、『指定投稿を削除し、同channelに新規投稿する』についてはこう思った方もいらっしゃるのではないでしょうか。 ``` 『指定投稿を削除せず、そのまま更新したり、新しく投稿した方がいいのでは...』 ``` まさに、この部分に[[🦉ghostwriter.nvim]]に対する拘りがあるのです。 ### GhostwriterWriteを実行している動画を見てみる 百聞は一見に如かず。実際に利用している動画をご覧ください。 ![[2024-09-17-23-04-51.webm]] この動画は『あるchannelに対して、`task.md`に記載されたタスク進捗状況を共有する』というシナリオを想定しています。`<C-j>w`というキーにコマンドを割り当てているため[[コマンドラインモード]]は表示されていませんが、ターミナルの右上に通知が表示されたタイミングでコマンドが実行されています。動画からは以下の流れを確認できます。 1. コマンドを実行すると投稿範囲のテキストが[[Slack]]に投稿される 2. 1回目はバッファ1行目のchannel IDをもとに対象channelへ投稿する 3. **投稿されたメッセージのchannel IDとtsがバッファの1行目に上書きされる** 4. **2回目以降はchannel IDとtsから、前回投稿を削除して新しい投稿を行う** 5. 3に戻る このように、進捗内容を更新して `GhostwriterWrite`コマンドを実行する...というフローを繰り返すと、**常にchannelの最新投稿に、最新の進捗状況が表示**されます。この挙動には以下のメリットがあります。 - channel確認者は常に最新の進捗状況をファーストビューで確認できる (更新時間含む) - 途中の進捗投稿が削除されるため、最終的なchannelのタイムラインがスッキリする 一方、投稿内容を更新したり新しく投稿しなおすことに比べ、以下のデメリットを感じる場合もあると思います。 - 途中、途中での進捗状況が記録されない - 進捗状況が長くなると、ファーストビューが進捗状況だけで埋まってしまう - 進捗状況の投稿にスレッドで返信すると、スレッドの親が削除扱いになってしまう - 新規投稿通知がたくさんくる 正直、これは状況と好みの問題でしょう。今の[[🦉ghostwriter.nvim]]に投稿を更新する機能や、連続して新規投稿する機能はありません。しかし、[[🦉ghostwriter.nvim]]が他の[[Vimmer]]にも受け入れられ、そのようなニーズが出てきたら対応するつもりではいます。 ## まとめ はじめてつくった[[Neovimプラグイン]]、[[🦉ghostwriter.nvim]]をご紹介しました。当初は進捗状況の共有 (`GhostwriterWrite`) に特化したプラグインでしたが、あとから追加したコマンドにより、簡易的な[[Slack]]投稿用クライアントとしても利用できます。 - PCスペックの都合で[[Slack]]を立ち上げたくない方 - [[Neovim]]やターミナルから離れたくない方 - 気が散るから[[Slack]]を見てくないけど投稿はしたい方 是非お試しいただければと思います。 本当は[[Lua]]や[[lua-language-server|LuaLS]]に関する使い勝手の話も盛り込みたかったのですが、ボリュームも十分であり時間もないため、それは次の機会とさせてください。 最後に... 私が[[🦉ghostwriter.nvim]]を使っているケースを箇条書きで列挙して終了とさせていただきます。 - `GhostwriterWrite`コマンド - times channel に本日の業務進捗状況を共有 - 1on1 や MTG で議事進捗状況を共有 - `GhostwriterPost`コマンド - タスク管理channelにタスクを追加 - チームのchannelへラフに情報共有 - `GhostwriterCopy`コマンド - 日報や週報などをSlackで編集する際に下書きとして利用 他に有用なケースがありましたら、[[Bluesky]]か[[GitHub]]の方までリアクションください！