Як створити програму Vue.js за допомогою однофайлових компонентів без CLI.

Розуміння однофайлових компонентів Vue (SFC) та Node Package Manager (NPM) буде корисним для цієї статті.

Інтерфейс командного рядка фреймворку (CLI) є найкращим методом для створення проекту. Він забезпечує вихідну точку файлів, папок та конфігурації. Це риштування також забезпечує процес розробки та побудови. Процес розробки забезпечує спосіб перегляду оновлень, що відбуваються під час редагування проекту. Процес побудови створює остаточну версію файлів, які будуть використовуватися у виробництві.

Встановлення та запуск Vue.js (“Vue”) можна здійснити за допомогою тегу сценарію, який вказує на мережу доставки вмісту Vue (CDN). Жоден процес побудови або розробки не потрібен. Але, якщо ви використовуєте однофайлові компоненти Vue (SFC), вам потрібно перетворити ці файли в щось, що може зрозуміти браузер. Файли потрібно перетворити на мову розмітки гіпертексту (HTML), каскадні таблиці стилів (CSS) та JavaScript (JS). У цьому випадку необхідно використовувати процес розробки та збірки.

Замість того, щоб покладатися на Vue CLI для створення нашого проекту та надання нам процесу розробки та побудови, ми створимо проект з нуля. Ми створимо власний процес розробки та побудови за допомогою Webpack.

Що таке Webpack?

Webpack - це модульний пакет. Він об'єднує код з декількох файлів в один. Перед Webpack користувач включав тег сценарію для кожного файлу JavaScript. Хоча браузери повільно підтримують модулі ES6, Webpack продовжує залишатися найкращим способом створення модульного коду.

Окрім того, що пакет модулів, Webpack може також перетворювати код. Наприклад, Webpack може взяти сучасний JavaScript (ECMAScript 6+) і перетворити його на ECMAScript 5. Хоча Webpack об'єднує сам код, він перетворює код за допомогою завантажувачів та плагінів. Подумайте про завантажувачі та плагіни як надбудови для Webpack.

Webpack і Vue

Однофайлові компоненти дозволяють нам створити цілий компонент (структуру, стиль та функцію) в одному файлі. Більшість редакторів коду забезпечують підсвічування та підключення синтаксису для цих SFC.

Зверніть увагу, що файл закінчується .vue. Браузер не знає, що робити з цим розширенням. Webpack, використовуючи завантажувачі та плагіни, перетворює цей файл у HTML, CSS та JS, які може використовувати браузер.

Проект: Створення програми Hello World Vue за допомогою однофайлових компонентів.

Крок 1: Створіть структуру проекту

Найпростіший проект Vue включатиме HTML, JavaScript та файл Vue (файл, що закінчується .vue ). Ми розмістимо ці файли в папці з назвою src. Вихідна папка допоможе нам відокремити код, який ми пишемо, від коду, який Webpack згодом створить.

Оскільки ми будемо використовувати Webpack, нам потрібен файл конфігурації Webpack.

Крім того, ми будемо використовувати компілятор під назвою Babel. Babel дозволяє нам писати код ES6, який потім компілює в ES5. Babel - одна з тих «додаткових функцій» для Webpack. Babel також потребує конфігураційний файл.

Нарешті, оскільки ми використовуємо NPM, ми також матимемо папку node_modules та файл package.json. Вони будуть створені автоматично, коли ми ініціалізуємо наш проект як проект NPM і почнемо встановлювати наші залежності.

Для початку створіть папку з назвою hello-world. З командного рядка перейдіть до цього каталогу та запустіть npm init. Дотримуйтесь підказок на екрані, щоб створити проект. Потім створіть решту папок (крім node_modules), як описано вище. Структура вашого проекту повинна виглядати так:

Крок 2: Встановіть залежності

Ось короткий опис залежностей, які ми використовуємо:

vue : фреймворк JavaScript

vue-loader і vue-template-compiler : Використовується для перетворення наших файлів Vue у JavaScript.

webpack : Інструмент, який дозволить нам передати наш код через деякі перетворення та об’єднати його в один файл.

webpack-cli: необхідний для запуску команд Webpack.

webpack-dev-server : Хоча це і не потрібно для нашого невеликого проекту (оскільки ми не будемо робити жодних запитів HTTP), ми все одно будемо "обслуговувати" наш проект із сервера розробки.

babel-loader : Перетворіть наш код ES6 у ES5. (Потрібна допомога з наступних двох залежностей.)

@ babel / core та @ babel / preset-env : Babel сам по собі нічого не робить з вашим кодом. Ці два “доповнення” дозволять нам трансформувати наш код ES6 у код ES5.

css-loader: Бере CSS, який ми пишемо в нашому.vueфайли або будь-який CSS, який ми можемо імпортувати в будь-який з наших файлів JavaScript, і визначити шлях до цих файлів. Іншими словами, з’ясуйте, де знаходиться CSS. Це ще один навантажувач, який сам по собі не буде робити багато. Нам потрібен наступний завантажувач, щоб насправді щось зробити із CSS.

vue-style-loader : Візьміть CSS, який ми отримали від нашого, css-loaderі введіть його в наш HTML-файл. Це створить і введе тег стилю в заголовок нашого документа HTML.

html-webpack-plugin : візьміть наш index.html і вставте наш вкладений файл JavaScript в заголовок. Потім скопіюйте цей файл уdistпапку.

rimraf : дозволяє нам з командного рядка видаляти файли. Це стане в нагоді, коли ми будуємо наш проект кілька разів. Ми будемо використовувати це для видалення будь-яких старих збірок.

Давайте встановимо ці залежності зараз. З командного рядка запустіть:

npm install vue vue-loader vue-template-compiler webpack webpack-cli webpack-dev-server babel-loader @babel/core @babel/preset-env css-loader vue-style-loader html-webpack-plugin rimraf -D

Примітка: "-D" в кінці позначає кожну залежність як залежність від розвитку в нашому package.json. Ми об’єднуємо всі залежності в один файл, тому для нашого невеликого проекту у нас немає виробничих залежностей.

Крок 3: Створіть файли (окрім нашого конфігураційного файлу Webpack).

 {{ message }} export default { data() { return { message: 'Hello World', }; }, };   #app { font-size: 18px; font-family: 'Roboto', sans-serif; color: blue; } 
  Vue Hello World 
import Vue from 'vue'; import App from './App.vue'; new Vue({ el: '#app', render: h => h(App), });
module.exports = { presets: ['@babel/preset-env'], }

До цього моменту ніщо не повинно виглядати надто чужим. Я зберігав кожен файл дуже простим. Я додав лише мінімальні CSS та JS, щоб бачити наш робочий процес у дії.

Крок 4: Вказівки Webpack, що робити

Зараз присутня вся конфігурація, до якої потрібно отримати доступ Webpack. Нам потрібно зробити дві останні речі: сказати Webpack, що робити, і запустити Webpack.

Нижче наведено файл конфігурації Webpack ( webpack.config.js). Створіть цей файл у кореневому каталозі проектів. По рядку ми обговоримо, що відбувається.

const HtmlWebpackPlugin = require('html-webpack-plugin'); const VueLoaderPlugin = require('vue-loader/lib/plugin'); module.exports = { entry: './src/main.js', module: { rules: [ { test: /\.js$/, use: 'babel-loader' }, { test: /\.vue$/, use: 'vue-loader' }, { test: /\.css$/, use: ['vue-style-loader', 'css-loader']}, ] }, plugins: [ new HtmlWebpackPlugin({ template: './src/index.html', }), new VueLoaderPlugin(), ] };

Рядки 1 і 2: Ми імпортуємо два плагіни, які ми використовуємо нижче. Зверніть увагу, що наші завантажувачі зазвичай не потрібно імпортувати, а лише наші плагіни. А в нашому випадкуvue-loader (який ми використовуємо в рядку 9) також потребує плагіна для роботи (однак, наприклад, Babel цього не робить).

Рядок 4: Ми експортуємо нашу конфігурацію як об’єкт. Це дає нам доступ до нього, коли ми запускаємо команди Webpack.

Рядок 5: Це наш модуль вступу. Webpack потребує місця для початку. Він заглядає у наш main.jsфайл, а потім починає перечісувати наш код з цього моменту.

Рядки 6 і 7: Це об’єкт модуля. Тут ми в першу чергу передаємо масив правил. Кожне правило говорить Webpack, як обробляти певні файли. Отже, хоча Webpack використовує точку входу, main.jsщоб почати прочісувати наш код, він використовує правила для трансформації нашого коду.

Рядок 8 (правило): Це правило вказує Webpack використовувати babel-loaderфайли, які закінчуються на .js. Пам’ятайте, Babel перетворить ES6 + на ES5.

Рядок 9 (правило): Це правило вказує Webpack використовуватиvue-loader(and don’t forget the associated plugin on line 17) to transform our .vue files into JavaScript.

Line 10 (rule): Sometimes we want to pass a file through two loaders. Counterintuitively, Webpack will pass the file from right to left instead of left to right. Here we are using two loaders and saying to Webpack: “get my CSS from my Vue file or any JavaScript files(css-loader) and inject it into my HTML as a style tag (vue-style-loader).

Lines 11 and 12: Close out our rules array and module object.

Lines 13: Create a plugins array. Here we will add the two plugins we need.

Line: 14 -16 (plugin): The HtmlWebpackPlugin takes the location of our index.html file and adds our bundled JavaScript file to it via a script tag. This plugin will also copy the HTML file to our distribution folder when we build our project.

Line 17 (plugin): The VueLoaderPlugin works with our vue-loader to parse our .vue files.

Line 18: Close out the plugins array.

Line 19: Close out the Webpack object that we are exporting.

Step 5: Setting up our package.json file so we can run Webpack

Our configuration is complete, now we want to see our application. Ideally, as we make changes to our application, the browser would update automatically. This is possible with webpack-dev-server.

Delete the test script in our package.json file, and replace it with a script to serve our application:

 { "name": "hello-world", "version": "1.0.0", "description": "", "main": "main.js", "scripts": { "serve": "webpack-dev-server --mode development" }, "author": "", "license": "ISC", "devDependencies": { "@babel/core": "^7.1.6", "@babel/preset-env": "^7.1.6", "babel-loader": "^8.0.4", "css-loader": "^1.0.1", "html-webpack-plugin": "^3.2.0", "rimraf": "^2.6.2", "vue": "^2.5.17", "vue-loader": "^15.4.2", "vue-style-loader": "^4.1.2", "vue-template-compiler": "^2.5.17", "webpack": "^4.26.0", "webpack-cli": "^3.1.2", "webpack-dev-server": "^3.1.10" }, "dependencies": {} }

The name of this command is your choice. I chose to call mine serve since we will be serving our application.

From our terminal or command line, we can run npm run serve and that in turn will run webpack-dev-server --mode development .

The --mode development is what’s called a flag or option. We haven’t talked about this, but it essentially instructs Webpack that you are in development mode. We can also pass in --mode production which we will do when we build our project. These aren’t necessarily required for Webpack to work. Without these, you will get a warning message telling you to provide a mode when you run Webpack .

I say “necessarily required” because Webpack will minimize our code in production mode but not in development. So, don’t think those commands don’t do anything–they do.

Let’s run npm run serve and see what happens.

When we run npm run serve we get some output in our terminal. And, if everything goes well:

And if we scroll up a bit:

Point your browser to //localhost:8080. You will see your Blue Hello World message in Roboto font.

Now, let’s update the project and change the message to Hello Universe. Notice that the webpage refreshes automatically. That’s great, right? Can you think of a downside?

Let’s change the application just a bit and include an input which we will bind a variable to (with v-model). We will output the variable in an

tag below the input. I’ve also updated the styling section to style the message now. Our App.vuefile should look like this:

{{ message }}

export default { data() { return { message: 'Hello world!', }; }, }; .message { font-size: 18px; font-family: 'Roboto', sans-serif; color: blue; }

When we serve our application, we will have an input with a message of Hello World below it. The input is bound to the message variable, so as we type, we change the

content. Go ahead, type into the input to change the

content.

Now go back to your editor, and below the

tag, add the following:

Some Other Message

Save your App.vue and watch what happens.

The h2 we just updated by typing in our input reverted back to Hello World. This is because the browser actually refreshes, and the script tag and page are loaded again. In other words, we were not able to maintain the state of our application. This may not seem like a big deal, but as you are testing your application and adding data to it, it will be frustrating if your app “resets” every time. Fortunately, Webpack offers us a solution called Hot Module Replacement.

The hot module replacement is a plugin provided by Webpack itself. Up until this point, we have not used the Webpack object itself in our configuration file. However, we will now import Webpack so we can access the plugin.

In addition to the plugin, we will pass one additional option to Webpack, the devServer option. In that option, we will set hot to true. Also, we will make an (optional) update to our build workflow: We will open the browser window automatically when we run npm run serve. We do this by setting open to true which is also inside the devServer option.

const HtmlWebpackPlugin = require('html-webpack-plugin'); const VueLoaderPlugin = require('vue-loader/lib/plugin'); const webpack = require('webpack'); module.exports = { entry: './src/main.js', module: { rules: [ { test: /\.js$/, use: 'babel-loader' }, { test: /\.vue$/, use: 'vue-loader' }, { test: /\.css$/, use: ['vue-style-loader', 'css-loader']}, ] }, devServer: { open: true, hot: true, }, plugins: [ new HtmlWebpackPlugin({ template: './src/index.html', }), new VueLoaderPlugin(), new webpack.HotModuleReplacementPlugin(), ] };

Notice that we’ve imported Webpack so we could access the hotModuleReplacementPlugin. We’ve added that to the plugins array, and then told Webpack to use it with hot: true. We open the browser window automatically when we serve the application with open: true.

Run npm run serve:

The browser window should open, and if you open your dev tools, you should notice a slight change in the output. It now tells us hot module replacement is enabled. Let’s type in our input to change the

content. Then, change theh3 tag to read: One More Message.

Save your file and notice what happens.

The browser doesn't refresh, but our

change is reflected! The message we typed in the input remains, but the h3 updates. This allows our application to keep it’s state while we edit it.

Step 7: Building our project

So far, we’ve served our application. But, what if we want to build our application so we can distribute it?

If you noticed, when we serve our application, no files are created. Webpack creates a version of these files that only exist in temporary memory. If we want to distribute our Hello World app to our client, we need to build the project.

This is very simple. Just like before, we will create a script in our package.json file to tell Webpack to build our project. We will use webpack as the command instead of webpack-dev-server. We will pass in the --mode production flag as well.

We will also use the rimraf package first to delete any previous builds we may have. We do this simply by rimraf dist.

dist is the folder Webpack will automatically create when it builds our project. “Dist” is short for distribution–i.e. we are “distributing” our applications code.

The rimraf dist command is telling therimraf package to delete the dist directory. Make sure you don’t rimraf src by accident!

Webpack also offers a plugin that will accomplish this cleaning process called clean-webpack-plugin. I chose dist show an alternative way.

Our package.json file should look like this:

{ "name": "hello-world", "version": "1.0.0", "description": "", "main": "main.js", "scripts": { "clean": "rimraf dist", "build": "npm run clean && webpack --mode production", "serve": "webpack-dev-server --mode development" }, "author": "", "license": "ISC", "devDependencies": { "@babel/core": "^7.1.6", "@babel/preset-env": "^7.1.6", "babel-loader": "^8.0.4", "css-loader": "^1.0.1", "html-webpack-plugin": "^3.2.0", "rimraf": "^2.6.2", "vue": "^2.5.17", "vue-loader": "^15.4.2", "vue-style-loader": "^4.1.2", "vue-template-compiler": "^2.5.17", "webpack": "^4.26.0", "webpack-cli": "^3.1.2", "webpack-dev-server": "^3.1.10" }, "dependencies": {} }

There are three things to notice:

  1. I’ve created a separate clean script so we can run it independently of our build script.
  2. npm run build will call the independent clean script we’ve created.
  3. I have && between npm run clean and webpack. This instruction says: “run npm run clean first, then run webpack”.

Let’s build the project.

npm run build

Webpack creates a dist directory, and our code is inside. Since our code makes no HTTP requests, we can simply open our index.html file in our browser and it will work as expected.

If we had code that was making HTTP requests, we would run into some cross-origin errors as we made those requests. We would need to run that project from a server for it to work.

Let’s examine the index.html that Webpack created in the browser and the code editor.

If we open it in our editor or take a look at the source code in our dev tools you will see Webpack injected the script tag. In our editor though, you won’t see the styles because the style tag is injected dynamically at runtime with JavaScript!

Also, notice our development console information is no longer present. This is because we passed the --production flag to Webpack.

Conclusion

Understanding the build process behind the frameworks you use will help you to better understand the framework itself. Take some time to try to build an Angular, React or another Vue Project without the use of the respective CLIs. Or, just build a basic three-file site (index.html, styles.css, and app.js), but use Webpack to serve and build a production version.

Thanks for reading!

woz