फायरबेस के साथ मॉड्यूल बंडलर का उपयोग करना

जावास्क्रिप्ट मॉड्यूल बंडलर कई चीजें कर सकते हैं, लेकिन उनकी सबसे उपयोगी विशेषताओं में से एक आपके कोड बेस में बाहरी पुस्तकालयों को जोड़ने और उपयोग करने की क्षमता है। मॉड्यूल बंडलर आपके कोड में आयात पथ पढ़ते हैं और आपके एप्लिकेशन-विशिष्ट कोड को आपके आयातित लाइब्रेरी कोड के साथ संयोजित (बंडल) करते हैं।

संस्करण 9 और उच्चतर से, फायरबेस जावास्क्रिप्ट एसडीके को आपके अंतिम निर्माण में शामिल फायरबेस कोड की मात्रा को कम करने के लिए मॉड्यूल बंडलर की अनुकूलन सुविधाओं के साथ काम करने के लिए अनुकूलित किया गया है।

import { initializeApp } from 'firebase/app';
import { getAuth, onAuthStateChanged, getRedirectResult } from 'firebase/auth';

const firebaseApp = initializeApp({ /* config */ });
const auth = getAuth(firebaseApp);
onAuthStateChanged(auth, user => { /* check status */ });

/**
 * getRedirectResult is unused and should not be included in the code base.
 * In addition, there are many other functions within firebase/auth that are
 * not imported and therefore should not be included as well.
 */

पुस्तकालय से अप्रयुक्त कोड को हटाने की इस प्रक्रिया को ट्री शेकिंग के रूप में जाना जाता है। इस कोड को हाथ से मैन्युअल रूप से हटाने में बहुत समय लगता है और त्रुटि की संभावना होती है, लेकिन मॉड्यूल बंडलर इस निष्कासन को स्वचालित कर सकते हैं।

जावास्क्रिप्ट पारिस्थितिकी तंत्र में कई उच्च गुणवत्ता वाले मॉड्यूल बंडलर हैं। यह गाइड वेबपैक , रोलअप और एस्बिल्ड के साथ फायरबेस का उपयोग करके कवर करने पर केंद्रित है।

शुरू हो जाओ

इस गाइड के लिए आपको अपने विकास परिवेश में npm स्थापित करना होगा। npm का उपयोग निर्भरता (पुस्तकालयों) को स्थापित और प्रबंधित करने के लिए किया जाता है। npm स्थापित करने के लिए, Node.js स्थापित करें, जिसमें npm स्वचालित रूप से शामिल है।

Node.js स्थापित करने के बाद अधिकांश डेवलपर्स ठीक से सेट हो जाते हैं। हालांकि, ऐसी सामान्य समस्याएं हैं जिनका सामना कई डेवलपर अपने परिवेश को स्थापित करते समय करते हैं। यदि आप किसी भी त्रुटि में भाग लेते हैं, तो सुनिश्चित करें कि आपके वातावरण में npm CLI है और आपके पास उचित अनुमतियाँ हैं, इसलिए आपको sudo कमांड के साथ एक व्यवस्थापक के रूप में संकुल को स्थापित करने की आवश्यकता नहीं है ।

package.json और फायरबेस स्थापित करना

एक बार जब आप npm स्थापित कर लेते हैं, तो आपको अपने स्थानीय प्रोजेक्ट के मूल में एक package.json फ़ाइल बनानी होगी। इस फाइल को निम्नलिखित npm कमांड के साथ जनरेट करें:

npm init

यह आपको आवश्यक जानकारी प्रदान करने के लिए एक विज़ार्ड के माध्यम से ले जाएगा। एक बार फ़ाइल बन जाने के बाद यह निम्न के जैसा दिखाई देगा:

{
  "name": "your-package-name",
  "version": "1.0.0",
  "description": "",
  "main": "index.js",
  "scripts": {
    "test": "echo \"Error: no test specified\" && exit 1"
  },
  "keywords": [],
  "author": "",
  "license": "ISC",
  "dependencies": {

  }
}

यह फाइल कई अलग-अलग चीजों के लिए जिम्मेदार है। यदि आप मॉड्यूल बंडलिंग और सामान्य रूप से जावास्क्रिप्ट कोड के निर्माण के बारे में अधिक जानना चाहते हैं तो यह एक महत्वपूर्ण फ़ाइल है। इस गाइड के लिए महत्वपूर्ण टुकड़ा "dependencies" वस्तु है। यह ऑब्जेक्ट आपके द्वारा इंस्टॉल की गई लाइब्रेरी और इसके द्वारा उपयोग किए जा रहे संस्करण की एक महत्वपूर्ण मूल्य जोड़ी रखेगा।

निर्भरता जोड़ना npm install या npm i कमांड के माध्यम से किया जाता है।

npm i firebase

जब आप npm i firebase चलाते हैं, तो फ़ायरबेस को निर्भरता के रूप में सूचीबद्ध करने के लिए इंस्टॉलेशन प्रक्रिया package.json को अपडेट करेगी:

  "dependencies": {
    "firebase": "^9.0.0"
  },

कुंजी पुस्तकालय का नाम है और मूल्य उपयोग करने के लिए संस्करण है। संस्करण मान लचीला है और मूल्यों की एक श्रृंखला को स्वीकार कर सकता है। इसे सिमेंटिक वर्जनिंग या सेवर के रूप में जाना जाता है। सेवर के बारे में अधिक जानने के लिए, सिमेंटिक वर्जनिंग के बारे में एनपीएम की गाइड देखें ।

स्रोत बनाम फ़ोल्डर बनाएँ

आपके द्वारा लिखा गया कोड एक मॉड्यूल बंडलर द्वारा पढ़ा और संसाधित किया जाता है और फिर एक नई फ़ाइल या फ़ाइलों के सेट के रूप में आउटपुट होता है। इन दो प्रकार की फाइलों को अलग करना महत्वपूर्ण है। मॉड्यूल बंडलर जिस कोड को पढ़ता है और संसाधित करता है उसे "स्रोत" कोड के रूप में जाना जाता है। वे जो फाइलें आउटपुट करते हैं उन्हें बिल्ट या "डिस्ट" (डिस्ट्रीब्यूशन) कोड के रूप में जाना जाता है।

कोड बेस में एक सामान्य सेटअप स्रोत कोड को src नामक फ़ोल्डर में और निर्मित कोड को dist नामक फ़ोल्डर में संग्रहीत करना है।

- src
 |_ index.js
 |_ animations.js
 |_ datalist.js


- dist
 |_ bundle.js

उपरोक्त उदाहरण फ़ाइल संरचना में, मान लें कि index.js animations.js .js और datalist.js दोनों को आयात करता है। जब एक मॉड्यूल बंडलर सोर्स कोड को प्रोसेस करता है तो वह dist फोल्डर में bundle.js फाइल तैयार करेगा। bundle.js src फ़ोल्डर में फाइलों का एक संयोजन है और कोई भी पुस्तकालय आयात भी करता है।

यदि आप स्रोत नियंत्रण प्रणाली जैसे गिट का उपयोग कर रहे हैं, तो इस कोड को मुख्य भंडार में संग्रहीत करते समय dist फ़ोल्डर को अनदेखा करना आम बात है।

प्रवेश स्थल

मॉड्यूल बंडलर सभी में एक प्रवेश बिंदु की अवधारणा होती है। आप अपने आवेदन को फाइलों के पेड़ के रूप में सोच सकते हैं। एक फ़ाइल दूसरे से कोड आयात करती है और इसी तरह आगे भी। इसका मतलब है कि एक फाइल पेड़ की जड़ होगी। इस फ़ाइल को प्रवेश बिंदु के रूप में जाना जाता है।

आइए पिछले फ़ाइल संरचना उदाहरण पर दोबारा गौर करें।

- src
 |_ index.js
 |_ animations.js
 |_ datalist.js


- dist
 |_ bundle.js

// src/index.js
import { animate } from './animations';
import { createList } from './datalist';

// This is not real code, but for example purposes only
const theList = createList('users/123/tasks');
theList.addEventListener('loaded', event => {
  animate(theList);
});

src/index.js फ़ाइल को प्रवेश बिंदु माना जाता है क्योंकि यह एप्लिकेशन के लिए सभी आवश्यक कोड का आयात शुरू करती है। इस प्रविष्टि बिंदु फ़ाइल का उपयोग मॉड्यूल बंडलर द्वारा बंडलिंग प्रक्रिया शुरू करने के लिए किया जाता है।

वेबपैक के साथ फायरबेस का उपयोग करना

फायरबेस ऐप्स और वेबपैक के लिए किसी विशिष्ट कॉन्फ़िगरेशन की आवश्यकता नहीं है। इस खंड में एक सामान्य वेबपैक कॉन्फ़िगरेशन शामिल है ।

पहला कदम npm से वेबपैक को विकास निर्भरता के रूप में स्थापित करना है।

npm i webpack webpack-cli -D

webpack.config.js नाम के अपने स्थानीय प्रोजेक्ट के मूल में एक फ़ाइल बनाएँ और निम्न कोड जोड़ें।

const path = require('path');

module.exports = {
  // The entry point file described above
  entry: './src/index.js',
  // The location of the build folder described above
  output: {
    path: path.resolve(__dirname, 'dist'),
    filename: 'bundle.js'
  },
  // Optional and for development only. This provides the ability to
  // map the built code back to the original source format when debugging.
  devtool: 'eval-source-map',
};

फिर सुनिश्चित करें कि आपके पास एक निर्भरता के रूप में फ़ायरबेस स्थापित है।

npm i firebase

फिर अपने कोड बेस में फायरबेस को इनिशियलाइज़ करें। निम्नलिखित कोड एक एंट्री पॉइंट फ़ाइल में फ़ायरबेस को आयात और प्रारंभ करता है और "शहर" दस्तावेज़ लोड करने के लिए फायरस्टोर लाइट का उपयोग करता है।

// src/index.js
import { initializeApp } from 'firebase/app';
import { getFirestore, doc, getDoc } from 'firebase/firestore/lite';

const firebaseApp = initializeApp({ /* config */ });
const db = getFirestore(firebaseApp);

async function loadCity(name) {
  const cityDoc = doc(db, `cities/${name}`);
  const snapshot = await getDoc(cityDoc);
  return {
    id: snapshot.id,
    ...snapshot.data(),
  };
}

अगला कदम वेबपैक बिल्ड को चलाने के लिए एक npm स्क्रिप्ट जोड़ना है। package.json फ़ाइल खोलें और "scripts" ऑब्जेक्ट में निम्न कुंजी मान युग्म जोड़ें।

  "scripts": {
    "build": "webpack --mode=development"
  },

वेबपैक चलाने और बिल्ड फोल्डर जेनरेट करने के लिए निम्न कमांड चलाएँ।

npm run build

अंत में, dist बिल्ड फोल्डर को चेक करें। इसमें bundle.js नाम की एक फाइल होनी चाहिए जिसमें आपका बंडल एप्लिकेशन और डिपेंडेंसी कोड हो।

उत्पादन के लिए अपने वेबपैक बिल्ड को अनुकूलित करने के बारे में अधिक जानकारी के लिए, "मोड" कॉन्फ़िगरेशन सेटिंग पर उनके आधिकारिक दस्तावेज़ देखें।

रोलअप के साथ फायरबेस का उपयोग करना

Firebase ऐप्स और रोलअप के लिए किसी विशिष्ट कॉन्फ़िगरेशन की आवश्यकता नहीं है। इस खंड में एक सामान्य रोलअप कॉन्फ़िगरेशन शामिल है।

पहला कदम रोलअप और एक प्लगइन स्थापित करना है जिसका उपयोग एनपीएम के साथ स्थापित निर्भरता के लिए आयात को मैप करने के लिए किया जाता है।

npm i rollup @rollup/plugin-node-resolve -D

अपने स्थानीय प्रोजेक्ट के मूल में rollup.config.js नाम की एक फाइल बनाएं और निम्नलिखित कोड जोड़ें।

import { nodeResolve } from '@rollup/plugin-node-resolve';

export default {
  // the entry point file described above
  input: 'src/index.js',
  // the output for the build folder described above
  output: {
    file: 'dist/bundle.js',
    // Optional and for development only. This provides the ability to
    // map the built code back to the original source format when debugging.
    sourcemap: 'inline',
    // Configure Rollup to convert your module code to a scoped function
    // that "immediate invokes". See the Rollup documentation for more
    // information: https://rollupjs.org/guide/en/#outputformat
    format: 'iife'
  },
  // Add the plugin to map import paths to dependencies
  // installed with npm
  plugins: [nodeResolve()]
};

फिर अपने कोड बेस में फायरबेस को इनिशियलाइज़ करें। निम्नलिखित कोड एक एंट्री पॉइंट फ़ाइल में फ़ायरबेस को आयात और प्रारंभ करता है और "शहर" दस्तावेज़ लोड करने के लिए फायरस्टोर लाइट का उपयोग करता है।

// src/index.js
import { initializeApp } from 'firebase/app';
import { getFirestore, doc, getDoc } from 'firebase/firestore/lite';

const firebaseApp = initializeApp({ /* config */ });
const db = getFirestore(firebaseApp);

async function loadCity(name) {
  const cityDoc = doc(db, `cities/${name}`);
  const snapshot = await getDoc(cityDoc);
  return {
    id: snapshot.id,
    ...snapshot.data(),
  };
}

अगला कदम रोलअप बिल्ड को चलाने के लिए एक npm स्क्रिप्ट जोड़ना है। package.json फ़ाइल खोलें और "scripts" ऑब्जेक्ट में निम्न कुंजी मान युग्म जोड़ें।

  "scripts": {
    "build": "rollup -c rollup.config.js"
  },

रोलअप चलाने और बिल्ड फ़ोल्डर जेनरेट करने के लिए, निम्न आदेश चलाएँ।

npm run build

अंत में, dist बिल्ड फोल्डर को चेक करें। इसमें bundle.js नाम की एक फाइल होनी चाहिए जिसमें आपका बंडल एप्लिकेशन और डिपेंडेंसी कोड हो।

उत्पादन के लिए अपने रोलअप बिल्ड को ऑप्टिमाइज़ करने के बारे में अधिक जानकारी के लिए, प्रोडक्शन बिल्ड के लिए प्लगइन्स पर उनका आधिकारिक दस्तावेज़ देखें।

एस्बिल्ड के साथ फायरबेस का उपयोग करना

फायरबेस ऐप्स और एस्बिल्ड के लिए किसी विशिष्ट कॉन्फ़िगरेशन की आवश्यकता नहीं है। इस खंड में एक सामान्य एस्बिल्ड कॉन्फ़िगरेशन शामिल है।

पहला कदम एस्बिल्ड को विकास निर्भरता के रूप में स्थापित करना है।

npm i esbuild -D

अपने स्थानीय प्रोजेक्ट के मूल में esbuild.config.js नाम की एक फ़ाइल बनाएँ और निम्न कोड जोड़ें।

require('esbuild').build({
  // the entry point file described above
  entryPoints: ['src/index.js'],
  // the build folder location described above
  outfile: 'dist/bundle.js',
  bundle: true,
  // Replace with the browser versions you need to target
  target: ['chrome60', 'firefox60', 'safari11', 'edge20'],
  // Optional and for development only. This provides the ability to
  // map the built code back to the original source format when debugging.
  sourcemap: 'inline',
}).catch(() => process.exit(1))

फिर अपने कोड बेस में फायरबेस को इनिशियलाइज़ करें। निम्नलिखित कोड एक एंट्री पॉइंट फ़ाइल में फ़ायरबेस को आयात और प्रारंभ करता है और "शहर" दस्तावेज़ लोड करने के लिए फायरस्टोर लाइट का उपयोग करता है।

// src/index.js
import { initializeApp } from 'firebase/app';
import { getFirestore, doc, getDoc } from 'firebase/firestore/lite';

const firebaseApp = initializeApp({ /* config */ });
const db = getFirestore(firebaseApp);

async function loadCity(name) {
  const cityDoc = doc(db, `cities/${name}`);
  const snapshot = await getDoc(cityDoc);
  return {
    id: snapshot.id,
    ...snapshot.data(),
  };
}

अगला कदम esbuild चलाने के लिए एक npm स्क्रिप्ट जोड़ना है। package.json फ़ाइल खोलें और "scripts" ऑब्जेक्ट में निम्न कुंजी मान युग्म जोड़ें।

  "scripts": {
    "build": "node ./esbuild.config.js"
  },

अंत में, dist बिल्ड फोल्डर को चेक करें। इसमें bundle.js नाम की एक फाइल होनी चाहिए जिसमें आपका बंडल एप्लिकेशन और डिपेंडेंसी कोड हो।

एस्बिल्ड को उत्पादन के लिए अनुकूलित करने के बारे में अधिक जानकारी के लिए, खनन और अन्य अनुकूलन पर उनके आधिकारिक दस्तावेज देखें।