Folra のプラグイン

.folraplug を Folra にインストールできます。開発ガイドを使って自作することもできます。

公式プラグイン

GitHub のリリースを見る

プラグインを作る

プラグインの基本は JSON マニフェストと JavaScript コマンドです。Folra の CLI で作成するか、開発ガイドをコーディングエージェントに渡してください。

選択範囲または文書全体
コマンドが受け取る範囲を選び、文書のチェック、選択範囲の整理、テンプレートの作成ができます。
ネイティブの入力フォーム
プラグインを実行するときに、テキスト欄、プルダウン、スイッチで設定を指定できます。
テキストと編集結果
プラグインが返したテキストをコピーや挿入に使えます。変更案はプレビューで確認してから適用できます。

ワークスペースツールとエディタ拡張

以下の機能には Folra 0.1.16 以降とプラグイン API 4 が必要です。プラグインはサンドボックス内で動作します。

文書、画像、文字認識
ワークスペース内の Markdown 文書や画像の読み取りをリクエストできます。画像の文字認識は Mac 上で行い、ファイルの変更案は適用前に確認できます。
ネイティブツールとショートカット
ネイティブのサイドバーやツールウインドウ、キーボードショートカット、入力補完、独自のコードブロック表示を追加できます。
ネットワークリクエスト
プラグインは接続先の HTTPS ホストを宣言します。送信先とリクエストの内容は、送信するたびに Folra で確認できます。

ZIP を展開し、下の手順でインストールします。プレーンテキストを数行選択し、「プラグイン」メニューの Plain text tools を実行すると、行の並べ替え、重複の削除、接頭辞の追加ができます。

CLI で開発を始める

以下は「アプリケーション」フォルダに Folra がある場合のコマンドです。テンプレートにはすぐに使えるコマンドとテストが含まれています。コマンドを変更したら再テストし、新しいフォルダにパッケージ化します。

folra="/Applications/Folra.app/Contents/MacOS/Folra"
"$folra" plugin scaffold ./MyPlugin --api 2 \
  --id com.example.my-plugin --name "My Plugin" --scope selection
"$folra" plugin validate ./MyPlugin
"$folra" plugin test ./MyPlugin
"$folra" plugin pack ./MyPlugin ./MyPlugin.folraplug

プラグインをインストール

ローカルインストールには Folra 0.1.15 以降が必要です。各プラグインが必要とするバージョンを確認してください。

  1. ダウンロードした ZIP を展開するか、自分で作った .folraplug フォルダを用意します。
  2. Folra で「プラグイン → プラグインを管理… → プラグインをインストール…」を選び、.folraplug フォルダを指定します。
  3. Markdown 文書を開き、「プラグイン」メニューから実行します。