clasp - Apps Script CLI

1. Pengantar

Apps Script CLI, atau clasp, adalah alat yang memungkinkan Anda membuat, mengedit, dan men-deploy project Apps Script secara lokal. Dengan alat ini, Anda dapat membuat dan memublikasikan aplikasi web dan add-on untuk produk seperti Spreadsheet, Dokumen, Formulir, dan Slide dari command line. Ada dua cara untuk mengembangkan Apps Script, yaitu menggunakan script.google.com atau secara lokal di komputer Anda. Kita akan mempelajari yang terakhir, yaitu cara menggunakan clasp, alat command line untuk Apps Script.

Fitur

  • Kembangkan Secara Lokal. clasp memungkinkan Anda menulis kode di komputer sendiri dan menguploadnya ke Apps Script setelah selesai. Anda juga dapat mendownload project Apps Script yang ada, lalu mengeditnya secara lokal. Setelah kode bersifat lokal, Anda dapat menggunakan alat pengembangan favorit seperti git untuk mengerjakan project Apps Script.
  • Mengelola Versi Deployment. Buat, perbarui, dan lihat beberapa deployment project Anda.
  • Struktur Kode. clasp secara otomatis mengonversi project datar Anda di script.google.com menjadi folder. Contoh:
# On script.google.com:
├── tests/slides.gs
└── tests/sheets.gs

# Locally:
├── tests/
│   ├─ slides.gs
│   └─ sheets.gs

Yang akan Anda pelajari

Codelab ini akan menunjukkan cara melakukan 3 aktivitas utama dengan clasp:

  • Cara membuat project Apps Script baru
  • Cara meng-clone, menarik, dan mengirim project yang ada
  • Cara mengelola deployment skrip

2. Memulai

Mendownload CLI

CLI Apps Script (clasp) mengharuskan Node.js diinstal. Instal Node.js di sini.

Setelah Anda memiliki Node, instal CLI secara global (alias clasp):

npm i @google/clasp -g

3. Mengaktifkan Apps Script API

Sebelum dapat menggunakan Clasp, Anda harus mengaktifkan Apps Script API Google di IDE Apps Script.

4. Login

Login

Mari kita coba clasp. Satu-satunya perintah yang harus Anda ingat adalah clasp.

clasp

Sebelum mulai menggunakan alat command line, kita harus login. Jalankan perintah ini:

clasp login

atau jika menggunakan SSH:

clasp login --no-localhost

Pada langkah ini, Anda akan diminta untuk login ke Google. Setiap project yang Anda buat dengan CLI akan dikaitkan dengan Akun Google ini.

5. Membuat Project Baru

Membuat project mandiri

Mulailah dengan membuat project Google Apps Script mandiri dengan perintah berikut:

mkdir clasp_codelab;
cd clasp_codelab;
clasp create --title "Clasp Codelab"  --type standalone;

Anda baru saja membuat Project Apps Script di folder "clasp_codelab".

(Alternatif opsional) Meng-clone project yang ada

Mari coba buat skrip terikat container untuk Add-on Google Slide.

Untuk melakukannya, buka slides.google.com dan buat presentasi baru. Ubah nama presentasi menjadi "clasp Codelab Test". Di panel menu Slide, pada menu Ekstensi, pilih "Apps Script.

Tindakan ini akan membuka project Apps Script Anda di script.google.com.

Buat direktori baru untuk project Anda, lalu cd ke direktori tersebut.

mkdir clasp_codelab_test
cd clasp_codelab_test

Untuk meng-clone project, kita memerlukan Script ID. Anda dapat menemukan ID ini di URL project Apps Script setelah /projects/. Salin nilai dan tempelkan di perintah berikut:

clasp clone <scriptID>

Output-nya akan terlihat seperti ini...

4e3b128f4dcf6467.gif

Sekarang Anda telah mendownload project di direktori saat ini. Gunakan editor favorit Anda untuk melihat konten Code.gs (fungsi kosong).

6. Menarik & Mendorong File

Mengedit kode di script.google.com

Setelah Anda dapat meng-clone project, mari pelajari cara menarik dan mengirim file. Kami akan memandu Anda melakukan langkah-langkah untuk mengedit di cloud melalui script.google.com dan menariknya secara lokal ke komputer Anda. Mari kita buka skrip di cloud:

clasp open-script

Sekarang setelah berada di editor online, kita akan mengedit beberapa kode online yang akan kita ambil nanti menggunakan clasp.

Untuk membuat file Apps Script baru, di sebelah kiri editor di samping Files, klik Tambahkan file menambahkan file > Script. Masukkan nama utils/strings. Di file yang baru dibuat, utils/strings.gs, ganti kode dengan kode berikut:

var world = "世界";

Di Code.gs, ganti kode yang ada dengan kode berikut:

function hello() {
  Logger.log("Hello, " + world);
}

Di bagian atas, klik Simpan simpan.

Untuk menjalankan fungsi, di bagian atas editor, pilih hello dari daftar drop-down fungsi, lalu klik Run.

Ucapan akan muncul di bagian bawah log eksekusi.

Mengedit kode secara lokal

Mari kembali ke command line tempat kita terakhir kali meng-clone project. Anda mungkin melihat bahwa kode kita sekarang tidak sinkron dengan editor online. Untuk memperbaikinya, mari kita tarik kode dari project online kita.

clasp pull

Sekarang kembali ke kode. Anda akan melihat ada folder untuk utilitas kita. CLI clasp otomatis mengonversi karakter garis miring / menjadi folder di sistem file lokal.

Di editor teks favorit Anda, buka util/strings.gs dan ganti nama variabel world menjadi mondo. Selain itu, perbarui Code.gs dengan mengganti world menjadi mondo. Untuk memperbarui kode yang diperbarui di script.google.com, kirim kode yang telah Anda edit.

clasp push

Selesai. Kode Anda kini diperbarui pada script.google.com.

7. Membuat Versi dan Men-deploy

clasp memungkinkan Anda mengelola versi dan deployment. Pertama, beberapa kosakata:

  • Versi: "Snapshot" project skrip. Versi dapat dianggap sebagai cabang hanya baca yang digunakan untuk deployment.
  • Deployment: Rilis project skrip yang dipublikasikan (sering kali sebagai add-on atau aplikasi web). Memerlukan nomor versi.

Mari buat versi skrip kita:

clasp create-version "First version"

Dengan menggunakan string versi yang dicatat yang kita buat sebagai pengganti [version], kita dapat men-deploy skrip:

clasp create-deployment 1 "First deployment"

Perintah clasp deploy akan melihat manifes Anda dan membuat deployment baru yang diberi versi. Kode Anda kini di-deploy sebagai file yang dapat dieksekusi. Pelajari lebih lanjut di panduan deployment.

8. Selesai!

Kami harap CLI Apps Script adalah alat sederhana untuk membantu Anda mengelola project Apps Script.

Yang telah kita bahas

  • Cara membuat project Apps Script baru
  • Cara meng-clone, mengirim, dan menarik project yang ada
  • Cara mengelola deployment skrip

Clasp tersedia di GitHub dan siap menerima fitur dan patch baru.

Kami menantikan karya Anda.