clasp - Apps Script CLI

1. Pengantar

CLI Apps Script, atau clasp, adalah alat yang memungkinkan Anda membuat, mengedit, dan men-deploy project Apps Script secara lokal. Alat ini memungkinkan Anda 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, menggunakan script.google.com atau secara lokal di komputer Anda. Kita akan mempelajari yang terakhir, cara menggunakan clasp, alat command line untuk Apps Script.

Fitur

  • Mengembangkan Secara Lokal. clasp memungkinkan Anda menulis kode di komputer dan menguploadnya ke Apps Script jika sudah selesai. Anda juga dapat mendownload project Apps Script yang sudah ada, lalu mengeditnya secara lokal. Jika kode sudah bersifat lokal, Anda dapat menggunakan alat pengembangan favorit, seperti git untuk mengerjakan project Apps Script.
  • Mengelola Versi Deployment. Buat, update, dan lihat beberapa deployment project Anda.
  • Kode Struktur. clasp secara otomatis mengonversi project datar Anda di script.google.com ke dalam 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 Anda

2. Memulai

Mendownload CLI

CLI Apps Script (clasp) memerlukan penginstalan Node.js >= v6.0.0. Instal Node.js di sini.

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

npm i @google/clasp -g

3. Login

Login

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

clasp

Sebelum kita mulai menggunakan alat baris perintah, kita harus masuk. Jalankan perintah ini:

clasp login

atau jika menggunakan SSH:

clasp login --no-localhost

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

4. Membuat Project Baru

Membuat proyek mandiri

Mulailah dengan membuat project Google Apps Script mandiri menggunakan 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 kita coba membuat skrip container-bound untuk Add-on Google Slide.

Untuk melakukannya, buka slides.google.com dan buat presentasi baru. Ubah nama presentasi menjadi "clasp Codelab Test". Di header, di bagian Tools, tekan Script Editor....

Tindakan ini akan membuka project Apps Script di script.google.com. 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).

5. Menarik & Mengirim File

Edit kode di script.google.com

Setelah Anda dapat meng-clone project, mari kita pelajari cara menarik dan mengirim file. Kami akan memandu Anda melakukan langkah-langkah untuk mengedit di cloud melalui script.google.com dan membukanya secara lokal di komputer Anda. Mari kita buka skripnya di {i>cloud<i}:

clasp open

Setelah berada di editor online, kita akan mengedit beberapa kode secara online yang nantinya akan diambil menggunakan clasp.

Untuk membuat file Apps Script baru, di sebelah kiri editor di samping File, klik Tambahkan file tambahkan file > Skrip. 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 menyelamatkan.

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

Ucapan akan muncul di bagian bawah log eksekusi.

Edit kode secara lokal

Mari kembali ke baris perintah tempat kita meng-clone project terakhir kali. Anda mungkin melihat bahwa kode kita kini tidak sinkron dengan editor online. Untuk memperbaikinya, mari kita ambil kode dari project online kita.

clasp pull

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

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

clasp push

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

6. Pembuatan Versi dan Deployment

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

  • Versi: "Snapshot" dari suatu proyek naskah. 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 kita buat versi skrip kita:

clasp version "First version"

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

clasp deploy 1 "First deployment"

Perintah clasp deploy melihat manifes Anda dan membuat deployment berversi baru. Kode Anda sekarang di-deploy sebagai file yang dapat dieksekusi. Pelajari hal ini lebih lanjut di panduan deployment.

7. 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, mendorong, dan menarik project yang ada
  • Cara mengelola deployment skrip Anda

Clasp tersedia di GitHub dan selamat datang di fitur serta patch baru.

Kami menantikan karya Anda.