از رابط خط فرمان با clasp استفاده کنید

برای توسعه و مدیریت پروژه‌های Apps Script از طریق ترمینال خود به جای ویرایشگر Apps Script، می‌توانید از یک ابزار متن‌باز به نام clasp استفاده کنید.

آزمایشگاه کد clasp ، مروری کلی بر تمام ویژگی‌های clasp ارائه می‌دهد.

ویژگی‌ها

توسعه محلی

clasp به شما امکان می‌دهد پروژه‌های Apps Script خود را به صورت محلی توسعه دهید. می‌توانید کد را روی رایانه خود بنویسید و پس از اتمام کار، آن را در Apps Script آپلود کنید. همچنین می‌توانید پروژه‌های Apps Script موجود را دانلود کنید تا بتوانید در حالت آفلاین آنها را ویرایش کنید. از آنجایی که کد به صورت محلی است، می‌توانید هنگام ساخت پروژه‌های Apps Script از ابزارهای توسعه مورد علاقه خود مانند git استفاده کنید.

مدیریت نسخه‌های استقرار

چندین نسخه از پروژه خود را ایجاد، به‌روزرسانی و مشاهده کنید.

کد ساختار

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 نسخه ۴.۷.۴ یا بالاتر را نصب کرده باشید. نصب Node.js نیاز به دسترسی ادمین دارد.

نصب

پس از نصب Node.js، می‌توانید از دستور npm زیر برای نصب clasp استفاده کنید:

npm install @google/clasp -g

پس از نصب، می‌توانید از دستور clasp در هر دایرکتوری روی رایانه خود استفاده کنید.

با استفاده از clasp

شما می‌توانید clasp برای انجام وظایف مختلف از طریق خط فرمان استفاده کنید. این بخش عملیات رایجی را که می‌توانید هنگام توسعه با clasp استفاده کنید، شرح می‌دهد.

ورود

این دستور وارد سیستم می‌شود و مدیریت پروژه‌های Apps Script حساب گوگل شما را مجاز می‌کند. پس از اجرا، از شما خواسته می‌شود وارد حساب گوگلی شوید که پروژه‌های Apps Script شما در آن ذخیره شده‌اند.

clasp login

خروج

این دستور از ابزار خط فرمان خارج می‌شود. قبل از ادامه استفاده clasp ، باید دوباره با استفاده clasp login وارد سیستم شوید تا اعتبارسنجی مجدد با گوگل انجام شود.

clasp logout

یک پروژه جدید Apps Script ایجاد کنید

این دستور یک اسکریپت جدید در دایرکتوری فعلی با عنوان اسکریپت اختیاری ایجاد می‌کند.

clasp create [scriptTitle]

این دستور همچنین دو فایل در دایرکتوری فعلی ایجاد می‌کند:

  • یک فایل .clasp.json که شناسه اسکریپت را ذخیره می‌کند.
  • یک فایل مانیفست پروژه appsscript.json که شامل فراداده‌های پروژه است.

کلون کردن یک پروژه موجود

این دستور یک پروژه موجود در دایرکتوری فعلی را کپی می‌کند. اسکریپت باید با حساب گوگل شما ایجاد یا به اشتراک گذاشته شود. شما با ارائه شناسه اسکریپت، پروژه اسکریپت مورد نظر برای کپی کردن را مشخص می‌کنید.

برای پیدا کردن شناسه اسکریپت پروژه، مراحل زیر را دنبال کنید:

  1. پروژه Apps Script را باز کنید.
  2. در سمت چپ، روی پروژه کلیک کنید.
  3. در قسمت شناسه‌ها، شناسه اسکریپت را کپی کنید.

     clasp clone <scriptId>
    

دانلود یک پروژه اسکریپت نویسی

این دستور پروژه Apps Script را از گوگل درایو روی سیستم فایل رایانه شما دانلود می‌کند.

clasp pull

آپلود پروژه اسکریپت

این دستور تمام فایل‌های یک پروژه اسکریپت را از رایانه شما به گوگل درایو آپلود می‌کند.

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 کمک کنید.