ExtendScript Toolkit(ESTK)でコードを書く際に、コードを自動で整形したい場面があります。
その際に役立つのが、JavaScriptの整形ライブラリ「beautify.js」を利用した自動整形機能の追加です。
ここでは旧Windows環境での設定を紹介します。
本文の#include 1行だけではメニューは作れず、参考元のメニュー登録処理が必要です。
今回、旧配布ZIPの内容、ESTKへの導入、整形結果は実機で検証していません。
Step1:beautify.js をダウンロード
旧記事ではESTKで利用できるbeautify.jsとして次のZIPを紹介していました。
最新版が一律に動作しないと今回検証したわけではありません。
js-beautifyの配布元の版と、ESTKが解釈できる構文・読み込み形式を照合する必要があります。
http://age.s22.xrea.com/tool/EmEditor-beautify.zip
このZIPの現在の入手可否と内容は未確認です。
取得できた場合も、ライブラリの版と利用条件を確認してから配置します。
既存のライブラリを無条件に上書きしないでください。
配置例:D:\Adobe\estk\beautify.js
Step2:ESTKのメニューに「整形」機能を追加する
ESTKのメニューバーに整形コマンドを追加するため、メニュー登録用のスクリプト(ToolMenu.jsx)を作成します。
参考元記事は次のとおりです。
メニュー用JSXの設定
参考元の記事には、ESTKの編集内容へアクセスし、メニューと選択時の処理を登録するコードがあります。
以下はその中のライブラリ読み込み行だけの例です。
ToolMenu.jsxの全文ではないため、この1行だけを保存しても「整形」は追加されません。
参考元のコード全体と対応ライブラリを確認し、読み込みパスを実際の配置先へ合わせます。
#include "D:\\Adobe\\estk\\beautify.js"スクリプト内のパス区切り文字は、エスケープして 2重(\\) で記述します。
Step3:ToolMenu.jsx を所定のフォルダに設置
メニュー登録を含むToolMenu.jsxを別の場所へ保存し、まず手動実行で試します。
起動時の自動読込を使う場合の旧Windows配置例は次のとおりです。
既存の同名ファイルをバックアップし、ESTKを終了してから配置します。
C:\Program Files (x86)\Adobe\Adobe ExtendScript Toolkit CC\Required\参考元ではRequiredへの配置で起動時に読み込む方法が説明されています。
メニュー登録処理とライブラリが揃うことが前提です。
起動時にエラーが出る場合は、ESTKを終了し、今回追加したToolMenu.jsxをRequiredの外へ戻して切り分けます。
Step4:コードを自動整形する
設定を試すときは、元ファイルを複製してから「ツール > 整形」を実行します。
参考元の処理は選択範囲があればその部分、なければ文書全体を書き換えるため、整形対象を先に確認します。
選択する場合は、開始の波括弧だけを含めるなどコードを途中で切らず、対応する括弧まで含むまとまりを選んでください。
参考元の処理は、#targetや#includeなどの指示行の先頭を//@形式へ変換します。
この変換自体と、意図しない内容の変更を区別して差分を確認してください。
文字列・正規表現の内容も確認します。
ExtendScript固有の三重引用符やXMLリテラルも確認対象です。
下のGIFは旧記事の掲載資料で、今回の実行確認ではありません。

Photoshop関連の操作手順は、以下の記事でも解説しています。

ExtendScriptの開発環境は、ほかにも書いています。




まとめ
Visual Studio Codeなどのモダンエディタにはコード整形機能が標準または拡張機能として備わっています。
ESTKを継続利用する旧環境では、メニュー登録コードとライブラリを組み合わせて整形を試せます。
整形は正しい動作を保証する処理ではありません。
原本を残し、差分確認と対象アプリでの動作確認を別々に行ってください。
よくある質問:ESTKにコード自動整形機能を追加する
ExtendScript Toolkit(ESTK)に、コードの自動整形機能を追加できますか?
旧環境でメニュー登録コードとbeautify.jsを組み合わせる方法です。
本文の#include 1行だけでは機能を追加できません。
今回の導入・実行確認は未実施です。
どんな場面で使う方法ですか?
ESTKを継続利用する旧Windows環境向けの参考です。
元ファイルの複製で試し、整形前後の差分を確認します。
整形が成功してもコードの動作保証にはなりません。
最新のbeautify.jsを、そのまま使えますか?
ライブラリの版と構文、読み込み形式をESTKとの組み合わせで確認する必要があります。
最新版の一律非対応は今回検証していません。
旧ZIPの現在の内容と入手可否も未確認です。
メニューに「整形」を追加するには、どうしますか?
参考元にあるメニュー登録・編集内容の取得・整形処理が必要です。
本文は読み込みパスだけの抜粋なので、この1行だけをToolMenu.jsxとして保存してもメニューは追加されません。
ToolMenu.jsxは、どこに置きますか?
旧Windows例はESTKのRequiredフォルダーです。
まず別の場所で保存・手動実行して確認し、配置する場合は既存ファイルをバックアップします。
起動エラー時は今回追加したファイルを外へ戻してください。
整形は、どうやって実行しますか?
メニュー登録が成功した環境で「ツール > 整形」を選びます。
選択範囲の有無で対象が変わるため、原本の複製で試し、指示行・文字列・正規表現などの差分を確認します。
この方法は、macOSでも使えますか?
掲載パスはWindows用で、Macの手順は未検証です。
ESTKは32bitアプリのためmacOS Catalina 10.15以降では起動できません。
