GAS(Google App Script)をVSCodeで編集する

GASをローカル環境で扱えるようにすることで

といったメリットがあります。

claspをインストールする

Google公式のCLIツール「clasp」を導入します。
下記のコマンドを実行するとインストールが始まります。

npm install @google/clasp -g

次のコマンドを実行すると、ブラウザでGoogleアカウントの認証画面が開きます。

clasp login

このタイミングでルート直下に「.clasprc.json」というファイルが生成されます。
※このファイルは後で説明するログアウトのコマンドを実行すると削除されます。

設定画面(https://script.google.com/home/usersettings)からGoogle Apps Script APIをオンにしておきます。

次のコマンドを実行してスプレッドシートを作成します。

clasp create test --type sheets

上がシートへのリンク、下がスクリプトへのリンクとなっています。

今回はテスト用に「test.js」を同じディレクトリ内に作成して、console.logを出力してみます。

JSファイルの記述・保存して、次のコマンドを実行すると、GASに反映されます。

clasp push

次はGAS側でコードを追加したものをローカルに反映します。
次のコマンドを実行すると、ローカルに反映されます。

clasp pull

次のコマンドを実行するとGoogleアカウントからログアウトして、ルート直下に生成された「.clasprc.json」が削除されます。

clasp logout