क्लैस्प - Apps स्क्रिप्ट सीएलआई

1. परिचय

Apps Script सीएलआई या clasp एक ऐसा टूल है जिसकी मदद से, Apps Script प्रोजेक्ट को स्थानीय तौर पर बनाया, बदला, और डिप्लॉय किया जा सकता है. इसकी मदद से, कमांड लाइन से Sheets, Docs, Forms, और Slides जैसे प्रॉडक्ट के लिए वेब ऐप्लिकेशन और ऐड-ऑन बनाए और पब्लिश किए जा सकते हैं. Apps Script को दो तरीकों से डेवलप किया जा सकता है. इसके लिए, script.google.com का इस्तेमाल किया जा सकता है या इसे अपने कंप्यूटर पर लोकली डेवलप किया जा सकता है. हम बाद वाले तरीके के बारे में जानेंगे. यानी, Apps Script के लिए कमांड लाइन टूल clasp का इस्तेमाल कैसे करें.

सुविधाएं

• स्थानीय तौर पर डेवलप करें. clasp की मदद से, अपने कंप्यूटर पर कोड लिखा जा सकता है. इसके बाद, इसे 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 की मदद से तीन मुख्य गतिविधियां करने का तरीका बताया जाएगा:

• Apps Script के नए प्रोजेक्ट बनाने का तरीका
• मौजूदा प्रोजेक्ट को क्लोन, पुल, और पुश करने का तरीका
• अपनी स्क्रिप्ट के डिप्लॉयमेंट मैनेज करने का तरीका

2. शुरू करें

सीएलआई डाउनलोड करना

Apps Script CLI (clasp) के लिए, Node.js का इंस्टॉल होना ज़रूरी है. Node.js यहां इंस्टॉल करें.

ध्यान दें: clasp का इस्तेमाल करने के लिए, Node.js >= 20.0.0 होना ज़रूरी है. इन कमांड की मदद से Node.js को अपडेट करें:

sudo npm install n -g

sudo n latest

Node इंस्टॉल करने के बाद, सीएलआई को ग्लोबल तौर पर इंस्टॉल करें (उर्फ़ clasp):

npm i @google/clasp -g

3. Apps Script API चालू करना

Clasp का इस्तेमाल करने से पहले, आपको Apps Script IDE में Google Apps Script API चालू करना होगा.

4. लॉगिन करें

लॉगिन करें

चलिए, clasp को आज़माकर देखते हैं! आपको सिर्फ़ clasp कमांड याद रखनी चाहिए.

clasp

हमने अपने कंप्यूटर पर clasp globally इंस्टॉल किया है, इसलिए यह कमांड आपके फ़ाइल सिस्टम में हर जगह काम करेगी.

कमांड लाइन टूल का इस्तेमाल शुरू करने से पहले, हमें लॉग इन करना होगा. यह निर्देश चलाएं:

clasp login

या SSH का इस्तेमाल करने पर:

clasp login --no-localhost

इस दौरान, आपको Google में लॉग इन करने के लिए कहा जाएगा. सीएलआई का इस्तेमाल करके बनाए गए सभी प्रोजेक्ट, इस Google खाते से जुड़े होते हैं.

5. नया प्रोजेक्ट बनाना

स्टैंडअलोन प्रोजेक्ट बनाना

इसके लिए, सबसे पहले यहां दिए गए निर्देश का इस्तेमाल करके, एक स्टैंडअलोन Google Apps स्क्रिप्ट प्रोजेक्ट बनाएं:

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

आपने "clasp_codelab" फ़ोल्डर में Apps Script प्रोजेक्ट बना लिया है!

ध्यान दें: clasp create कमांड से, एक स्टैंडअलोन स्क्रिप्ट बनाई गई है. इसका मतलब है कि प्रोजेक्ट, Google शीट, दस्तावेज़, फ़ॉर्म या प्रज़ेंटेशन से नहीं जुड़ा है. हालांकि, हम अगले सेक्शन में बाउंड स्क्रिप्ट बनाने का तरीका बताएंगे.

(वैकल्पिक तरीका) किसी मौजूदा प्रोजेक्ट को क्लोन करना

आइए, Google Slides के ऐड-ऑन के लिए कंटेनर से जुड़ी स्क्रिप्ट बनाने की कोशिश करें.

इसके लिए, slides.google.com पर जाएं और एक नया प्रज़ेंटेशन बनाएं. प्रज़ेंटेशन का नाम बदलकर "clasp Codelab Test" करें. Slides के मेन्यू बार में, एक्सटेंशन मेन्यू में जाकर, "Apps Script" चुनें.

इससे आपका Apps Script प्रोजेक्ट, script.google.com पर खुल जाएगा.

अपने प्रोजेक्ट के लिए एक नई डायरेक्ट्री बनाएं और cd करें.

mkdir clasp_codelab_test
cd clasp_codelab_test

किसी प्रोजेक्ट का क्लोन बनाने के लिए, हमें Script ID की ज़रूरत होती है. यह आईडी, Apps Script प्रोजेक्ट के यूआरएल में /projects/ के बाद देखा जा सकता है. वैल्यू को कॉपी करें और उसे इस निर्देश में चिपकाएं:

clasp clone <scriptID>

आउटपुट ऐसा दिखना चाहिए...

अब आपने प्रोजेक्ट को अपनी मौजूदा डायरेक्ट्री में डाउनलोड कर लिया है. Code.gs (एक खाली फ़ंक्शन) के कॉन्टेंट को देखने के लिए, अपने पसंदीदा एडिटर का इस्तेमाल करें.

6. फ़ाइलों को पुल और पुश करना

script.google.com पर कोड में बदलाव करना

अब जब आपके पास किसी प्रोजेक्ट को क्लोन करने की सुविधा है, तो आइए फ़ाइलों को पुल और पुश करने का तरीका जानें. हम आपको script.google.com के ज़रिए क्लाउड पर बदलाव करने और उन्हें अपने कंप्यूटर पर लाने का तरीका बताएंगे. आइए, स्क्रिप्ट को क्लाउड में खोलते हैं:

clasp open-script

अब हम ऑनलाइन एडिटर पर हैं. यहां हम कुछ कोड में ऑनलाइन बदलाव करेंगे. बाद में, हम clasp का इस्तेमाल करके इस कोड को फ़ेच करेंगे.

नई Apps Script फ़ाइल बनाने के लिए, एडिटर में बाईं ओर मौजूद फ़ाइलें के बगल में, फ़ाइल जोड़ें > स्क्रिप्ट पर क्लिक करें. नाम डालें utils/strings. नई बनाई गई फ़ाइल, utils/strings.gs में कोड को इससे बदलें:

var world = "世界";

Code.gs में, मौजूदा कोड की जगह यह कोड डालें:

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

सबसे ऊपर, सेव करें पर क्लिक करें.

फ़ंक्शन चलाने के लिए, एडिटर में सबसे ऊपर मौजूद फ़ंक्शन ड्रॉपडाउन सूची से hello चुनें. इसके बाद, चलाएं पर क्लिक करें.

ग्रीटिंग, एक्ज़ीक्यूशन लॉग में सबसे नीचे दिखती है.

कोड में स्थानीय तौर पर बदलाव करना

आइए, उस कमांड लाइन पर वापस जाएं जहां हमने पिछली बार प्रोजेक्ट को क्लोन किया था. आपको दिख सकता है कि हमारा कोड अब ऑनलाइन एडिटर के साथ सिंक नहीं हो रहा है. इसे ठीक करने के लिए, हम अपने ऑनलाइन प्रोजेक्ट से कोड को पुल करते हैं.

clasp pull

अब कोड पर वापस जाएँ. आपको दिखेगा कि हमारे यूटिलिटी फ़ंक्शन के लिए एक फ़ोल्डर है. clasp CLI, स्थानीय फ़ाइल सिस्टम पर मौजूद फ़ोल्डर के लिए, स्लैश वर्ण / को अपने-आप बदल देता है.

अपने पसंदीदा टेक्स्ट एडिटर में, util/strings.gs पर जाएं और वैरिएबल के नाम world को mondo से बदलें. इसके अलावा, Code.gs को भी अपडेट करें. इसके लिए, world को mondo से बदलें. script.google.com पर अपडेट किए गए कोड को अपडेट करने के लिए, बदलाव किया गया कोड पुश करें.

clasp push

यह बहुत आसान है! आपका कोड अब script.google.com पर अपडेट हो गया है.

clasp push, script.google.com पर मौजूद कोड को बदलता है और clasp pull, सभी फ़ाइलों को स्थानीय तौर पर बदलता है. इसलिए, इन दिशा-निर्देशों का पालन करें:

• कोड में एक साथ बदलाव करने के लिए, स्थानीय तौर पर और script.google.com का इस्तेमाल न करें.
• git जैसे किसी वर्शन कंट्रोल सिस्टम का इस्तेमाल करें.

7. वर्शन बनाना और डिप्लॉय करना

clasp की मदद से, वर्शन और डिप्लॉयमेंट मैनेज किए जा सकते हैं. सबसे पहले, कुछ शब्दावली:

• वर्शन: स्क्रिप्ट प्रोजेक्ट का "स्नैपशॉट". वर्शन को सिर्फ़ पढ़ने के लिए इस्तेमाल की जाने वाली ब्रांच माना जा सकता है. इसका इस्तेमाल डिप्लॉयमेंट के लिए किया जाता है.
• डिप्लॉयमेंट: स्क्रिप्ट प्रोजेक्ट की पब्लिश की गई रिलीज़. इसे अक्सर ऐड-ऑन या वेब ऐप्लिकेशन के तौर पर पब्लिश किया जाता है. वर्शन नंबर डालना ज़रूरी है.

आइए, अपनी स्क्रिप्ट का एक वर्शन बनाते हैं:

clasp create-version "First version"

[version] की जगह पर, लॉग किए गए वर्शन स्ट्रिंग का इस्तेमाल करके, स्क्रिप्ट को डिप्लॉय किया जा सकता है:

clasp create-deployment 1 "First deployment"

clasp deploy कमांड, आपके मेनिफ़ेस्ट को देखती है और वर्शन वाला नया डिप्लॉयमेंट बनाती है. आपका कोड अब एक्ज़ीक्यूटेबल के तौर पर डिप्लॉय हो गया है. इसके बारे में ज़्यादा जानने के लिए, डिप्लॉयमेंट गाइड पढ़ें.

8. हो गया!

हमें उम्मीद है कि Apps Script CLI, Apps Script प्रोजेक्ट मैनेज करने में आपकी मदद करने वाला एक आसान टूल है.

हमने क्या-क्या कवर किया है

• Apps Script के नए प्रोजेक्ट बनाने का तरीका
• मौजूदा प्रोजेक्ट को क्लोन, पुश, और पुल करने का तरीका
• अपनी स्क्रिप्ट के डिप्लॉयमेंट मैनेज करने का तरीका

Clasp, GitHub पर उपलब्ध है. इसमें नई सुविधाओं और पैच का स्वागत है.

हमें यह देखने का बेसब्री से इंतज़ार रहेगा कि आप क्या बनाते हैं!