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

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

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

clasp login

יציאה

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

clasp logout

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

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

clasp create [scriptTitle]

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

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

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

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

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

  1. פתיחת פרויקט Apps Script.
  2. בצד ימין, לוחצים על Project Settings (הגדרות הפרויקט) .
  3. מעתיקים את מזהה הסקריפט בקטע 'מזהים'.

     clasp clone <scriptId>
    

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

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

clasp pull

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

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

clasp push

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

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

clasp versions

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

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