GoogleAppsScript

claspを使用しGoogleAppsScriptをGitで管理してみた

  /

どうも、cocomaruです。

GoogleAppsScriptプロジェクトのファイルを、Google公式のCLIツール「clasp」を使って開発するやり方を紹介していきます。

このツールを使用した経緯

今回、このツールを使用した経緯としては、GoogleAppsScriptはクラウド上でソース管理されてますが、

  • やっぱりソースは自分の好きなエディタで開発したいな
  • Gitでバージョン管理したい

という思いから、調査する形となりました。

claspを使うと何がいいか

GoogleAppScriptsプロジェクトをコマンドラインから操作できるツールで、こちらを使用することによりローカル環境で開発できるようになります。

まずはインストールしよう

詳しい説明はこちらを見ていただくとして、まずはインストールしていきましょう。

clapsインストール

npmコマンドでインストールします。
v4.7.4.バージョン以降のNode.jsが必要。

$ npm install @google/clasp -g

プロジェクトにログインしてみよう

次にGoogleAppsScriptプロジェクトへログインします。

GoogleAppsScriptのAPIをONに設定する

claspから操作を許可するために、設定画面で、APIをONをしてください。

claspでログインする

設定をON(有効）としたら、次はログインします。

$ clasp login

実行後、ブラウザが立ち上がるので、 自身のGoogleアカウントでログインしてください
ちなみにログアウトは「clasp logout」でログアウトされます。

プロジェクトを作成してみよう

claspコマンドでプロジェクトを作成

ではプロジェクトを作成してみましょう。

# デスクトップ上にテスト用のディレクトリを作成し移動 
$ mkdir ~/Desktop/testGasProject
$ cd ~/Desktop/testGasProject

# GoogleAppsScriptプロジェクト作成 
$ clasp create "testGasProject"
Created new script: https://script.google.com/d/1yj_RdwN7LD2hfn_e_Sq2r_1mJ_TUqp35JHLBpze5n5JlG_k2RD71d3gN/edit
Cloned 1 file.
└─ appsscript.json

作成されたら、Googleドライブ上にプロジェクトが作成されているか確認してみましょう。

既存のGoogleAppsScriptプロジェクトをclaspで管理する

既存にGoogleAppsScriptプロジェクトが作成されている場合は
プロジェクトのメニューから
「ファイル　＞　プロジェクトのプロパティ　＞　情報」
に記載されている「スクリプトID項目の値」をコピーします。

コピーしたあとは以下コマンドでクローンします。

$ clasp clone　<スクロプトID>
Cloned 2 files.
└─ appsscript.json
└─ Code.js

上記の様に表示されたら、クローンは完了です。

gitで管理してみよう

あとはGitで管理できるように以下の手順でコマンドを実行してください。

# リポジトリ作成 
$ git init

# ファーストコミット 
$ git commit -a -m "first commit"

# リモートリポジトリを追加 
$ git remote add origin "リモートリポジトリのパス"

# コンテンツ反映 
$ git push -u origin master

以上になります。

clasp GoogleAppsScript
RELATED POST