Open3

Obsidian 自分用のプラグインを作ってみる

しのしの

背景

Templaterだと対応できない処理があったので、自分用のプラグインを作ることにした。

公開する予定はなく、自分だけで使う想定。
gitやnpmは使わず、テキストエディタだけで簡単につくる。
コードを書くのは、基本的にChatGPTにお任せ。

gitやnpmを使ってがっつり開発する方法はいろいろ出てくるけれど、そういうものなしで簡単に作るやり方がぱっと見つからなかったので、スクラップとして残しておこうと思った。

きちんと作りたい場合は、Build a plugin - Developer Documentationを参照。普通にわかりやすいので、このドキュメントに従ってやった方がいいかも。

しのしの

プラグインの基礎

手順1. ファイルの作成

1. ファイルの作成
まず、.obsidianのpluginsフォルダ内に、新しいフォルダを作成し、任意の名前を付ける。
作成したフォルダ内にmanifest.jsonとmain.jsを作成する。

.obsidian/
└── plugins/
    └── task-schedule-plugin/
        ├── manifest.json
        └── main.js

2. 中身を書く
次に、ファイルの中身を書く。

ChatGPTに{やりたいこと}を実行するためのObsidianのプラグインをつくってと指示。
main.jsではなくて、main.tsが作成されてしまった場合は、main.jsを書いてと追加で指示。

出力されたコードを、先ほど作成したファイルにコピペして保存。

3. フォルダ名を合わせる
最後に、manifest.jsonのidとプラグインのフォルダ名を一致させる。

{
  "id": "task-schedule-plugin",
  "name": "Task Schedule Plugin",
  "version": "1.0.0",
  "minAppVersion": "0.12.0",
  "author": "Your Name",
  "description": "Displays task information with schedule details in the sidebar.",
  "isDesktopOnly": false
}

手順2. プラグインの読み込み

ファイルの作成が終わったら、プラグインを読み込む。
設定 > Community plugins > Installed plugins セクションの🔄ボタンを押すと、自作プラグインが表示されるので、有効化する。

これでプラグインが使えるようになる。

プラグインを有効化できない場合は、ChatGPTに聞いて修正。
Ctrl ＋ Shift + I で開発者ツールを立ち上げ、エラーコードをコピーしてChatGPTに投げる。

手順3. プラグインを作り込む

挙動を確認したり、修正したりしていく。

エラー修正がうまくいかない場合、自分で公式ドキュメントを確認し、めぼしいメソッドをコピペして、ChatGPTに教えてあげる。
公式ドキュメント: Home - Developer Documentation

プラグインの修正を反映させたいときは、いったんアプリを閉じて再度立ち上げるか、コマンドパレット(Ctrl + P)でReload app without savingを実行

参考