Apps Script エディタではなくターミナルから Apps Script プロジェクトを開発して管理するには、clasp
というオープンソース ツールを使用します。
clasp
Codelab では、すべての clasp
機能の概要を確認できます。
機能
ローカルで開発する
clasp
を使用すると、Apps Script プロジェクトをローカルで開発できます。自分のコンピュータでコードを記述し、完了したら Apps Script にアップロードできます。既存の Apps Script プロジェクトをダウンロードして、オフラインでも編集できるようにすることもできます。コードはローカルであるため、Apps Script プロジェクトをビルドするときに、git
などのお好みの開発ツールを使用できます。
デプロイメントのバージョンを管理する
プロジェクトの複数のデプロイメントを作成、更新、表示します。
構造コード
clasp
を使用すると、コードをディレクトリに整理できます。script.google.com にアップロードすると、ディレクトリは保持されます。次に例を示します。
# On script.google.com: ├── tests/slides.gs └── tests/sheets.gs # Locally: ├── tests/ │ ├─ slides.gs │ └─ sheets.gs
要件
clasp
は Node.js で記述され、npm
ツールを介して配布されます。clasp
を使用する前に、Node.js バージョン 4.7.4 以降をインストールしておく必要があります。Node.js をインストールするには、管理者権限が必要です。
インストール
Node.js をインストールしたら、次の npm
コマンドを使用して clasp
をインストールできます。
npm install @google/clasp -g
インストール後、パソコンの任意のディレクトリから clasp
コマンドを使用できます。
clasp
の使用
clasp
を使用すると、コマンドラインからさまざまなタスクを処理できます。このセクションでは、clasp
を使用して開発する際に使用できる一般的なオペレーションについて説明します。
ログイン
このコマンドは、ログインして Google アカウントの Apps Script プロジェクトの管理を承認します。実行すると、Apps Script プロジェクトが保存されている Google アカウントにログインするよう求められます。
clasp login
ログアウト
このコマンドは、コマンドライン ツールからログアウトします。clasp
を引き続き使用する前に、clasp login
を使用して再認証して Google で再認証する必要があります。
clasp logout
新しい Apps Script プロジェクトを作成する
このコマンドにより、オプションのスクリプト タイトルを持つ新しいスクリプトが現在のディレクトリに作成されます。
clasp create [scriptTitle]
このコマンドを実行すると、現在のディレクトリに次の 2 つのファイルも作成されます。
- スクリプト ID が格納された
.clasp.json
ファイル。 - プロジェクト メタデータを含む
appsscript.json
プロジェクト マニフェスト ファイル。
既存のプロジェクトのクローンを作成する
このコマンドは、現在のディレクトリに既存のプロジェクトのクローンを作成します。スクリプトを作成するか、Google アカウントと共有する必要があります。スクリプト ID を指定して、クローンを作成するスクリプト プロジェクトを指定します。
プロジェクトのスクリプト ID を確認する手順は次のとおりです。
- Apps Script プロジェクトを開きます。
- 左側にある [プロジェクトの設定] をクリックします。
[ID] で、スクリプト ID をコピーします。
clasp clone <scriptId>
スクリプト プロジェクトをダウンロードする
このコマンドを実行すると、Apps Script プロジェクトが Google ドライブからパソコンのファイル システムにダウンロードされます。
clasp pull
スクリプト プロジェクトをアップロードする
このコマンドにより、スクリプト プロジェクトのすべてのファイルがパソコンから Google ドライブにアップロードされます。
clasp push
プロジェクト バージョンを一覧表示する
このコマンドは、スクリプト プロジェクトの各バージョンの番号と説明を一覧表示します。
clasp versions
公開プロジェクトをデプロイする
スクリプト プロジェクトは、ウェブアプリ、アドオン、実行可能ファイルとしてデプロイできます。Deployment は、スクリプト エディタ、プロジェクトのマニフェスト、または clasp
を使用して作成できます。
clasp
を使用してプロジェクトをデプロイするには、まず Apps Script プロジェクトの不変バージョンを作成します。バージョンは、スクリプト プロジェクトの「スナップショット」であり、読み取り専用のブランチ リリースに似ています。
clasp version [description]
このコマンドにより、新しく作成されたバージョン番号が表示されます。この番号を使用して、プロジェクトのインスタンスをデプロイまたはデプロイ解除できます。
clasp deploy [version] [description]
clasp undeploy <deploymentId>
このコマンドは、既存のデプロイを新しいバージョンと説明で更新します。
clasp redeploy <deploymentId> <version> <description>
デプロイのリスト表示
このコマンドは、スクリプト プロジェクトのデプロイ ID、バージョン、説明を一覧表示します。
clasp deployments
Apps Script エディタでプロジェクトを開く
このコマンドにより、Apps Script エディタでスクリプト プロジェクトが開きます。デフォルトのウェブブラウザで、エディタが新しいタブとして起動します。
clasp open
clasp
オープンソース プロジェクトへの貢献
GitHub の clasp
に貢献してください。