در مطلب قبلی بیشتر از لحاظ تئوریک با وبپک آشنا شدیم و در آخر نیز یک تک اسکریپت را با استفاده از آن باندل کرده و در صفحهی index.html اضافه کردیم.
پروپرتی entry مشخص کنندهی فایل ورودی است که قصد پردازش آن را داریم و پروپرتی output نیز خود یک آبجکت میباشد که در سادهترین حالت، احتیاج به تعریف یک پروپرتی با نام filename را در آن داریم که مشخص کنندهی نام فایل باندل شونده توسط وبپک میباشد.
اینبار برای ورود وپ بک به حالت نظارهگر کافی است وبپک را یک بار از طریق خط فرمان با دستور npm run webpack، فراخوانی کنیم.
در حالتی که وبپک به صورت سراسری نصب شده باشد، با اجرای دستور webpack-dev-server در خط فرمان، وب سرور وبپک شروع به کار خواهد کرد و تنظیمات را نیز از فایل پیکربندی اعمال میکند.
در اینجا پروپرتی جدیدی به قسمت scripts، با نام webpackserver اضافه شدهاست. حال با فراخوانی این اسکریپت با دستور زیر، وب سرور وبپک شروع به کار خواهد کرد:
(دقت کنید که نامهای قرار داده شدهی در قسمت scripts میتوانند به صورت دلخواه باشند و شما میتوانید نامی را که دلخواه خودتان است، برگزینید؛ به طور مثال به جای webpackserver نام دیگری را در فایل package.json برای آن مشخص کنید و در هنگام فراخوانی از آن استفاده کنید).
حال جهت استفاده از این ماژول در فایل main.js تغییرات زیر را اعمال خواهیم کرد:
پس از ذخیرهی تغییرات خواهید دید که وب سرور وبپک از این تغییرات آگاه شده و باندل جدید را خواهد ساخت که در اینجا خروجی مانند تصویر زیر را خواهید دید:
حال برای اینکه این اسکریپت را به وبپک معرفی کنیم، فایل پیکربندی وبپک را باز کرده و تغییرات زیر را در آن اعمال میکنیم :
قابل مشاهده است که قسمت entry، به جای این که یک تک فایل را معرفی کند، تبدیل به یک آرایه شدهاست که هم فایل shared.js را در بر میگیرد و هم فایل main.js را دارد.
برای اینکه به وبپک خبر دهیم که در پروژه در حال استفاده از تایپ اسکریپت هستیم، فایل پیکربندی وبپک را باز کرده و پروپرتی جدیدی را با نام module به آن معرفی میکنیم که خود یک آبجکت میباشد. حال در آبجکت module یک پروپرتی جدید را با نام loaders که جنس آرایهای دارد، اضافه میکنیم. آرایهی loaders شامل همهی loader هایی خواهد بود که شما قصد استفادهی آنها را به همراه وبپک دارید. هر عضو از این آرایه خود نیز یک آبجکت میباشد که دارای سه پروپرتی زیر میباشد:
حال با اجرای دوبارهی وبپک، loader تایپ اسکریپت ابتدا اجرا شده، سپس وبپک وارد کار میشود و فایلها را باندل خواهد کرد. در صورتی که بدون مشکل همه چیز اجرا شود، خروجی مانند تصویر زیر را خواهید داشت:
توجه :
در مطلب قبلی برای استفاده و نصب وبپک دو راه پیشنهاد شد؛ یکی نصب وبپک به صورت سراسری و دیگری به صورت محلی در محیط کاری فعلی پروژه. استفادهی نگارنده به صورت محلی میباشد و برای فراخوانی وبپک از دستور npm run webpack استفاده خواهد شد. در صورتی که از وبپک به صورت سراسری (گلوبال ) استفاده میکنید، به جای این دستور فقط کافی است در خط فرمان دستور webpack را نوشته و آن را اجرا کنید.
اضافه کردن فایل تنظیمات وبپک
وبپک دارای تنظیمات و حالتهای مختلفی برای تولید خروجی نهایی میباشد که میتوان این تنظیمات را به صورت پارامترهای ورودی، در هنگام فراخوانی برای آن مشخص کرد. ولی برای ساده کردن و همچنین عدم الزام به تکرار برای تنظیمات مورد نیاز میتوانیم یک فایل پیکربندی را ایجاد کنیم و موارد مورد نیاز را در آن تعریف کرده و تنها با فراخوانی نام webpack در خط فرمان، به صورت خودکار این تنظیمات خوانده شده و دستورات ما اجرا شوند. TaskRunnerهای گالپ و گرانت نیز دارای یک فایل پیکربندی، برای مشخص کردن تنظیمات مورد نیاز کاربر میباشند.
ساخت فایل پیکربندی وبپک
در محیط کاری پروژه یک فایل جدید را با نام webpack.config.js ایجاد میکنیم، تا پیکر بندی مورد نظرمان را برای وبپک در آن مشخص کنیم (نام این فایل قراردادی است و امکان مشخص کردن فایلی با نام دیگر نیز وجود دارد که در آینده با آن برخورد خواهیم کرد).
این فایل به صورت یک ماژول در فرمت commonjs میباشد (در صورتی که با ماژولهای مختلف آشنا نیستید، مطالعهی این مقاله پیشنهاد میشود ماژولها در es6).
پس از ایجاد فایل پیکربندی در محیط کاری پروژه، محتوای زیر را به آن اضافه خواهیم کرد. این حالت را میتوان سادهترین پیکربندی وبپک دانست و با دستور webpack ./main.js bundle.js که در پایان مطلب قبلی در خط فرمان اجرا کردیم، تفاوتی ندارد.
// webpack.config.js file module.exports = { entry:'./main.js' ,output:{ filename:'bundle.js' } }
حال با اجرای دستور npm run webpack، وبپک به صورت خودکار محتوای فایل پیکربندی را خوانده و تنظیمات تعریف شده را در فایل باندل نهایی ترتیب اثر میدهد.
حالت نظاره گر یا watch mode
اضافه کردن فایل پیکربندی میتواند مفید باشد و ما را از الزام به تکرار برای مشخص کردن پارامترهای مورد نیاز در هر بار اجرای وبپک بینیاز میکند. ولی فرض کنید در حال توسعهی پروژهای هستید و مدام در حال تغییر فایلهای پروژه میباشید. فایلی اضافه، حذف و یا دچار تغییر میشود و برای هر بار انجام شدن پروسهی باندلینگ باید وبپک را فراخوانی کنیم. برای جلوگیری از این پروسهی تکراری، وبپک دارای حالت نظارهگر یا watch mode میباشد. معنای این حالت این است که وبپک تغییرات محیط کاری شما را در نظر میگیرد و با انجام هر تغییری، دوباره باندل مربوطه را از نو میسازد.
برای وارد شدن به این حالت یک راه کار این میباشد که در هنگام فراخوانی وبپک در خط فرمان، پرچم زیر را به آن اضافه کنیم:
//for when webpack is installed globally webpack --watch //for when webpack is installed locally in project npm run webpack -- --watch
(در فراخوانی بالا دو حالت نصب سراسری و محلی وبپک در نظر گرفته شدهاست. حالت اول نکتهای را ندارد. ولی در حالت دوم برای اینکه پارامترهای خط فرمان توسط npm به دست وبپک برسد، احتیاج به اضافه کردن -- میباشد. جهت عدم آشنایی با این مورد میتوانید به اینجا مراجعه کنید: فرستادن پارامتر به اسکریپتهای npm)
راه کار دوم جهت تنظیم کردن وبپک در حالت نظاره گر، اضافه کردن پروپرتی watch به فایل پیکربندی وبپک است. پس از انجام این تغییر، محتوای فایل پیکربندی به این صورت خواهد بود:
//webpack.config.js file module.exports = { entry:'./main.js' ,output:{ filename:'bundle.js' } ,watch :true }
در صورتی که مشکلی وجود نداشته باشد، با اجرای این دستور، کنترل خط فرمان به شما برنخواهد گشت و وبپک در حالت اجرا باقی میماند که در تصویر زیر قابل مشاهدهاست.
حال اگر در اسکریپت main.js تغییری ایجاد کنید، خواهید دید که وبپک به صورت خودکار باندل را از اول خواهد ساخت.
وب سرور وبپک
تا اینجا از وبپک به عنوان یک باندل کننده بهره بردهایم و جهت میزبانی فایلهای پروژه از فایل سیستم و سیستم عامل بهره بردیم. ولی میدانیم که در حین توسعه دادن برنامههای وب، استفاده از فایل سیستم و سیستم عامل مفید نیست و دچار مشکلات عدیدهای هم از سمت مرورگرها و هم از سمت کتابخانههای معروف جاوا اسکریپتی خواهیم شد( مانند مباحث cors و ...). جهت حذف این مشکلات میتوانیم وب سرور مورد علاقهی خود را اجرا کنیم یا از وب سرور فراهم شده توسط وبپک بهره ببریم.
جهت نصب وب سرور وبپک دستور زیر را در خط فرمان اجرا خواهیم کرد ( به صورت سراسری یا محلی به انتخاب شما خواهد بود و قبلا توضیح داده شده است).
// to install globally : npm install -g webpack-dev-server //to install locally in project : npm install -D webpack-dev-server
در صورتی که وبپک به صورت محلی نصب شده باشد، بایستی یک مدخل به قسمت اسکریپتهای package.json برای راهنمایی npm اضافه کنیم. محتویات این فایل پس از تغییرات، از این قرار است:
//package.json file { "name": "dntwebpack", "version": "1.0.0", "description": "", "main": "main.js", "scripts": { "test": "echo \"Error: no test specified\" && exit 1", "webpack": "webpack", "webpackserver": "webpack-dev-server" }, "author": "mehdi", "license": "ISC", "devDependencies": { "webpack": "^1.13.1", "webpack-dev-server": "^1.14.1" } }
npm run webpackserver
در صورتی که همه چیز بدون مشکل باشد، خروجی شبیه به تصویر زیر را مشاهده خواهید کرد که آدرسی که به صورت محلی، سرور بر روی آن میزبان شده است نیز قابل مشاهده است:
باندل کردن اسکریپتهای گوناگون توسط وبپک
تا اینجای کار تنها از یک تک اسکریپت، با نام main.js استفاده کردیم. قطعا پروژههای واقعی از یک تک اسکریپت تشکیل نخواهند شد و اسکریپتهای گوناگونی خواهیم داشت. جهت استفاده از چندین اسکریپت توسط وبپک، دو سناریوی مختلف رخ خواهند داد که هر دو را برسی خواهیم کرد:
اضافه کردن اسکریپتها به صورت داینامیک یا پویا توسط وبپک
در محیط کاری پروژه، یک فایل جدید user.js را اضافه میکنیم که از این فایل در فایل main.js استفاده خواهد شد.
محتوای فایل user.js یک تابع سادهی جاوا اسکریپتی خواهد بود:
// user.js file function userLog() { console.log("ahooy from user module file"); } module.exports={ userLog:userLog }
//main.js file var user = require("./user"); user.userLog(); console.log(`i'm bundled by webpack`);
در تصویر قابل مشاهده است که ماژول user.js نیز وارد باندل شده است.
در صورتی که به مسیری که وبپک در حال میزبانی بر روی آن است در مرورگر خود مراجعه کنید، پیغامهای چاپ شده را در کنسول مشاهده خواهید کرد.
اضافه کردن اسکریپتها به باندل به صورت استاتیک توسط وبپک
قطعا در پروژههای خود از کتابخانههایی که توسط برنامه نویسان دیگر تولید شدهاند مانند جی کوئری و ... استفاده خواهیم کرد. استفاده از این اسکریپتها به صورت داینامیک و ایمپورت کردن آنها در هر ماژول جالب نخواهد بود و یا ممکن است ماژولی که خود شما نوشته اید به صورت اشتراکی بین تمام برنامه اجرا شود. در این گونه از موارد میتوانیم این اسکریپتها را در فایل پیکربندی به وبپک معرفی کنیم تا در هنگام باندلینگ، به باندل وارد شوند.
اسکریپت جدیدی را در پروژه اضافه میکنیم و نامش را shared.js میگذاریم که دارای محتوای زیر است :
// shared.js file console.log('log message from shared module !');
//webpack.config.js file module.exports = { entry:['./shared.js','./main.js'] ,output:{ filename:'bundle.js' } ,watch :true }
در مواقعی که فایل پیکربندی دچار تغییر میشود، بایستی وبپک را متوقف و دوباره اجرا کنید تا تنظیمات جدید، اعمال شوند. پس از راه اندازی دوباره وبپک، در صورت موفقیت آمیز بودن تغییراتتان، خروجی را شبیه تصویر رو به رو خواهید گرفت و مشخص است که فایل shared.js نیز در باندل وارد شده است.
استفاده از Loaderها در وبپک
به صورت پیش فرض وبپک قابلیت باندل کردن ماژولهای جاوا اسکریپت را دارد و همچنین میتواند این فایلها را Minify کند (در مطالب بعدی خواهیم دید). ولی به طور مثال استفاده از تایپ اسکریپت از تواناییهای وبپک به صورت توکار خارج است. اینجاست که Loaderها وارد کار میشوند.
اگر بخواهیم به زبان ساده Loaderها را تعریف کنیم میتوان آنها را کامپوننت هایی دانست که به وبپک فوت و فن کار جدیدی را یاد میدهند.
در ادامه Loader تایپ اسکریپت را نصب خواهیم کرد و به کمک آن فایلهای پروژه را تبدیل به تایپ اسکریپت کرده و در هنگام باندل کردن از وبپک میخواهیم که این فایلها را ترنسپایل کند و سپس باندل را از روی آنها بسازد ( برای مطالعهی ادامهی این مطلب احتیاجی به آشنایی به تایپ اسکریپت نیست و هدف استفاده از یک loader است. ولی در صورت علاقه میتوانید به اینجا مراجعه کنید سری آموزش تایپ اسکریپت)
نصب Loader تایپ اسکریپت
به خط فرمان برگشته و با استفاده از npm، لودر تایپ اسکریپت مورد نیاز وبپک را نصب میکنیم. دستور مورد نیاز این قرار است :
npm install -D ts-loader
( توجه :
در ادامه این مطلب از پیکربندی سادهی یک پروژهی تایپ اسکریپتی استفاده شده است که اعم از ایجاد فایل tsconfig.json و اضافه کردن پوشهی typings به پروژه میباشد.)
فایل main.ts را که یک فایل تایپ اسکریپتی میباشد، به پروژه اضافه میکنیم. محتوای آن به صورت زیر خواهد بود. قابل مشاهده است که از ویژگیهای ES6 در این فایل استفاده شده و این انتظار را از لودر تایپ اسکریپت داریم که این فایل را در هنگام باندلینگ برای ما ترنسپایل کند.
// main.ts file let user = require("./user"); user.userLog(); let mainlogger = () => { console.log(`i'm bundled by webpack in an arrow function`); } mainlogger();
test : یک رجکس میباشد که به loader میگوید به دنبال چه فایلهایی بگردد.
exclude : از جنس رجکس و مشخص کنندهی مسیرهایی است که از پروژه باید جدا شوند و توسط loader پردازش نشوند (مانند فایلهای از قبل کامپایل شدهی کتابخانهها).
loader : مشخص کنندهی نام loader مورد نظر .
محتوای فایل پیکربندی وبپک، پس از معرفی loader تایپ اسکریپت، به این صورت خواهد بود:
//webpack.config.js module.exports = { entry:['./shared.js','./main.js'] ,output:{ filename:'bundle.js' } ,watch :true ,module:{ loaders:[ { test:/\.ts$/ ,exclude:/node_modules/ ,loader:'ts-loader' } ] } }
در این مطلب تنظیمات مختلف وبپک، فایل پیکربندی، استفاده از چندین فایل به همراه وبپک، وب سرور وبپک و همچنین با loaderهای وبپک آشنا شدیم.
دریافت فایلها dntwebpack-part2.zip