อินเทอร์เฟซของบรรทัดคําสั่งโดยใช้ Clasp

ในการพัฒนาและจัดการโครงการ Apps Script จากเทอร์มินัลแทนเครื่องมือแก้ไข Apps Script คุณสามารถใช้เครื่องมือโอเพนซอร์สชื่อ clasp

clasp Codelab จะแสดงภาพรวมของฟีเจอร์ 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 เขียนใน 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 สําหรับบัญชี Google ของคุณ เมื่อเรียกใช้แล้ว ระบบจะขอให้คุณลงชื่อเข้าใช้บัญชี Google ที่มีการจัดเก็บโปรเจ็กต์ Apps Script

clasp login

ออกจากระบบ

คําสั่งนี้ออกจากระบบเครื่องมือบรรทัดคําสั่ง คุณต้องเข้าสู่ระบบอีกครั้งโดยใช้ clasp login เพื่อตรวจสอบสิทธิ์กับ Google อีกครั้งก่อนใช้ clasp ต่อ

clasp logout

สร้างโปรเจ็กต์สคริปต์ Apps ใหม่

คําสั่งนี้จะสร้างสคริปต์ใหม่ในไดเรกทอรีปัจจุบัน โดยมีชื่อสคริปต์ที่ไม่บังคับ

clasp create [scriptTitle]

คําสั่งนี้จะสร้างไฟล์ 2 ไฟล์ในไดเรกทอรีปัจจุบันด้วย ได้แก่

  • ไฟล์ .clasp.json ที่เก็บรหัสสคริปต์
  • ไฟล์ Manifest ของโปรเจ็กต์ appsscript.json ที่มีข้อมูลเมตาของโปรเจ็กต์

โคลนโปรเจ็กต์ที่มีอยู่

คําสั่งนี้จะโคลนโปรเจ็กต์ที่มีอยู่ในไดเรกทอรีปัจจุบัน โดยสคริปต์นั้นจะต้องสร้างขึ้นหรือแชร์กับบัญชี Google ของคุณ คุณระบุโปรเจ็กต์สคริปต์ที่จะจําลองโดยระบุรหัสของสคริปต์

หากต้องการค้นหารหัสสคริปต์ของโปรเจ็กต์ ให้ทําตามขั้นตอนต่อไปนี้

  1. เปิดโครงการ Apps Script
  2. คลิกการตั้งค่าโปรเจ็กต์ ทางด้านซ้าย
  3. คัดลอกรหัสสคริปต์ในส่วนรหัส

     clasp clone <scriptId>
    

ดาวน์โหลดโปรเจ็กต์สคริปต์

คําสั่งนี้จะดาวน์โหลดโปรเจ็กต์ Apps Script จาก Google ไดรฟ์ไปยังระบบไฟล์ของคอมพิวเตอร์

clasp pull

อัปโหลดโปรเจ็กต์สคริปต์

คําสั่งนี้จะอัปโหลดไฟล์โครงการสคริปต์ทั้งหมดจากคอมพิวเตอร์ของคุณไปยัง Google ไดรฟ์

clasp push

แสดงรายการเวอร์ชันของโปรเจ็กต์

คําสั่งนี้จะแสดงจํานวนและคําอธิบายของแต่ละเวอร์ชันของโปรเจ็กต์สคริปต์

clasp versions

ทําให้โปรเจ็กต์ที่เผยแพร่แล้วใช้งานได้

คุณสามารถทําให้โปรเจ็กต์สคริปต์ใช้งานได้เป็นเว็บแอป ส่วนเสริม หรือไฟล์ปฏิบัติการ คุณสร้างการทําให้ใช้งานได้ในเครื่องมือแก้ไขสคริปต์ ในโปรเจ็กต์ไฟล์ 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

มีส่วนร่วมในโปรเจ็กต์โอเพนซอร์ส clasp

มีส่วนร่วมใน clasp ใน GitHub