Editor API リファレンス

マクロ内からグローバルオブジェクト Editor を通じて利用可能なAPIの一覧です。

1. ログ・コンソール出力

Editor.log(msg)

標準的なログをコンソールに出力します。オブジェクトも渡せます。

Editor.info(msg)

Editor.warn(msg)

Editor.error(msg)

色付きのメッセージを出力します。エラー発生時の通知などに利用します。

Editor.markdown(markdownText) rich_console

コンソールにMarkdown形式でリッチなテキストを出力します。

Editor.setActiveFile(path) file_open

エディタに指定したファイルを開きアクティブにします。

Editor.getActiveContents() editor_read

現在エディタで開いているファイルの全テキストを取得します。

Editor.setActiveContents(text) editor_write

エディタの内容を指定したテキストで上書きします。

Editor.getFiles() stat

ファイル一覧を返します。

Editor.getFolders() stat

ディレクトリ一覧を返します。

Editor.mkdir(path) write

指定したパスのディレクトリを作成します。

Editor.filePutContents(path, content) write

指定したパスにファイルを書き込みます（または新規作成します）。

Editor.query(sql) sql_query

SQliteにクエリを実行し、結果を Promise で返します。

Editor.commit() sql_commit

SQliteの変更をファイルを書き込みます。

Editor.wait(ms)

指定したミリ秒数だけマクロの実行を一時停止します。

// 1秒（1000ミリ秒）待機してから次の処理を実行
await Editor.wait(1000);
Editor.info("1秒経過しました");

Editor.input(message = '入力', type = 'text', data = null) console_input

ユーザーに入力を求めるダイアログを表示し、結果を Promise で返します。

const name = await Editor.input("名前を入力", "text");

type	入力形式 / 挙動
`'text'`	標準的な1行テキスト入力。
`'password'`	入力を伏せ字にするパスワード入力。APIキー等の取得に推奨。
`'multiline'`	複数行のテキスト入力。長文やスクリプトの入力に適しています。
`'button'`	ボタンクリックによる入力。`data` にボタン定義のリストが必要。戻り値は二次元配列の要素の配列の2番目の要素です。 `data` の例： `[['はい', '1'], ['いいえ', '0']]`

Editor.env env

/.macros/.env ファイルに定義された環境変数が格納されたオブジェクトです。