メインコンテンツへスキップ
見出し画像

Windows11でGAS開発を効率化するVS Code×clasp 【2. GASプロジェクトの管理編 - クローン・アップロード・ダウンロード】

    はじめに

    前回は、Windows11環境でclaspを使用してVS CodeやCursor 上でGASを開発するため、claspの環境構築方法についてまとめました。

    今回は、構築したclasp環境を用いて、GASプロジェクトのクーロン、ダウンロード、アップロードの方法についてまとめます。

    既存のGASプロジェクトをローカルにクローンする

    既存のGASプロジェクトをローカル環境で編集するためには、対象のGASプロジェクトをローカルにクローンする必要があります。

    スクリプトIDの確認方法

    クローンするには、対象プロジェクトの「スクリプトID」が必要です。スクリプトIDは以下の手順で確認できます。

    1.GASのエディタでプロジェクトを開きます

    画像
    GASエディタ

    2.アドレスバー上のURLをコピーして、メモしておきます。

    スクリプトIDは、

    https://script.google.com/home/projects/xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx/edit

    の中の、xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxの部分となります。

    claspでプロジェクトをクローンする

    スクリプトIDが確認できたら、以下の手順でプロジェクトをローカルへクローンします。

    1.コマンドプロンプトまたはPowerShellを起動します。

    画像
    コマンドプロンプト

    2.プロジェクトを保存したいフォルダに移動します。

    cd "フォルダパス"
    画像
    cdコマンド

    3.以下のコマンドを実行します。

    clasp clone "スクリプトID"

    スクリプトIDの部分には、先ほどメモした該当のスクリプトIDをペーストします。

    コマンドが成功すると、以下のようなメッセージが表示されます。

    画像
    clasp clone

    クローン後のファイル構造

    クローンが完了すると、以下のようなファイル構造が作成されます。

    プロジェクトフォルダ/
    ├── .clasp.json
    ├── appsscript.json
    └── コード.gs

    ファイル構成を見ると、 .clasp.json ファイルが作成されています。このファイルは自動的に作成され、プロジェクトのスクリプトIDやその他の設定情報が含まれています。

    画像
    .clasp.json

    このファイルによって、claspは対象のGASプロジェクトを特定できるようになります。

    ローカルでのプロジェクト編集

    クローンしたプロジェクトは、VS Codeで直接編集することができます。
    今回は一番下の行を追加しました。

    画像
    VS Codeで編集

    修正したコードをWeb上のGASプロジェクトにアップロード

    ローカルでコードを編集した内容は、Web上のGASプロジェクトにアップロードすることができます。VS Codeのターミナルを使って、コマンドを実行します。

    1.メニューバーの「ターミナル」から、「新しいターミナル」を選択します。

    画像
    新しいターミナル
    画像
    ターミナル表示

    2.ターミナル上で、clasp pushコマンドを実行し、修正したコードをGASプロジェクトにアップロードします。

    clasp push

    成功すると、VS Code上のターミナルで、以下のようなメッセージが表示されます。

    画像
    clasp push

    3.ターミナル上で、clasp openコマンドを実行すると、GASプロジェクトをChrome上で開くことができます。

    clasp open
    画像
    clasp open
    画像
    ChromeにてGASプロジェクトが開く

    Webプロジェクトのローカルへのダウンロード

    Web上のGASのエディタで修正を行った内容を、ローカルにダウンロードします。
    今回は、エディタ上で、「Hello, Clasp」「Good bye, Clasp」の「Clasp」部分を、「World」に変更しました。

    画像
    GASエディタでコード編集

    clasp pullコマンドを実行します。

    clasp pull

    成功すると、VS Code上のターミナルで、以下のようなメッセージが表示されます。

    画像
    clasp pull

    ローカル環境で、更新されていることが確認できました。

    なお、このプルコマンドを実行する際には、ローカルのファイルが上書きされるため、保存されていない変更がある場合は注意が必要です。

    ローカル環境のファイルをアップロードしない設定

    ローカル環境だけで参照したいファイルなどがある場合、.claspignoreファイルを使用することで、アップロードしないという設定を行うことができます。

    1.ローカル環境にて、プロジェクトのルートディレクトリに.claspignoreというファイルを作成します。

    2.アップロードから除外するファイル、フォルダ名、もしくはパターンを記載することができます。
    今回は、「除外.js」を対象外として記載しました。

    画像
    .claspignoreファイル

    3.ターミナル上で、clasp pushコマンドを実行します。

    clasp push
    画像
    clasp push

    メッセージを見ると、アップロードされたファイルが2ファイルとなっていることが確認できます。
    .claspignoreファイルに記載したファイルは、アップロードされていないことが確認できました。

    まとめ

    今回は、構築したclasp環境を用いて、GASプロジェクトのクーロン、ダウンロード、アップロードの方法についてまとめました。
    これらのコマンドを活用することで、より効率的にGASを開発することができます。

    次回は、claspを複数のGoogleアカウントを切り替える方法についてまとめていきます。

    参考

    連載目次

    1.Windows11でGAS開発を効率化するVS Code×clasp 【1. 環境構築編】

    2.Windows11でGAS開発を効率化するVS Code×clasp 【2. GASプロジェクトの管理編 - クローン・アップロード・ダウンロード】

    3.Windows11でGAS開発を効率化するVS Code×clasp 【3. clasp loginせずに複数アカウントを切り替える】


     
     
    ノンプロ研にて、Python、GAS(Google Apps Script)、技術ライティング勉強中です。 東北地方の片隅で、オンラインアシスタントとして、リモートワークしています。

    あなたへのおすすめ