FS Editor マクロリファレンス

FS Editorでは、JavaScriptを使用してローカルファイルシステムやエディタの操作を自動化できます。

1. マクロの作成と管理

マクロは特定のディレクトリに配置することで、エディタの「マクロ」タブに自動的にリストアップされます。

• 保存場所: /.macros/ ディレクトリ配下
• ファイル形式: .js (例: hello.js)

2. メタデータ（ヘッダー設定）

マクロファイルの先頭に // 形式のコメントでメタデータを記述し、挙動を設定します。

// Name: マクロの表示名
// Permissions: env stat write editor_read editor_write
// Allow: https://api.example.com/*
// Allow-IgnoreCase: https://cdn.jsdelivr.net/*

/** ここからロジックを記述 */

主要なメタデータ項目

項目	説明
Name	サイドバーに表示される名前。省略時はファイル名になります。
Permissions	マクロに付与する権限。半角スペース区切りで複数指定可能です。
Allow	fetch を許可するURLパターンを指定します。

3. 権限 (Permissions) 一覧

セキュリティのため、特定の操作には権限の宣言が必要です。

• stat: ファイル・フォルダ一覧の取得。
• file_open: 指定したファイルをアクティブにする。
• editor_read / editor_write: 現在のエディタの内容読み書き。
• write: 指定パスへのファイル保存・フォルダ作成。
• sql_query / sql_commit: SQLite操作。
• env: /.macros/.env ファイルの読み取り。
• console_input: コンソールからの入力。
• rich_console: Markdown形式でのコンソール出力。

4. 基本的なAPI

Editor オブジェクトを介してツールを操作します。

// ログ出力
Editor.log("Hello FS Editor!");

// 入力ダイアログを表示（Permissions: console_input が必要）
const name = await Editor.input("名前を入力してください", "text");
Editor.info(`Hello, ${name}!`);

5. 関連リファレンス

• Editor API 詳細 - Editorオブジェクトの全メソッド
• メタデータ詳細 - ヘッダーの詳細な書き方
• マクロサンドボックス - 使用可能なクラス・オブジェクト一覧
• サンプル集 - 実用的なコード集

---

Return to Editor Top