[Obsidian]Macでプラグイン開発

言語

「自分だけの機能をObsidianに追加したい」と思った時、一番高いハードルは環境構築です。今回は、余計なツールを一切排除し、Node.jsのインストールから、自作コマンドをObsidianのパレットに表示させるまでをステップバイステップで解説します。

STEP 1:Node.jsをインストールする

プラグインを動かすための「エンジン」であるNode.jsをMacに導入します。

  1. ターミナルを起動: Command + Space で「Terminal」と入力して起動。
  2. Homebrewでインストール:(未導入ならこちら)Bashbrew install node
  3. 確認: 以下のコマンドを打ち、数字(バージョン)が出れば成功です。Bashnode -v npm -v

STEP 2:公式スケルトン(型紙)を手に入れる

ゼロから書く必要はありません。公式が用意しているテンプレートをダウンロードします。

  1. フォルダの作成と移動: 開発用のディレクトリを作ります。
    mkdir -p ~/Developer/obsidian-plugins cd ~/Developer/obsidian-plugins
  2. テンプレートをダウンロード
    git clone https://github.com/obsidianmd/obsidian-sample-plugin.git my-plugin cd my-plugin
  3. 依存ライブラリの解凍:
    npm install

STEP 3:開発モードを起動する

コードを書き換えたら即座に反映される「監視モード」でビルドを開始します。

npm run dev

: このコマンドはターミナルを閉じずにそのままにしておいてください。

STEP 4:Obsidianにプラグインを認識させる

ここが一番のポイントです。作成中のフォルダをObsidianが読み込める場所にリンクさせます。

  1. Obsidianのプラグインフォルダを探す:
    • Obsidianを開き、「設定」 > 「コミュニティプラグイン」 > 「インストール済みプラグイン」の横にあるフォルダアイコンをクリックします。
    • Finderが開くので、そのパスを確認します。
  2. シンボリックリンクを貼る(Macの魔法):ターミナルで以下を実行します(パスはご自身の環境に合わせてください)。
    ln -s ~/Developer/obsidian-plugins/my-plugin /Users/あなたのユーザ名/Documents/YourVault/.obsidian/plugins/my-plugin
    これで、コードを編集するたびにObsidian内のプラグインも自動で更新されます。

STEP 5:コマンドパレットでテストする

いよいよ動作確認です。

  1. プラグインの有効化:Obsidianの「設定」 > 「コミュニティプラグイン」を開き、一度「再読み込み」を押してから、「Sample Plugin」をONにします。
  2. コマンドパレットを叩く:Command + P を押し、「Sample Plugin: Open Sample Modal」と入力してみてください。

🎉 成功!

モーダルウィンドウが表示されたら、あなたのMac上でプラグインが正常に動作しています。

まとめ:開発のサイクル

ここからの流れは非常にシンプルです。

  • 書く: main.ts をVS Codeなどのエディタで編集する。
  • 変わる: npm run dev が自動で main.js を生成する。
  • 試す: Obsidianで動作を確認する。

コメント

タイトルとURLをコピーしました