Как да създадем приложение Vue.js с помощта на еднофайлови компоненти, без CLI.

Разбирането на еднофайловите компоненти (SFC) на Vue и Node Package Manager (NPM) ще бъде полезно за тази статия.

Интерфейсът на командния ред на рамката или CLI е предпочитаният метод за скеле на проект. Той осигурява начална точка на файлове, папки и конфигурация. Това скеле също осигурява процес на разработка и изграждане. Процесът на разработка предоставя начин да видите актуализациите, които се случват, докато редактирате проекта си. Процесът на изграждане създава окончателната версия на файловете, които ще се използват в производството.

Инсталирането и стартирането на Vue.js („Vue“) може да се извърши със скриптов маркер, който сочи към мрежата за доставка на съдържание на Vue (CDN). Не е необходим процес на изграждане или разработване. Но ако използвате Vue еднофайлови компоненти (SFC), трябва да конвертирате тези файлове в нещо, което браузърът може да разбере. Файловете трябва да бъдат преобразувани в Hyper-Text Markup Language (HTML), Cascading Style Sheets (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. Това е друг товарач, който сам по себе си няма да направи много. Нуждаем се от следващия loader, за да направим нещо с 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