گیره - اسکریپت برنامه ها CLI

1. مقدمه

Apps Script CLI یا clasp ابزاری است که به شما امکان می‌دهد پروژه‌های Apps Script را به صورت محلی ایجاد، ویرایش و اجرا کنید. این به شما امکان می دهد برنامه های وب و افزونه ها را برای محصولاتی مانند Sheets، Docs، Forms و Slides از خط فرمان ایجاد و منتشر کنید. دو روش وجود دارد که می توانید Apps Script را با استفاده از script.google.com یا به صورت محلی در رایانه خود توسعه دهید. ما دومی را یاد خواهیم گرفت، نحوه استفاده از clasp ، ابزار خط فرمان برای Apps Script.

ویژگی ها

  • به صورت محلی توسعه دهید. clasp به شما این امکان را می دهد که کد را روی رایانه خود بنویسید و پس از اتمام کار، آن را در 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

چیزی که یاد خواهید گرفت

این کد لبه به شما نشان می دهد که چگونه 3 فعالیت کلیدی را با clasp انجام دهید:

  • نحوه ایجاد پروژه های جدید Apps Script
  • چگونه پروژه های موجود را شبیه سازی کنیم، بکشیم و پیش ببریم
  • نحوه مدیریت استقرار اسکریپت های خود

2. شروع به کار

دانلود CLI

Apps Script CLI ( clasp ) نیاز به نصب Node.js >= v6.0.0 دارد. Node.js را در اینجا نصب کنید .

هنگامی که Node را دارید، CLI را به صورت سراسری (مستعار clasp ) نصب کنید:

npm i @google/clasp -g

3. وارد شوید

وارد شوید

بیایید گیره را امتحان کنیم! تنها دستوری که باید به خاطر بسپارید clasp است.

clasp

قبل از شروع استفاده از ابزار خط فرمان، باید وارد شوید. این دستور را اجرا کنید:

clasp login

یا اگر از SSH استفاده می کنید:

clasp login --no-localhost

در این مرحله از شما خواسته می شود که وارد گوگل شوید. هر پروژه ای که با CLI ایجاد می کنید با این حساب Google مرتبط است.

4. یک پروژه جدید ایجاد کنید

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

با ایجاد یک پروژه Google Apps Script مستقل با دستور زیر شروع کنید:

mkdir clasp_codelab;
cd clasp_codelab;
clasp create --title "Clasp Codelab"  --type standalone;

شما به تازگی یک پروژه Apps Script را در پوشه "clasp_codelab" ایجاد کرده اید!

(جایگزین اختیاری) یک پروژه موجود را شبیه سازی کنید

بیایید سعی کنیم یک اسکریپت محدود به کانتینر برای افزونه Google Slides ایجاد کنیم.

برای انجام این کار، به slides.google.com بروید و یک ارائه جدید ایجاد کنید. نام ارائه را به " clasp Codelab Test " تغییر دهید. در هدر، زیر ابزارها ، ویرایشگر اسکریپت... را فشار دهید.

با این کار پروژه Apps Script شما در script.google.com باز می شود. برای شبیه سازی یک پروژه، به Script ID نیاز داریم. می‌توانید این شناسه را در URL پروژه Apps Script بعد از /projects/ پیدا کنید. مقدار را کپی کرده و در دستور زیر پیست کنید:

clasp clone <scriptID>

خروجی باید شبیه این باشد ...

4e3b128f4dcf6467.gif

اکنون پروژه را در فهرست فعلی خود دانلود کرده اید. از ویرایشگر مورد علاقه خود برای مشاهده محتویات Code.gs (یک تابع خالی) استفاده کنید.

5. کشیدن و فشار دادن فایل ها

کد را در script.google.com ویرایش کنید

اکنون که می‌توانید یک پروژه را شبیه‌سازی کنید، بیایید نحوه کشیدن و فشار دادن فایل‌ها را بیاموزیم. ما شما را در مراحل ویرایش در ابر از طریق script.google.com راهنمایی می کنیم و به صورت محلی به رایانه خود می رویم. بیایید اسکریپت را در فضای ابری باز کنیم:

clasp open

اکنون که در ویرایشگر آنلاین هستیم، کدی را به صورت آنلاین ویرایش می کنیم که بعداً با استفاده از clasp واکشی می کنیم.

برای ایجاد یک فایل Apps Script جدید، در سمت چپ ویرایشگر کنار Files ، روی Add a file کلیک کنید. یک فایل اضافه کنید > اسکریپت نام utils/strings را وارد کنید. در فایل جدید ایجاد شده، utils/strings.gs ، کد زیر را جایگزین کنید:

var world = "世界";

در Code.gs کد موجود را با کد زیر جایگزین کنید:

function hello() {
  Logger.log("Hello, " + world);
}

در بالا، روی ذخیره کلیک کنید ذخیره کنید .

برای اجرای تابع، در بالای ویرایشگر، hello را از لیست کشویی تابع انتخاب کرده و روی Run کلیک کنید.

تبریک در پایین در گزارش اجرا ظاهر می شود.

کد را به صورت محلی ویرایش کنید

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

clasp pull

حالا به کد بازگردید. باید توجه داشته باشید که یک پوشه برای Utils ما وجود دارد. clasp CLI به طور خودکار کاراکتر اسلش / به پوشه های موجود در سیستم فایل محلی تبدیل می کند.

در ویرایشگر متن مورد علاقه خود، به util/strings.gs بروید و متغیر name world با mondo جایگزین کنید. همچنین، Code.gs را با جایگزینی world به mondo به روز کنید. برای به روز رسانی کد به روز شده در script.google.com ، کد ویرایش شده خود را فشار دهید.

clasp push

و بس! کد شما اکنون در script.google.com به روز شده است.

6. نسخه سازی و استقرار

clasp به شما امکان می دهد نسخه ها و استقرارها را مدیریت کنید. ابتدا مقداری واژگان:

  • نسخه : یک "عکس فوری" از یک پروژه اسکریپت. یک نسخه را می توان یک شاخه فقط خواندنی در نظر گرفت که برای استقرار استفاده می شود.
  • استقرار : نسخه منتشر شده یک پروژه اسکریپت (اغلب به عنوان یک برنامه افزودنی یا وب). به شماره نسخه نیاز دارد.

بیایید یک نسخه از اسکریپت خود ایجاد کنیم:

clasp version "First version"

با استفاده از رشته نسخه ثبت شده ای که به جای [version] ایجاد کردیم، می توانیم اسکریپت را مستقر کنیم:

clasp deploy 1 "First deployment"

دستور clasp deploy به مانیفست شما نگاه می کند و یک استقرار نسخه جدید ایجاد می کند. کد شما اکنون به عنوان یک فایل اجرایی مستقر شده است. در راهنمای استقرار در مورد این موضوع بیشتر بیاموزید.

7. همین!

امیدواریم Apps Script CLI ابزاری ساده برای کمک به مدیریت پروژه‌های Apps Script باشد.

آنچه را پوشش داده ایم

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

clasp در GitHub در دسترس است و به ویژگی ها و وصله های جدید خوش آمدید.

ما نمی توانیم صبر کنیم تا ببینیم چه چیزی می سازید!