GASをCursor等のエディタで開発、Git管理する方法

この記事では、Google Apps Script (GAS) プロジェクトをローカル環境で開発し、Gitでバージョン管理するための手順を紹介します。
従来、GASの開発はGoogle Apps Scriptのエディタ上で行う必要がありましたが、claspを使うことで、使い慣れたローカルの開発環境でGASのコードを記述し、Gitなどのバージョン管理システムと連携させることが可能になります。

claspとは？

claspは、コマンドラインツールでGASプロジェクトをローカル環境で開発、管理できるようにするツールです。

公式👇

clasp導入のメリット

• Gitによるバージョン管理: Gitなどのバージョン管理システムを利用することで、コードの変更履歴を管理し、過去のバージョンに戻したり、複数人で共同開発したりすることが容易になります。

• ローカル開発環境: 使い慣れたエディタや開発ツール（VSCodeなど）を使用することで、コーディングの効率が向上し、開発体験を向上させることができます。

• CI/CD連携: claspとCI/CDツールを連携させることで、自動テストや自動デプロイなどのワークフローを構築できます。

claspの導入手順

Node.jsをインストール

コマンドライン（ターミナル等）で下記を実行してもバージョンが表示されなければNode.jsをインストールしてください。

npm --version

Node.jsのインストール方法はこちらを参照してください。

• Windows👇

Windows への Node.js（npm）のインストール - Qiita

• Mac👇

macOS に Node.js (npm) をインストールする方法 - Qiita

GASのAPI設定をONにする

• script.google.com/home/usersettings で、Google Apps Script APIを有効にします。

claspをインストール

npm install -g @google/clasp

claspでログイン

clasp login

ローカルでGASプロジェクトを作成またはクローン

• 既存プロジェクトをクローンする場合:

clasp clone <scriptId>

Gitでローカルリポジトリを初期化

git管理したい人は実行してください。GitHubでプロジェクト管理する場合も通常のプロジェクトと同様の流れで管理可能です。

git init 
git add . 
git commit -m "Initial commit"

claspでよく使うコマンド

• `clasp login`: Googleアカウントにログインします。

• `clasp logout`: Googleアカウントからログアウトします。

• `clasp create`: 新しいGASプロジェクトを作成します。

• `clasp clone`: 既存のGASプロジェクトをクローンします。

• `clasp pull`: リモートのGASプロジェクトをローカルに同期します。

• `clasp push`: ローカルの変更をリモートのGASプロジェクトにプッシュします。

• `clasp open`: GASプロジェクトをブラウザで開きます。

• `clasp status`: ローカルとリモートのGASプロジェクトの差分を表示します。

• `clasp logs`: GASプロジェクトのログを表示します。

• `clasp run`: GASプロジェクトの関数をローカルで実行します。

• `clasp apis list`: 使用可能なGoogle APIの一覧を表示します。

• `clasp apis enable`: Google APIを有効にします。

• `clasp apis disable`: Google APIを無効にします。

その他コマンドは公式を参照してください👇

まとめ

claspを使うことで、GASプロジェクトをローカル環境で開発し、Gitでバージョン管理することが可能になります。
使い慣れた開発環境とGitによるバージョン管理を活用することで、GAS開発の効率と安全性を高めることができます。

少しでも参考になればスキ・フォローをしていただければ励みになります。