clasp - Apps Script CLI

1. מבוא

ה-CLI של Apps Script, או clasp, הוא כלי שמאפשר ליצור, לערוך ולפרוס פרויקטים של Apps Script באופן מקומי. הוא מאפשר ליצור ולפרסם אפליקציות אינטרנט ותוספים למוצרים כמו Sheets , Docs , Forms ו-Slides – והכול משורת הפקודה. יש שתי דרכים לפתח 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

כדי להשתמש ב-CLI של Apps Script (clasp), צריך להתקין את Node.js >= v6.0.0. כאן אפשר להתקין את Node.js.

אחרי שמתקינים את Node, מתקינים את ה-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?

כדי לעשות זאת, עוברים אל slides.google.com ויוצרים מצגת חדשה. משנים את שם המצגת ל-"clasp Codelab Test". בכותרת, בקטע כלים, לוחצים על עורך קובצי סקריפט....

הפעולה הזו תפתח את פרויקט Apps Script בכתובת script.google.com. כדי לשכפל פרויקט, אנחנו צריכים את הפרמטר Script ID. המזהה הזה מופיע בכתובת ה-URL של פרויקט Apps Script אחרי /projects/. מעתיקים את הערך ומדביקים אותו בפקודה הבאה:

clasp clone <scriptID>

הפלט אמור להיראות כך...

4e3b128f4dcf6467.gif

עכשיו הורדתם את הפרויקט בספרייה הנוכחית שלכם. עליך להשתמש בעורך המועדף עליך כדי להציג את התוכן של 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 מהרשימה הנפתחת של הפונקציות ולוחצים על Run.

הודעת הפתיחה תופיע בחלק התחתון ביומן הביצוע.

עריכת הקוד באופן מקומי

נחזור לשורת הפקודה שבה שכפולנו בפעם האחרונה את הפרויקט. יכול להיות שתבחינו שהקוד שלנו לא מסונכרן עם העורך הדיגיטלי. כדי לפתור את הבעיה, נשלוף את הקוד מהפרויקט הדיגיטלי שלנו.

clasp pull

עכשיו חוזרים אל הקוד. אתם אמורים לראות שיש תיקייה לכלי העזר שלנו. ה-CLI של clasp ממיר באופן אוטומטי את התו הלוכסן / לתיקיות במערכת הקבצים המקומית.

בכלי לעריכת טקסט המועדף עליך, עוברים אל util/strings.gs ומחליפים את שם המשתנה world ב-mondo. בנוסף, עדכן את ה-Code.gs על ידי החלפת world ב-mondo. כדי לעדכן את הקוד המעודכן בתאריך script.google.com, צריך לדחוף את הקוד הערוך.

clasp push

זה הכול! הקוד שלך מעודכן עכשיו ב-script.google.com.

6. ניהול גרסאות ופריסה

clasp מאפשר לנהל גרסאות ופריסות. קודם כל, כמה אוצר מילים:

  • גרסה: "תמונת מצב" של פרויקט סקריפט. גרסה יכולה להיחשב להסתעפות לקריאה בלבד שמשמשת לפריסות.
  • פריסה: גרסה שפורסמה של פרויקט סקריפט (בדרך כלל כתוסף או כאפליקציית אינטרנט). יש לציין מספר גרסה.

בואו ניצור גרסה של הסקריפט שלנו:

clasp version "First version"

באמצעות מחרוזת הגרסה ביומן שיצרנו במקום [version], אנחנו יכולים לפרוס את הסקריפט:

clasp deploy 1 "First deployment"

הפקודה clasp deploy בוחנת את המניפסט ויוצרת פריסה חדשה עם גרסאות. הקוד שלך נפרס עכשיו כקובץ הפעלה. כדי לקבל מידע נוסף בנושא, אפשר לעיין במדריך הפריסה.

7. זהו!

אנחנו מקווים שה-CLI של Apps Script הוא כלי פשוט שיעזור לכם לנהל פרויקטים ב-Apps Script.

הנושאים שטיפלנו בהם

  • איך יוצרים פרויקטים חדשים ב-Apps Script
  • איך לשכפל, לדחוף ולשלוף פרויקטים קיימים
  • איך לנהל פריסות של הסקריפטים

Clasp זמין ב-GitHub ואתם מוזמנים להוסיף תכונות ותיקונים חדשים.

אנחנו כבר ממש סקרניים לראות את הפיתוח שלך!