1. บทนำ
Apps Script CLI หรือ clasp
เป็นเครื่องมือที่ช่วยให้คุณสร้าง แก้ไข และทำให้โปรเจ็กต์ Apps Script ใช้งานได้ในเครื่อง ซึ่งช่วยให้คุณสร้างและเผยแพร่เว็บแอปและส่วนเสริมสำหรับผลิตภัณฑ์อย่างเช่นชีต เอกสาร ฟอร์ม และสไลด์จากบรรทัดคำสั่งได้ คุณพัฒนา Apps Script ได้โดยใช้ Script.google.com หรือในเครื่องคอมพิวเตอร์ เราจะเรียนรู้ในภายหลังถึงวิธีใช้ clasp
ซึ่งเป็นเครื่องมือบรรทัดคำสั่งสำหรับ Apps Script
ฟีเจอร์
- พัฒนาในเครื่อง
clasp
ให้คุณเขียนโค้ดในคอมพิวเตอร์ของคุณเองและอัปโหลดไปยัง Apps Script เมื่อดำเนินการเสร็จ นอกจากนี้ คุณยังดาวน์โหลดโปรเจ็กต์ Apps Script ที่มีอยู่ แล้วแก้ไขในเครื่องได้ด้วย เมื่อโค้ดอยู่ในเครื่องแล้ว คุณจะใช้เครื่องมือการพัฒนาที่ชอบอย่าง git เพื่อทำงานกับโปรเจ็กต์ Apps Script ได้ - จัดการเวอร์ชันการทำให้ใช้งานได้ สร้าง อัปเดต และดูการทำให้โปรเจ็กต์ใช้งานได้หลายรายการ
- โค้ดโครงสร้าง
clasp
จะแปลงโปรเจ็กต์แบบรวมใน Script.google.com เป็นโฟลเดอร์โดยอัตโนมัติ เช่น
# On script.google.com:
├── tests/slides.gs
└── tests/sheets.gs
# Locally:
├── tests/
│ ├─ slides.gs
│ └─ sheets.gs
สิ่งที่คุณจะได้เรียนรู้
Codelab นี้จะแสดงวิธีทำกิจกรรมหลัก 3 อย่างกับ clasp
- วิธีสร้างโปรเจ็กต์ Apps Script ใหม่
- วิธีโคลน ดึงข้อมูล และผลักดันโปรเจ็กต์ที่มีอยู่
- วิธีจัดการการทำให้สคริปต์ใช้งานได้
2. เริ่มต้นใช้งาน
การดาวน์โหลด CLI
Apps Script CLI (clasp
) จำเป็นต้องมีการติดตั้ง Node.js >= v6.0.0 ติดตั้ง Node.js ที่นี่
เมื่อมีโหนดแล้ว ให้ติดตั้ง CLI ทั่วโลก (clasp ใช้ชื่อแทน) ดังนี้
npm i @google/clasp -g
3. การเข้าสู่ระบบ
การเข้าสู่ระบบ
มาลองใช้ตะขอเกี่ยวกัน คำสั่งเดียวที่คุณควรจำไว้คือ clasp
clasp
ก่อนที่จะเริ่มใช้เครื่องมือบรรทัดคำสั่ง เราต้องลงชื่อเข้าใช้ ใช้คําสั่งนี้
clasp login
หรือหากใช้ SSH ให้ดำเนินการดังนี้
clasp login --no-localhost
ในขั้นตอนนี้ คุณจะได้รับข้อความแจ้งให้เข้าสู่ระบบ Google โปรเจ็กต์ที่คุณสร้างด้วย CLI จะเชื่อมโยงกับบัญชี Google นี้
4. สร้างโปรเจ็กต์ใหม่
สร้างโปรเจ็กต์แบบสแตนด์อโลน
เริ่มต้นด้วยการสร้างโครงการ Google Apps Script แบบสแตนด์อโลนด้วยคำสั่งต่อไปนี้
mkdir clasp_codelab;
cd clasp_codelab;
clasp create --title "Clasp Codelab" --type standalone;
คุณเพิ่งสร้างโครงการ Apps Script ในโฟลเดอร์ "clasp_codelab"!
(ทางเลือกที่ไม่บังคับ) โคลนโปรเจ็กต์ที่มีอยู่
ลองสร้างสคริปต์ที่ผูกกับคอนเทนเนอร์สำหรับส่วนเสริมของ Google สไลด์
โดยไปที่ slides.google.com และสร้างงานนำเสนอใหม่ เปลี่ยนชื่องานนำเสนอเป็น "clasp Codelab Test" ที่ส่วนหัว ในส่วนเครื่องมือ ให้กดโปรแกรมแก้ไขสคริปต์...
ซึ่งจะเปิดโครงการ Apps Script ที่ script.google.com ในการโคลนโปรเจ็กต์ เราต้องมี Script ID
คุณจะพบรหัสนี้ใน URL โครงการ Apps Script หลังจากวันที่ /projects/
คัดลอกค่าแล้ววางในคำสั่งต่อไปนี้
clasp clone <scriptID>
ผลลัพธ์ควรมีลักษณะเช่นนี้...
ตอนนี้คุณได้ดาวน์โหลดโครงการในไดเรกทอรีปัจจุบันของคุณแล้ว ใช้เครื่องมือแก้ไขที่ต้องการเพื่อดูเนื้อหาของ Code.gs
(ฟังก์ชันว่าง)
5. ดึงและ กำลังพุชไฟล์
แก้ไขโค้ดใน Script.google.com
เมื่อคุณโคลนโปรเจ็กต์ได้แล้ว ต่อไปมาดูวิธีดึงและพุชไฟล์กัน เราจะแนะนำคุณตลอดขั้นตอนการแก้ไขบนระบบคลาวด์ผ่าน script.google.com
และดึงข้อมูลไปยังคอมพิวเตอร์ของคุณ มาเปิดสคริปต์ในระบบคลาวด์กัน:
clasp open
ในตอนนี้เราอยู่ที่เครื่องมือแก้ไขออนไลน์แล้ว เราจะแก้ไขโค้ดทางออนไลน์ ซึ่งเราจะดึงข้อมูลโดยใช้ clasp
ในภายหลัง
หากต้องการสร้างไฟล์ Apps Script ใหม่ ทางด้านซ้ายของตัวแก้ไขถัดจากไฟล์ ให้คลิกเพิ่มไฟล์ > สคริปต์ ป้อนชื่อ utils/strings
ในไฟล์ที่สร้างขึ้นใหม่ utils/strings.gs
ให้แทนที่โค้ดด้วยข้อมูลต่อไปนี้:
var world = "世界";
ใน Code.gs
ให้แทนที่โค้ดที่มีอยู่ด้วยโค้ดต่อไปนี้
function hello() {
Logger.log("Hello, " + world);
}
คลิกบันทึก ที่ด้านบน
หากต้องการเรียกใช้ฟังก์ชัน ให้เลือก hello
จากรายการฟังก์ชันแบบเลื่อนลงที่ด้านบนของเครื่องมือแก้ไข แล้วคลิกเรียกใช้
โดยคำทักทายจะปรากฏที่ด้านล่างในบันทึกการดำเนินการ
แก้ไขโค้ดในเครื่อง
ลองกลับไปที่บรรทัดคำสั่งที่เราโคลนโปรเจ็กต์ครั้งล่าสุด คุณอาจสังเกตเห็นว่าโค้ดของเราไม่ซิงค์กับเครื่องมือแก้ไขออนไลน์แล้วในตอนนี้ ในการแก้ไข เราจะดึงโค้ดจากโปรเจ็กต์ออนไลน์ของเรา
clasp pull
กลับไปที่โค้ด คุณควรสังเกตเห็นว่ามีโฟลเดอร์สำหรับยูทิลิตีของเรา CLI ของ clasp
จะแปลงเครื่องหมายทับ /
เป็นโฟลเดอร์ในระบบไฟล์ในเครื่องโดยอัตโนมัติ
ในเครื่องมือแก้ไขข้อความที่ชื่นชอบ ให้ไปที่ util/strings.gs
แล้วแทนที่ชื่อตัวแปร world
เป็น mondo
นอกจากนี้ ให้อัปเดต Code.gs โดยแทนที่ world
เป็น mondo
หากต้องการอัปเดตโค้ดที่อัปเดตบน script.google.com
ให้ป้อนโค้ดที่แก้ไขแล้ว
clasp push
เพียงเท่านี้ก็เรียบร้อยแล้ว รหัสของคุณได้รับการอัปเดตใน script.google.com
แล้ว
6. การกำหนดเวอร์ชันและการทำให้ใช้งานได้
clasp
ช่วยให้คุณจัดการเวอร์ชันและการทำให้ใช้งานได้ อย่างแรกคือคำศัพท์ส่วนหนึ่ง:
- เวอร์ชัน: "สแนปชอต" ของโครงการสคริปต์ ระบบจะถือว่าเวอร์ชันเป็น Branch แบบอ่านอย่างเดียวที่ใช้ในการทำให้ใช้งานได้
- การทำให้ใช้งานได้: รุ่นที่เผยแพร่ของโปรเจ็กต์สคริปต์ (มักจะเป็นส่วนเสริมหรือเว็บแอป) ต้องระบุหมายเลขเวอร์ชัน
มาสร้างสคริปต์ในเวอร์ชันต่อไปนี้กัน
clasp version "First version"
เมื่อใช้สตริงเวอร์ชันที่บันทึกซึ่งเราสร้างแทน [version]
เราสามารถทำให้สคริปต์ใช้งานได้:
clasp deploy 1 "First deployment"
คำสั่ง clasp deploy
จะดูไฟล์ Manifest และสร้างการทำให้ใช้งานได้เวอร์ชันใหม่ ทำให้โค้ดของคุณใช้งานได้เป็นไฟล์ปฏิบัติการแล้ว ดูข้อมูลเพิ่มเติมเกี่ยวกับเรื่องนี้ในคู่มือการติดตั้งใช้งาน
7. เท่านี้ก็เรียบร้อย
เราหวังว่า Apps Script CLI จะเป็นเครื่องมือที่ใช้งานง่ายเพื่อช่วยคุณจัดการโครงการ Apps Script
สรุปประเด็นที่ได้พูดถึง
- วิธีสร้างโปรเจ็กต์ Apps Script ใหม่
- วิธีโคลน พุช และดึงโปรเจ็กต์ที่มีอยู่
- วิธีจัดการการทำให้สคริปต์ใช้งานได้
Clasp พร้อมให้บริการบน GitHub และเรายินดีอย่างยิ่งที่จะได้ใช้ฟีเจอร์และแพตช์ใหม่ๆ
เราจะตั้งตารอดูผลงานของคุณ