clasp - Apps Script CLI

1. מבוא

‫Apps Script CLI, או 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

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

אחרי שמתקינים את Node, מתקינים את ה-CLI באופן גלובלי (כינוי clasp):

npm i @google/clasp -g

3. הפעלת Apps Script API

כדי להשתמש ב-Clasp, צריך להפעיל את Google Apps Script API בסביבת הפיתוח המשולבת (IDE) של Apps Script.

4. התחברות

התחברות

בוא ננסה את clasp! הפקודה היחידה שצריך לזכור היא clasp.

clasp

לפני שמתחילים להשתמש בכלי שורת הפקודה, צריך להתחבר. מריצים את הפקודה הבאה:

clasp login

או אם משתמשים ב-SSH:

clasp login --no-localhost

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

5. יצירת פרויקט חדש

יצירת פרויקט עצמאי

מתחילים ביצירת פרויקט עצמאי של 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. בסרגל התפריטים של Slides, בתפריט תוספים, בוחרים באפשרות Apps Script.

פרויקט Apps Script ייפתח בכתובת script.google.com.

יוצרים ספרייה חדשה לפרויקט ומנווטים אליה באמצעות cd.

mkdir clasp_codelab_test
cd clasp_codelab_test

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

clasp clone <scriptID>

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

4e3b128f4dcf6467.gif

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

6. שליפה ודחיפה של קבצים

עריכת הקוד בכתובת script.google.com

אחרי שלמדנו איך לשכפל פרויקט, נלמד איך למשוך ולדחוף קבצים. נסביר לכם איך לערוך בענן דרך script.google.com ולשלוף באופן מקומי למחשב. פותחים את הסקריפט בענן:

clasp open-script

עכשיו אנחנו בעורך אונליין, ונערך קוד אונליין שנביא אותו מאוחר יותר באמצעות clasp.

כדי ליצור קובץ Apps Script חדש, בצד ימין של העורך, ליד Files, לוחצים על סמל הוספת קובץ להוסיף קובץ > 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.

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

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

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

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

clasp create-version "First version"

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

clasp create-deployment 1 "First deployment"

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

8. זהו!

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

מה נכלל

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

‫Clasp זמין ב-GitHub, ואנחנו מקבלים בברכה תכונות חדשות ותיקוני באגים.

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