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

כדי לפתח ולנהל פרויקטים של 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 login כדי לבצע אימות מחדש מול Google לפני שממשיכים להשתמש ב-clasp.

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

פתיחת הפרויקט בעורך Apps Script

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

clasp open

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

הוספת תוכן ל-clasp ב-GitHub.