zackey推し

プログラミングとか色々書いてきます

【学習記録】claspのインストールからデプロイまで

Rosso Advent Calendar 2018 - Qiita
8日目の記事です。

はじめに

ひょんなことでgoogle/claspというGASのCLIツールを知り、GASをコード補完&Git管理できるようにしたい!というモチベーションから、少し触ってみました。

本記事は、google/claspのインストール〜 GASとしてデプロイまでを試した以下リポジトリの学習記録になります。

github.com

google/claspについての深掘りまではしていませんので、
ご了承ください。m(_ _)m

参考記事

以下の記事を参考にさせていただきました。
ありがとうございました。

では本題へ。

手順

インストール・ログイン

# インストール
yarn add global @google/clasp
# npm i @google/clasp -g

# ログイン
clasp login
# この後、Googleアカウントのパスワードを入力

ログイン後、ブラウザの新規タブが開き、
claspからの操作の許可を求められるので許可します。

Google Apps Script APIの有効化

以下からGoogle App Script APIの有効化を行います。
Apps Script – Google Apps Script

アプリの作成・デプロイ

# 作成
clasp create app-name

GAS用のフォルダを作成済みの場合はclasp create .でもおkです。

今回テスト用に以下のソースコードを作成します。

src/sample.js

// @ts-nocheck
function echoMessage(msg) {
  Logger.log(msg);
}

function main() {
  ["hello", "world", "!"].forEach(function (msg) {
    echoMessage(msg);
  });
}

ここまで実装すればデプロイできるのですが、
このままだとnode_modulesなど、
不要なファイルも一緒にデプロイされてしまいます。
(時間がかかる...)

そのため、.claspignoreの作成・設定を行います。

.claspignore

**/**
!src/*.js
!appsscript.json

上記ファイルの作成が終わったらデプロイ実施、
そのままデプロイされているか確認します。

# デプロイ(push)
clasp push

# デプロイが終わったら、ブラウザからGASとして出力されているか確認
clasp open

src/sample.gsというファイル名が作成されていたら、
デプロイおkです。

GitHubへのpush

不要なファイルをコミットしないよう、
.gitignoreを作成・設定します。

.gitignore

node_modules/
.vscode/
.clasp.json

VSCode使わない方は.vscode/は不要になります。
これであとはコミットと自分のリポジトリへpushするだけでおkです。
お疲れ様でした。

# 念のため初期化〜コミット
git init
git add -A
git commit -m "{なにかコメントを}"

# push
git push

ファイルの説明

.clasp.json

{"scriptId":""}

clasp createした際に作成されます。
キーが格納されているため、誤ってGitHubに公開しないよう、
.gitignoreに追記しておくこと。

最後に

以下の記事を参考に、TypeScriptで書くのも良さそう。
てか、TSの方が良いだろうな...