クイックスタート
TypeScript のプラグインをビルドして開発者モードで読み込む
Node.js 24 と pnpm 12.15.0 を用意し、テンプレートをコピーまたはフォークします。
git clone https://github.com/yuma-shin/notyra-plugins-template.git my-plugin
cd my-plugin
pnpm install
pnpm rename my-plugin "My Plugin"
pnpm install
pnpm typecheck
pnpm build
pnpm testリネーム後の pnpm install はロックファイルのパッケージ名を更新します。テンプレートは文字数パネル、ノート通知、設定、CSS、ツールバーボタン、Mod-Alt-1 の先頭行移動を実装しています。キーバインドが組み込みや先に読み込まれたプラグインと競合すると、設定画面に競合が表示され、そのキーでは実行できません。
開発者モード
- Notyra の 設定 → プラグイン を開き、注意事項を確認します。
- 開発者モードを有効にし、上でビルドしたプロジェクトフォルダを選択します。
- 表示される名前・取得元・Permission・通信先を確認して同意します。権限0件の場合も同意は必要です。
- メインウィンドウのサイドパネルを開き、文字数を表示します。ノートを切り替えたり編集すると更新されます。
- コード変更後に
pnpm buildを実行し、プラグインの「再読み込み」を押します。開発者モードは自動監視ではありません。
開発フォルダは読み取りに使われます。Notyra はそのフォルダを変更・削除しません。開発者モードをオフにすると開発プラグインは停止し、設定を戻すまで読み込まれません。再読み込みで Permission や通信先を追加すると再同意が必要になり、キャンセルした場合は停止したまま同意待ちになります。
ビルドの仕組み
scripts/build.mjs は src/index.ts をブラウザー用 ESM の dist/index.js にビルドします。@notyra/plugin-api はバンドルせず、現在の package.json の name を使う /<Plugin_ID>/@notyra/api.js へ変換します。React・CodeMirror も /@shared/ の仮想モジュールに変換し、アプリと同じインスタンスを使います。
@notyra/plugin-api の型定義は独立リポジトリから取得します。初回 npm 公開前のテンプレートは固定コミットの tarball を参照しているため、そのままインストールできます。npm 公開後は API と同じ3.1.7の完全固定バージョンへ切り替えます。型だけの import には import type を使ってください。
import { notyra } from '@notyra/plugin-api'
import type { Disposable, NotyraPluginApi } from '@notyra/plugin-api'実行時 API はホストの仮想モジュールから取得します。型パッケージの通常の JS エントリを直接実行すると、ビルド設定の誤りを知らせるエラーになります。