หากต้องการพัฒนาและจัดการโปรเจ็กต์ Google Apps Script จากเทอร์มินัลแทนที่จะใช้โปรแกรมแก้ไข Apps Script ให้ใช้เครื่องมือโอเพนซอร์ส clasp
clasp Codelab จะแสดงภาพรวมของฟีเจอร์ทั้งหมดของ
clasp
ฟีเจอร์
clasp ประกอบด้วยฟีเจอร์ต่อไปนี้
พัฒนาในหน่วย
clasp ช่วยให้คุณพัฒนาโปรเจ็กต์ Apps Script ได้ในเครื่อง เขียนโค้ดในคอมพิวเตอร์ของคุณเองและอัปโหลดไปยัง 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
ประเภทโปรเจ็กต์
คุณใช้ clasp เพื่อจัดการทั้งโปรเจ็กต์สคริปต์แบบสแตนด์อโลนและแบบที่ผูกกับคอนเทนเนอร์ได้
โปรเจ็กต์แบบสแตนด์อโลน
โปรเจ็กต์แบบสแตนด์อโลนจะปรากฏเป็นไฟล์แยกต่างหากใน Google ไดรฟ์ คุณสร้างสคริปต์แบบสแตนด์อโลนใหม่ได้โดยใช้คำสั่ง clasp create
โปรเจ็กต์ที่เชื่อมโยงกับคอนเทนเนอร์
โปรเจ็กต์ที่เชื่อมโยงกับคอนเทนเนอร์จะแนบอยู่กับไฟล์ Google เอกสาร, ชีต, สไลด์ หรือ Google ฟอร์ม
คุณสร้างสคริปต์ที่เชื่อมโยงกับคอนเทนเนอร์ใหม่ซึ่งแนบกับไฟล์ใหม่ได้โดยใช้คำสั่ง clasp create นอกจากนี้ คุณยังแนบสคริปต์ใหม่กับไฟล์ที่มีอยู่ได้
โดยใช้แฟล็ก --parentId
โปรเจ็กต์ประเภทอื่นๆ
clasp ยังรองรับการสร้างสคริปต์สำหรับเว็บแอปและ API ด้วย
ข้อกำหนด
clasp เขียนด้วย Node.js และเผยแพร่โดยใช้
เครื่องมือ npm ก่อนใช้ clasp คุณต้องติดตั้ง Node.js เวอร์ชัน 20.0.0 ขึ้นไป
การติดตั้ง Node.js ต้องมีสิทธิ์ของผู้ดูแลระบบ
การติดตั้ง
เมื่อติดตั้ง Node.js แล้ว ให้ใช้คำสั่ง npm ต่อไปนี้เพื่อติดตั้ง
clasp
npm install @google/clasp -g
หลังจากติดตั้งแล้ว ให้ใช้คำสั่ง clasp จากไดเรกทอรีใดก็ได้ในคอมพิวเตอร์
ใช้ clasp
ใช้ clasp เพื่อจัดการงานต่างๆ จากบรรทัดคำสั่ง ส่วนนี้
จะอธิบายการดำเนินการทั่วไปที่ใช้เมื่อพัฒนาด้วย clasp
เข้าสู่ระบบ
คำสั่งนี้จะเข้าสู่ระบบและให้สิทธิ์การจัดการโปรเจ็กต์ Apps Script ของบัญชี Google เมื่อเรียกใช้แล้ว ระบบจะขอให้คุณลงชื่อเข้าใช้บัญชี Google ที่เก็บโปรเจ็กต์ Apps Script ของคุณ
clasp login
ออกจากระบบ
คำสั่งนี้จะออกจากระบบเครื่องมือบรรทัดคำสั่ง ลงชื่อเข้าใช้อีกครั้งโดยใช้ clasp login เพื่อ
ตรวจสอบสิทธิ์กับ Google อีกครั้งก่อนที่จะใช้ clasp ต่อไป
clasp logout
สร้างโปรเจ็กต์ Apps Script ใหม่
คำสั่งนี้จะสร้างสคริปต์ใหม่ในไดเรกทอรีปัจจุบันโดยมี ชื่อสคริปต์เป็นตัวเลือก
clasp create [scriptTitle] [--type <projectType>] [--parentId <parentId>]
คำสั่งนี้ใช้พารามิเตอร์ที่ไม่บังคับต่อไปนี้
scriptTitle: ชื่อโปรเจ็กต์สคริปต์--type <projectType>: ประเภทโปรเจ็กต์ที่จะสร้าง ค่าที่อนุญาตคือstandalone,docs,sheets,slides,forms,webappและapi--parentId <parentId>: รหัสของไฟล์ Google ไดรฟ์ที่มีอยู่ (เอกสาร, ชีต, สไลด์ หรือ ฟอร์ม) ที่ควรเชื่อมโยงโปรเจ็กต์สคริปต์ใหม่
คำสั่งนี้จะสร้างไฟล์ 2 ไฟล์ในไดเรกทอรีปัจจุบันด้วย
.clasp.jsonไฟล์ที่จัดเก็บรหัสสคริปต์appsscript.jsonไฟล์ Manifest ของโปรเจ็กต์ที่มีข้อมูลเมตาของโปรเจ็กต์
โคลนโปรเจ็กต์ที่มีอยู่
คำสั่งนี้จะโคลนโปรเจ็กต์ที่มีอยู่ในไดเรกทอรีปัจจุบัน สคริปต์ ต้องสร้างหรือแชร์กับบัญชี Google ของคุณ คุณระบุโปรเจ็กต์สคริปต์ ที่จะโคลนได้โดยระบุรหัสสคริปต์ คุณสามารถโคลนทั้งโปรเจ็กต์แบบสแตนด์อโลนและโปรเจ็กต์ที่เชื่อมโยงกับคอนเทนเนอร์
วิธีค้นหารหัสสคริปต์ของโปรเจ็กต์
- เปิดโปรเจ็กต์ Apps Script
- คลิกการตั้งค่าโปรเจ็กต์ ทางด้านซ้าย
คัดลอกรหัสสคริปต์ในส่วนรหัส
clasp clone
ดาวน์โหลดโปรเจ็กต์สคริปต์
คำสั่งนี้จะดาวน์โหลดโปรเจ็กต์ Apps Script จาก Google ไดรฟ์ไปยังระบบไฟล์ของคอมพิวเตอร์
clasp pull
อัปโหลดโปรเจ็กต์สคริปต์
คำสั่งนี้จะอัปโหลดไฟล์ทั้งหมดของโปรเจ็กต์สคริปต์จากคอมพิวเตอร์ไปยังไดรฟ์
clasp push
แสดงรายการเวอร์ชันของโปรเจ็กต์
คำสั่งนี้จะแสดงหมายเลขและคำอธิบายของแต่ละเวอร์ชันของโปรเจ็กต์สคริปต์
clasp versions
ติดตั้งใช้งานโปรเจ็กต์ที่เผยแพร่แล้ว
ใช้โปรเจ็กต์สคริปต์เป็นเว็บแอป ส่วนเสริมของ Google Workspace หรือไฟล์ที่เรียกใช้งานได้ สร้างการติดตั้งใช้งานในตัวแก้ไขสคริปต์ ในไฟล์ Manifest ของโปรเจ็กต์ หรือใช้ clasp
หากต้องการติดตั้งใช้งานโปรเจ็กต์ด้วย clasp ให้สร้างโปรเจ็กต์ Apps Script เวอร์ชันที่แก้ไขไม่ได้ก่อน เวอร์ชันคือ "สแนปชอต" ของโปรเจ็กต์สคริปต์
และคล้ายกับการเผยแพร่แบบแยกสาขาแบบอ่านอย่างเดียว
clasp version [description]
คำสั่งนี้จะแสดงหมายเลขเวอร์ชันที่สร้างขึ้นใหม่ ใช้หมายเลขดังกล่าวเพื่อ ติดตั้งใช้งานและเลิกใช้งานอินสแตนซ์ของโปรเจ็กต์
clasp deploy [version] [description]
clasp undeploy <deploymentId>
คำสั่งนี้จะอัปเดตการติดตั้งใช้งานที่มีอยู่ด้วยเวอร์ชันและคำอธิบายใหม่
clasp redeploy <deploymentId> <version> <description>
แสดงรายการการทำให้ใช้งานได้
คำสั่งนี้จะแสดงรหัสการติดตั้งใช้งาน เวอร์ชัน และคำอธิบายของโปรเจ็กต์สคริปต์
clasp deployments
เปิดโปรเจ็กต์ในเครื่องมือแก้ไข Apps Script
คำสั่งนี้จะเปิดโปรเจ็กต์สคริปต์ในตัวแก้ไข Apps Script โดยเครื่องมือแก้ไขจะเปิดเป็นแท็บใหม่ในเว็บเบราว์เซอร์เริ่มต้น
clasp open-script
มีส่วนร่วมในclaspโปรเจ็กต์โอเพนซอร์ส
ร่วมสร้างสรรค์ clasp ใน GitHub