Как да създадете React приложение от нулата с помощта на Webpack 4

През последните три седмици се опитвам да създам React приложение от нулата, за да разбера настройката с Webpack. Целта ми беше да създам проста конфигурация, която да може да се надгражда. Трудно беше да се разбере Webpack. Но благодарение на този урок на Валентино Галярди съм много просветлен.

Това, което планирам да направя, е да направя функционалност за търсене с някои фалшиви JSON данни (или реални). В тази публикация в блога ще премина през настройката на моя проект. В следващия планирам да покажа как да настроя тестване. Бих искал също да добавя сървър към това, използвайки Node.js, но не съм сигурен дали обхватът на моя проект ще се нуждае от това.

( Забележка : Предоставих настройките си за Webpack в края на тази публикация в блога)

Без повече шум, нека да продължим с настройката!

Направете нов проект и cd в него:

mkdir react_searchcd react_search

Създайте файл package.json :

npm init

Ако искате да пропуснете всички въпроси, добавете флага -y:

npm init -y

Трябва да инсталираме webpack като dev-зависимост и webpack-cli, за да можете да използвате webpack в командния ред:

npm i webpack webpack-cli -D
  • i: инсталирам
  • -D: - save-dev

Създайте src папка с index.js и поставете следния код като пример:

console.log("hello");

Сега добавете следните скриптове към вашия package.json (получер):

{ "name": "react_search", "version": "1.0.0", "description": "Search app using React", "main": "index.js", "scripts": { "start": "webpack --mode development", "build": "webpack --mode production" }, "keywords": [], "author": "", "license": "ISC", "devDependencies": { "webpack": "^4.0.1", "webpack-cli": "^2.0.10" } }

Webpack 4 вече има два режима, разработване и производство, при които в последния код е сведен до минимум.

Вижте сами, като изпълните:

npm run start

Това ще създаде папка dist с main.js файл вътре (съдържащ вашия src код).

Ако сега стартирате:

npm run build

Следният изход вече е такъв:

Настройване на React и Babel

За да работим с React, трябва да го инсталираме заедно с Babel. Това ще транслира кода от ES6 на ES5, тъй като все още не всички браузъри поддържат ES6 (например Internet Explorer).

Инсталирайте response и response-dom като зависимост

npm i react react-dom -S
  • -S: - запазване

След това инсталирайте babel-core , babel-loader , babel-preset-env и babel-preset-response като dev-зависимост:

npm i babel-core babel-loader babel-preset-env babel-preset-react -D
  • babel-core : Трансформира вашия ES6 код в ES5
  • babel-loader : Помощник на Webpack за трансформиране на вашите зависимости на JavaScript (например, когато импортирате компонентите си в други компоненти) с Babel
  • babel-preset-env : Определя кои трансформации / плъгини да се използват и polyfills (осигуряват модерна функционалност за по-стари браузъри, които не я поддържат в основата си) въз основа на матрицата на браузъра, която искате да поддържате
  • babel-preset- response: Babel preset за всички React плъгини, например превръщайки JSX във функции

Трябва да създадем файл webpack.config.js, за да посочим правилата за нашия babel-loader.

module.exports = { module: { rules: [ { test: /\.js$/, exclude: /node_modules/, use: { loader: "babel-loader" } } ] } };

След това трябва да направим отделен файл, наречен .babelrc, за да предоставим опциите за babel-loader. Можете да го включите във файла webpack.config.js, но видях, че повечето проекти са отделили това. Това води до по-ясна четливост и може да се използва от други инструменти, несвързани с webpack. Когато заявите, че използвате babel-loader в конфигурацията на вашия уеб пакет, той ще търси .babelrc файл, ако има такъв.

{ "presets": ["env", "react"] }

След това променете файла index.js, за да изобразите компонент:

import React from "react"; import ReactDOM from "react-dom"; const Index = () => { return Hello React! ; }; ReactDOM.render(, document.getElementById("index"));

Също така ще трябва да създадем файл index.html в папката src, където можем да добавим елемента на раздела с идентификатор index. Тук представяме основния си реагиращ компонент:

      React and Webpack4     

Сега трябва да инсталираме плъгин html-webpack и да го използваме в нашия конфигурационен файл на webpack. Този плъгин генерира HTML файл с инжектиран, пише th is to dist / index .html и минимизира файла.

Инсталирайте приставката html-webpack- като разработка:

npm i html-webpack-plugin -D

Актуализирайте конфигурацията на webpack така:

const HtmlWebPackPlugin = require("html-webpack-plugin"); const htmlPlugin = new HtmlWebPackPlugin({ template: "./src/index.html", filename: "./index.html" }); module.exports = { module: { rules: [ { test: /\.js$/, exclude: /node_modules/, use: { loader: "babel-loader" } } ] }, plugins: [htmlPlugin] };

Можете също да въведете приставката по следния начин:

plugins: [ new HtmlWebPackPlugin({ template: "./src/index.html", filename: "./index.html" }); ]

Но предпочитам да извлека това в променлива, за да мога да видя списъка с приставки, които използвам.

Стойността, която давам на templateключа, е мястото, където търся моя HTML файл. Стойността на името на файла е името на минифицирания HTML, който ще бъде генериран в папката dist.

Ако сега стартирате, npm run startтрябва да видите, че index.html се генерира в папката dist.

Run open dist/index.html and you should see “Hello React” in your browser.

Setting up webpack-dev-server

It is a bit tedious to keep running this command every time you want to see your changes in the browser. To have webpack “watch” our changes and thus refresh whenever we have made changes to any of our components, we can use webpack-dev-server module.

Go ahead and install this as a dev dependency

npm i webpack-dev-server -D

Then change your package.json start scripts like so (in bold):

{ "name": "react_search", "version": "1.0.0", "description": "Search app using React", "main": "index.js", "scripts": { "start": "webpack-dev-server --mode development --open", "build": "webpack --mode production" }, "keywords": [], "author": "", "license": "ISC", "dependencies": { "react": "^16.2.0", "react-dom": "^16.2.0" "devDependencies": { "babel-core": "^6.26.0", "babel-loader": "^7.1.4", "babel-preset-env": "^1.6.1", "babel-preset-react": "^6.24.1", "html-webpack-plugin": "^3.0.6", "webpack": "^4.1.1", "webpack-cli": "^2.0.10", "webpack-dev-server": "^3.1.0" } }

If you now run npm run start you should see localhost:8080 open up in your default browser — that’s what the —-open flag is for. Now everytime you make changes, it will refresh the page.

You can also add a --hot flag to your npm start script which will allow you to only reload the component that you’ve changed instead of doing a full page reload. This is Hot Module Replacement.

Setting up CSS

The last part involves setting up our CSS. As we will be importing CSS files into our React components, we need css-loader module to resolve them. Once that’s resolved, we also need a style-loader to inject this into our DOM — adding a tag into the element of our HTML.

Go ahead and install both of these modules as a dev dependency:

npm i css-loader style-loader -D

We then need to update our webpack.config.js file like so:

const HtmlWebPackPlugin = require("html-webpack-plugin"); const htmlWebpackPlugin = new HtmlWebPackPlugin({ template: "./src/index.html", filename: "./index.html" }); module.exports = { module: { rules: [ { test: /\.js$/, exclude: /node_modules/, use: { loader: "babel-loader" } }, { test: /\.css$/, use: ["style-loader", "css-loader"] } ] }, plugins: [htmlWebpackPlugin] };

Note that the order of adding these loaders is important. First, we need to resolve the CSS files before adding them to the DOM with the style-loader. By default, webpack uses the loaders from the right (last element in the array) to the left (first element in the array).

Making CSS modular

We can also make CSS modular using webpack. This means class name will be scoped locally and specific to only the component in question.

To do this, we can provide some options to css-loader:

const HtmlWebPackPlugin = require("html-webpack-plugin"); const htmlWebpackPlugin = new HtmlWebPackPlugin({ template: "./src/index.html", filename: "./index.html" }); module.exports = { module: { rules: [ { test: /\.js$/, exclude: /node_modules/, use: { loader: "babel-loader" } }, { test: /\.css$/, use: [ { loader: "style-loader" }, { loader: "css-loader", options: { modules: true, importLoaders: 1, localIdentName: "[name]_[local]_[hash:base64]", sourceMap: true, minimize: true } } ] } ] }, plugins: [htmlWebpackPlugin] };

As we need to give options, each loader is now an object with a key-value pair. To enable CSS modules, we need to set module option for css-loader to be true. The importLoaders option configures how many loaders before css-loader should be applied. For example, sass-loader would have to come before css-loader.

The localIdentName allows you to configure the generated identification.

  • [name] will take the name of your component
  • [local] is the name of your class/id
  • [hash:base64] is the randomly generated hash which will be unique in every component’s CSS

To make this a bit more visual, I’ll give you an example. Say I have a component named Form and I have a button with a CSS class primaryButton. I also have another component called Search and a button in it with a CSS class primaryButton. However, both of these classes have different CSS:

Form button.primaryButton { background-color: green; } Search button.primaryButton { background-color: blue; }

When webpack bundles your application, depending on which CSS comes latest, both of your buttons could have the color green or blue instead of Form having green and Search having blue.

This is where the localIdentName comes into place. With this, once your application is bundled, your buttons will have a unique class name!

As you can see, the button class name in the Form component is different to the one in the Search component — their naming starts with the name of the component, class name, and unique hash code.

So with this, you won’t have to worry about whether you have given the same class name throughout your whole application — you only have to worry about whether you have used it in the same component.

This concludes the first part of setting a React app from scratch. In the next blog post, I aim to explain how to set up tests for TDD and how to write them.

Please let me know if something is unclear and I’ll explain the best as I can. I value and welcome constructive feedback as this helps me to improve :)

Hope this helps!

EDIT

Importing CSS

I’ve had a few comments asking me how they can render CSS which I didn’t touch on previously. What you need to do is import the CSS file in your React component. For example, say you have a Search component and this is your tree directory:

You will need to import your CSS file in your Search component like so:

import style from "./Search.css"

You can then apply different CSS class styles such as:

const Search = () => { return Hello Search Component :) }

You don’t have to call it style but what I found is that most people have given it this name in their projects.

My Webpack boilerplate

For anyone who wants a quick clone of this Webpack setup, I have this on my GitHub. I’ve also included a more succinct guide in the README.

Entry and output points

Webpack 4 by default has a default entry point of index.js in your src folder. If you would like to point to a different file, you can do so by specifying an entry point in your webpack config file:

e.g.

module.exports = { entry: "./src/app.js", module: { ... } }

You can also specify output file like so:

const path = require('path') module.exports = { entry: "./src/app.js", output: { path: path.resolve(‘dist’), filename: ‘bundled.js’ }, module: { ... } }

Thanks to Gudu Kassa for pointing this out!

If you have found this helpful please share it on social media :)

www.pinglinh.com

Follow me on Twitter | Check out my LinkedIn | See my GitHub