【Clasp】ローカルでGASを書いてみる～スクリプトをGitで管理する～

スクリプトをGitでも管理できるように準備していきます。

なお、以下Git自体は既に端末にインストール済み、
かつGitHubのアカウントも作成済みであると想定して、説明します。

Git管理を始める
ブラウザのエディタでもGit管理する
- 拡張機能をインストール
- Git管理しやすいように設定する
このシリーズについて
- 連載目次
参考
注釈

Git管理を始める

フォルダ構成

現在

ここまで順番通りに設定されている方は、現在下記の状態だと思います。

ローカル開発のフォルダ構成

目標

ルートフォルダでリポジトリを作成して、作業フォルダと同じ階層にGit関係のファイルを作成します。

作業フォルダと同階層にGit関係を置く構成にする

リポジトリの作成

プロジェクトのルート・ディレクトリに移動
```
cd <プロジェクトのルート・ディレクトリ>
```
画像の例では、ルートフォルダに移動します。
```
cd ルート
```
リポジトリを初期化

Git管理を始めます。
```
git init
```

除外ファイルを作成・記入

除外ファイルを作成

.claspignoreと同じ手順で、.gitignoreというファイルを作成します。

なお、.gitignore自体は、基本的にプロジェクトのルートフォルダ以下にあればOKです。

`.git`フォルダ直下に`.gitignore`を作成する

除外ファイルを記入

.claspignoreと同じように、ファイルの更新をGitで追跡しないものを記入しておきます。

JSONファイルを除外

リモートリポジトリをPublicで作成する場合は、JSONファイルもアップロードしてしまうと、スクリプトIDやら色んな情報が全世界に公開されてしまいます。

ちょっと怖いので、基本的には各種設定に使用するJSONファイルを拡張子ごと除外して、appsscript.json等の実行に必要で個人情報を含まないファイルだけを残すことをオススメします。

# 個人情報を含む可能性があるため。
*.json

# スクリプトの実行に必要なため。
!appsscript.json

Google関係のファイルを除外

ドライブファイルストリームを使用していてプロジェクト内にGoogle関係のファイルがある場合、Gitではエラーになります。
こちらもあらかじめ拡張子ごと除外しておきます。

# 拡張子ごと除外
*.gs
*.gscript
*.gsheet
︙

詳しい使い方

その他、書き方は基本的に.claspignoreと同じですが、.gitignoreの詳しい使い方は下記の記事が参考になるかと思います。

.gitignore の書き方 - Qiita

`README.md`を追加

とりあえずタイトルだけ…

「何をするプロジェクトか」が分かるように、とりあえずタイトルだけつけておけばOKです。
初期設定ではルートフォルダの名前が反映されるはずです。

冒頭にバッジを追加

冒頭に下記も書いておくと、「このプロジェクトではClaspを使っています」のしるしになって、他の方がこのプロジェクトを使用する際に準備しやすくなる*1と思います。
あと、「わたしGitHub使ってます！」感が出ます。笑

[![clasp](https://img.shields.io/badge/built%20with-clasp-4285f4.svg)](https://github.com/google/clasp)

サンプル

一旦、記録する

初期設定が完了したら、一旦ここまでの情報を記録しておきます。

# リポジトリ内のファイルを（除外ファイル以外）すべてステージに上げる
git add .

# ステージに上げた編集内容を記録する
git commit -m 'init.'

# リモートリポジトリに接続
git remote add origin <リモートリポジトリの接続用アドレス>

# リモートリポジトリにプッシュする
git push origin main