שימוש בממשק שורת הפקודה עם תפס

כדי לפתח ולנהל פרויקטים של Apps Script מהטרמינל במקום מעורך Apps Script, אפשר להשתמש בכלי בקוד פתוח שנקרא 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 נכתב ב-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 Script בחשבון. לאחר ההפעלה, תתבקשו להיכנס לחשבון Google שבו מאוחסנים הפרויקטים שלכם ב-Apps Script.

clasp login

יציאה

הפקודה הזו יוצרת יציאה מכלי שורת הפקודה. כדי להמשיך להשתמש ב-clasp, צריך להיכנס שוב באמצעות clasp login כדי לבצע אימות מחדש באמצעות Google.

clasp logout

יצירת פרויקט חדש ב-Apps Script

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

clasp create [scriptTitle]

הפקודה הזו יוצרת גם שני קבצים בספרייה הנוכחית:

  • קובץ .clasp.json שמאחסן את מזהה הסקריפט.
  • קובץ מניפסט של פרויקט מסוג appsscript.json שמכיל את המטא-נתונים של הפרויקט.

שכפול של פרויקט קיים

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

כדי למצוא את מזהה הסקריפט של הפרויקט:

  1. פותחים את פרויקט Apps Script.
  2. בצד ימין, לוחצים על הגדרות הפרויקט .

  3. מעתיקים את מזהה הסקריפט בקטע 'מזהים'.

     clasp clone <scriptId>

הורדת פרויקט סקריפט

הפקודה הזו מאפשרת להוריד את פרויקט Apps Script מ-Google Drive למערכת הקבצים של המחשב.

clasp pull

העלאת פרויקט סקריפט

הפקודה הזו מעלה את כל הקבצים של פרויקט סקריפט מהמחשב ל-Google Drive.

clasp push

הצגת רשימה של גרסאות הפרויקט

הפקודה הזו מציגה את המספר והתיאור של כל אחת מהגרסאות של פרויקט סקריפט.

clasp versions

פריסת פרויקט שפורסם

אפשר לפרוס פרויקטים של סקריפטים כאפליקציות אינטרנט, כתוספים או כקובצי הפעלה. אפשר ליצור פריסות בעורך הסקריפט, בmanifest של הפרויקט או באמצעות clasp.

כדי לפרוס פרויקט באמצעות clasp, קודם צריך ליצור גרסה שלא ניתנת לשינוי של פרויקט Apps Script. גרסה היא 'קובץ snapshot' של פרויקט סקריפט, והיא דומה למהדורה מוסתרת לקריאה בלבד.

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.