claspとは
Google Apps Scriptをローカルで開発・編集するためのCLIツール。
なぜclaspを使うのか
- gitなどでソースコードのバージョン管理をできるようにするため
- TypeScriptでコードを書けるようにするため
- webpackなどでモジュールを使えるようにするため
- 使い慣れたエディタでコードの編集ができるようにするため
claspのインストール
CLIのインストール
npm i @google/clasp -g
Google Apps Script APIの有効化
https://script.google.com/home/usersettings からGoogle Apps Scriptを有効にする
ログイン
clasp login
を実行して、Googleアカウントにログインする。
既存のスクリプトをローカルで編集してみる
スクリプトのIDを調べる
https://script.google.com/home を開いて、cloneしたいスクリプトを開く。開かれたURL(https://script.google.com/home/projects/<スクリプトID>)からスクリプトIDを調べる。
cloneする
mkdir housework-logger #clone先のローカルディレクトリを作る
cd housework-logger
clasp clone <スクリプトID>
cloneするとファイル一式がローカルにダウンロードされる。これらのファイルを適宜gitなどに登録して管理する。
スクリプトの編集
clone先ディレクトリ内でファイルを編集してみる
スクリプトのアップロード
clasp push
pushすると、ローカルディレクトリ内のファイルがサーバーにアップロードされる。アップロードされるだけでデプロイはされないので注意。なお、ウェブ上のエディタで編集したものをローカルにダウンロードしたい時はpullする。
確認
clasp open
openすると、ブラウザが立ち上がりそのスクリプトをウェブ上のエディタで確認できる。
なお、clasp pushでスクリプトをアップロードしても、ブラウザ上のエディタでは手動でリロードをしないと変更を確認できないので注意。(自動リロード機能がないため)
ここまででできるようになったことと次に試すこと
Google Apps Scriptのファイルをローカルで編集できるようになった。gitでバージョン管理ができるようになり、同時に使い慣れたエディタでの編集ができるようになった。
次の投稿では、スクリプトをTypeScriptで書けるようにしてみる。
claspを使ってGoogle Apps Scriptをローカルで開発・編集する その2 - TypeScriptを使う