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

כדי לפתח ולנהל פרויקטים של 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.

התחברות

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

  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

פתיחת הפרויקט בכלי לעריכת סקריפטים של Google Apps

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

clasp open

תרומה לפרויקט הקוד הפתוח clasp

אתם מוזמנים לתרום ל-clasp ב-GitHub.