A React alkalmazás létrehozása a semmiből a Webpack 4 segítségével

Az elmúlt három hétben a semmiből próbáltam létrehozni egy React alkalmazást, hogy megértsem a Webpack beállításait. Célom egy egyszerű konfiguráció felállítása volt, amelyet aztán fel lehet használni. Küzdelem volt a Webpack megértése. De ennek a Valentino Gagliardi bemutatónak köszönhetően nagyon megvilágosodtam.

Azt tervezem, hogy keresési funkciót készítek néhány hamis (vagy valós) JSON-adattal. Ebben a blogbejegyzésben végigmegyek a projektem felállításán. A következőben azt tervezem, hogy bemutassam a tesztelés beállítását. Szeretnék ehhez egy szervert is hozzáadni a Node.js használatával, de nem vagyok biztos benne, hogy a projektem hatóköréhez erre lenne-e szükség.

( Megjegyzés : Webblokkomat a blogbejegyzés végén adtam meg)

Minden további nélkül folytassuk a beállítást!

Készítsen új projektet és CD- t:

mkdir react_searchcd react_search

Hozzon létre egy package.json fájlt:

npm init

Ha kihagyja az összes kérdést, adja hozzá a -y jelölőt:

npm init -y

Telepítenünk kell a webpack- ot dev-függőségként és webpack-cli néven , hogy a webpack-ot a parancssorban használhassa:

npm i webpack webpack-cli -D
  • i: telepíteni
  • -D: - mentés-dev

Hozzon létre egy src mappát az index.js fájlban, és tegye példaként a következő kódot:

console.log("hello");

Most adja hozzá a következő parancsfájlokat a package.json fájlhoz (félkövérrel):

{ "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" } }

A Webpack 4-nek most két módja van, a fejlesztés és a gyártás, ahol az utóbbiban minimalizálják a kódot.

Nézze meg futtatásával:

npm run start

Ez létrehoz egy dist mappát, benne a main.js fájllal (amely tartalmazza az src kódot).

Ha most fut:

npm run build

A következő kimenet most ilyen:

A React és a Bábel beállítása

A React-kel való együttműködéshez telepítenünk kell Bábellel együtt. Ez átveszi a kódot ES6-ról ES5-re, mivel még nem minden böngésző támogatja az ES6-ot (például az Internet Explorer).

Telepítse a reakciót és a reakció-domént függőségként

npm i react react-dom -S
  • -S: - spórolj

Ezután telepítse a babel-core , a babel-loader , a babel-preset-env és a babel-preset-reag dev függőségeként:

npm i babel-core babel-loader babel-preset-env babel-preset-react -D
  • babel-core : Átalakítja ES6 kódját ES5-vé
  • babel-loader : Webpack segítő a JavaScript függőségek átalakításához (például amikor az összetevőket más összetevőkbe importálja) a Babel segítségével
  • babel-preset-env : Meghatározza, hogy mely transzformációkat / bővítményeket kell használni és a többszörös kitöltéseket (modern funkciókat biztosítanak a régebbi böngészőkben, amelyek nem támogatják natív módon) a támogatni kívánt böngészőmátrix alapján
  • babel-preset- react: Babel preset az összes React pluginhoz, például funkciókká alakítja a JSX-t

Létre kell hoznunk egy webpack.config.js fájlt a babel-loader szabályainak megadásához.

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

Ezután külön fájlt kell készítenünk .babelrc néven, hogy megadjuk a babel-loader lehetőségeit. Felveheti a webpack.config.js fájlba, de láttam, hogy a legtöbb projekt ezt elválasztotta. Ez egyértelműbb olvashatóságot eredményez, és más eszközökkel is használható, amelyek nem kapcsolódnak a webpackhoz. Amikor kijelenti, hogy a webel-konfigurációban babel-loader-t használ, akkor a .babelrc fájlt keresi, ha van ilyen.

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

Ezután módosítsa az index.js fájlt egy összetevő megjelenítéséhez:

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

Létre kell hoznunk egy index.html fájlt is az src mappában, ahová hozzáadhatjuk a szakasz elemünket az id-vel index. Itt adjuk meg fő reakciókomponensünket:

      React and Webpack4     

Most telepítenünk kell a html-webpack-plugin alkalmazást, és ezt fel kell használnunk a webpack konfigurációs fájlunkban. Ez a beépülő modul létrehoz egy HTML fájlt injektálva, írja a th- t a dist / index .html fájlba, és tömöríti a fájlt.

Telepítse a html-webpack-plugint dev-függőségként:

npm i html-webpack-plugin -D

Frissítse a webcsomag-konfigurációt így:

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] };

A plugint így is megadhatja:

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

De ezt inkább egy változóba vonom ki, hogy lássam az általam használt pluginek listáját.

A templatekulcsnak adott érték az, ahol a HTML fájlomat keresem. A fájlnév értéke a tömörített HTML neve, amely a dist mappában jön létre.

Ha most fut, npm run startakkor látnia kell, hogy az index.html a dist mappában jön létre.

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