claspとは
claspとはGoogleが提供するGoogle Apps Script(以下GAS)をローカルで編集およびオンライン上に反映できるようにするCLIツール。
既存のApps ScriptエディタはVS Codeで編集するのに比べると使い勝手が悪くコードのバージョン管理もできないため、GASのコードを書くのであればclaspを使用したほうが良い。
claspの開発環境構築手順
まず以下のコマンドでclaspをインストールする。
sudo npm i @google/clasp -g
インストールが完了したら以下のコマンドでフォルダやpackage.jsonなどを作成する。(フォルダ名は任意)
mkdir gas; cd gas; npm init -y; npm i -D @types/google-apps-script
次にclasp loginを実行してログインする。
clasp login
ログインしたらclasp createを実行してGoogleスプレッドシートでGASを使用する場合はsheetsを選択する。
clasp create ? Create which script? standalone docs ❯ sheets slides forms webapp api
sheets選択後にスプレッドシートとGASのURLが表示されるので、あとはフォルダ内にhello.jsなどの適当なファイルを作成したあと、clasp pushを実行すればファイルをサーバー側に反映できる。
hello.jsはpush後はサーバー上ではhello.gsとなる。
clasp push
修正するたびにclasp pushを実行するのは面倒なので--watchを付けて自動的にプッシュされるようにすると便利。
clasp push --watch
逆にApps Scriptエディタ上で編集したものをローカルにダウンロードする場合はclasp pullを実行する。