Microのプラグイン開発、ヘルプの追加

作成したプラグインにヘルプの機能を追加してみます。

最初にヘルプ用のファイルを用意します。

~/.config/micro/plug/sample/以下のファイルは下記の通り

├── README.md
├── help
│   └── sample.md
├── repo.json
└── sample.lua

helpディレクトリにsample.mdを追加し、下記のように記述します。

~/.config/micro/plug/sample/help/sample.md

## Usage
Run the below command in command mode.  
```> vs``

※GitHubでも読めるようにマークダウン記法で記述すると良いです。

Markdown - Wikipedia

---

続いて、プラグイン本体のluaファイルで、sample.mdの内容を出力できるようにします。

~/.config/micro/plug/sample/sample.lua

VERSION = "0.0.1"

local micro = import("micro")
local config = import("micro/config")
local buffer = import("micro/buffer")

function init()
	config.MakeCommand("vs", fn, config.NoComplete)
	config.AddRuntimeFile("sample", config.RTHelp, "help/sample.md")
end

function fn()
	local buf, err = buffer.NewBuffer("hello new panel", "new panel")
	micro.CurPane():VSplitIndex(buf, false)
end

sample.luaを保存後、Microを起動し、コマンドモードで

> help sample

を実行すると、

のようにsample.mdで記載した内容が出力されます。

ヘルプの閉じ方はCtrl + wになります。