【译】如何搭建一个 Webpack 项目

Webpack 是 web 应用程序的打包器。在过去,你必须在 HTML中手动链接 JavaScript 文件。现在,Webpack负责来解决这个问题。在本教程中,我将带你在一个 JavaScript + HTML 应用程序上完成迷你化的 Webpack 配置。之后,你应该能够自己扩展 Webpack 特性,改进你的 JavaScript 应用,或者你自己站点。

项目文件/文件夹结构

我们将从创建一个distribution文件夹开始。稍后,这个文件夹将用于为你的应用程序提供服务在本地或远程web服务器。为应用程序提供服务,这样就可以在浏览器里查看它,也可以将它托管在外部服务器上,这样每个人都可以通过HTTP访问它。毕竟,distribution文件夹是发布web应用程序所需要的一切。首先,在项目的根目录下用命令创建distribution文件夹和一个HTML文件作为你应用程序的入口点:

mkdir dist
cd dist
touch index.html

文件的名称由你决定。通常会发现它被命名为distpublicbuild。你还可以自己给HTML起一个名字。然而,将其命名为index.html是一种广泛使用的命名约定。下一步,为创建的dist/index.html提供如下内容:

<!DOCTYPE html>
<html>
  <head>
    <title>Hello Webpack</title>
  </head>
  <body>
    <div>
      <h1>Hello Webpack</h1>
    </div>
  </body>
</html>

该文件包含了浏览器中你的站点显示所需的所有HTML。这里目前还没有涉及到JavaScript。为了让你开始使用JavaScript,将下列日志记录放到src/index.js文件中:

console.log('Hello Webpack Project.');

现在,你的项目应该有一个dist/src/文件夹:

- dist/
-- index.html
- src/
-- index.js
- package.json

你可能会想:为什么我们不把所有的文件都放到一个文件夹里呐?这是因为在接下来的步骤中,我们将确保src/文件夹中的所有JavaScript源代码文件都将被绑定到一个单独的JavaScript文件中,该文件将自动放置到dist/文件夹中。通过保持文件夹的分离,你可以确保将应用程序带到web服务器上生产所需的所有内容都位于dist/文件夹中,而实现应用程序所需的所有内容都位于/src文件夹中。

现在,将JavaScript链接到HTML文件最直接的方法是:

<!DOCTYPE html>
<html>
  <head>
    <title>Hello Webpack</title>
  </head>
  <body>
    <div>
      <h1>Hello Webpack</h1>
    </div>
    <script src="../src/index.js"></script>
  </body>
</html>

然而,随着时间的推移,这可能会变成一项重复乏味的工作,因为你必须追踪你的HTML链接了哪些JavaScript文件。这就是为什么我们使用Webpacksrc\文件夹中的所有源码生成为一个JavaScript包,这个包随后自动放入dist/文件夹中。然后,它可以使用如下方式作为HTML文件的入口点:

<!DOCTYPE html>
<html>
  <head>
    <title>Hello Webpack</title>
  </head>
  <body>
    <div>
      <h1>Hello Webpack</h1>
    </div>
    <script src="./bundle.js"></script>
  </body>
</html>

因此,我们需要配置Webpack为我们打包源码。下面就让我们进入Webpack吧。

Webpack 安装

你将使用Webpack打包你的JavaScript源码,并且添加一些高级的特性去构建你的项目用于进一步的构建步骤中。此外,你将使用Webpack Dev Server在本地开发环境中为你的项目提供服务,达到本地服务器开发的目的。最后但并非重要的是,你可以使用Webpack CLI。让我们使用npm来为你的项目安装这三个依赖库(node packages)吧。在你项目的根目录下,输入如下命令,将所有库安装为开发依赖项。

npm install --save-dev webpack webpack-dev-server webpack-cli

注意:开发依赖项不会绑定到生产环境中。(开发依赖项,指明--save-dev)这样,你可以使生产代码的包保持轻量级。例如,如果你希望测试源码,可以在本地开发环境下测试,并且所有测试库安装为开发依赖项,但是这些库并不会包含在实际的生产应用程式中。只有用于运行源代码的依赖项才需要作为生产就绪的依赖项。安装生产依赖项的时候不使用--save-dev标志

作为一个副作用,你应该会发现一个node_modules/文件夹里面包含所有第三方依赖。通常你不需要关心它们。所有的依赖都会在package.json里面列出来,可以看到依赖以及它们的版本号。现在,你的文件夹结构如下:

- dist/
-- index.html
- src/
-- index.js
- node_modules/
- package.json

在你的package.json文件中,将start脚本更改为使用Webpack Dev Server启动的脚本:

{
  ...
  "scripts": {
    "start": "webpack-dev-server --mode development",
    "test": "echo \"Error: no test specified\" && exit 1"
  },
  "keywords": [],
  ...
}

你可以再次在命令行上运行npm start脚本,然而,这次使用Webpack作为本地服务器以开发模式服务你的文件。导航到dist/index.html文件去看看浏览器的输出。你可能在development tools里面看到你的浏览器找不到bundle.js。这是因为你没有告诉Webpack为我们生产它。接下来,让我们看看如何使用Webpack将源码文件从src/文件夹打包到dist/下。因此,将如下内容添加到package.jsonnpm start脚本中。

{
  ...
  "scripts": {
    "start": "webpack-dev-server --config ./webpack.config.js --mode development",
    "test": "echo \"Error: no test specified\" && exit 1"
  },
  "keywords": [],
  ...
}

这个脚本定义了你希望使用Webpack Dev Server和名为webpack.config.js的配置文件。让我们在项目的根目录创建所需的webpack.config.js

touch webpack.config.js

现在你的目录结构看起来应该是这样的:

- dist
-- index.html
- node_modules
- src
-- index.js
- package.json
- webpack.config.js

为新创建的wepack.config.js文件配置如下的配置:

module.exports = {
  // 1
  entry: './src/index.js',
  // 2
  output: {
    path: __dirname + '/dist',
    publicPath: '/',
    filename: 'bundle.js'
  },
  // 3
  devServer: {
    contentBase: './dist'
  }
};

这个Webpack配置文件给出了下列指令:

  • (1) 使用src/index.js文件作为入口点来打包它。如果src/index.js文件中有导入其他的JavaScript文件,也要打包他们。
  • (2) 打包的源码文件将在/dist文件夹下生成一个bundle.js文件。
  • (3) /dist目录将用于服务应用程序给浏览器

完成上述所有事情后,你应该再次启动Webpack Dev Server服务器。在这之前,确保你的dist/index.html已经包含了之前生成的bundle.js文件:

<!DOCTYPE html>
<html>
  <head>
    <title>Hello Webpack</title>
  </head>
  <body>
    <div>
      <h1>Hello Webpack</h1>
    </div>
    <script src="./bundle.js"></script>
  </body>
</html>

使用npm start启动应用程序后,在浏览器中打开应用程序。注意:浏览器的URL在命令行上也应该是可见的。在浏览器中打开应用程序后,应该能够看到dist/index.html文件的输出和src/index.js文件的日志记录。如果从src/index.js文件导入更多的JavaScript源代码文件,它们也将被Webpack绑定到bundle.js中。

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 215,245评论 6 497
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 91,749评论 3 391
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 160,960评论 0 350
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 57,575评论 1 288
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 66,668评论 6 388
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,670评论 1 294
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,664评论 3 415
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,422评论 0 270
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,864评论 1 307
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,178评论 2 331
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,340评论 1 344
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,015评论 5 340
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,646评论 3 323
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,265评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,494评论 1 268
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,261评论 2 368
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,206评论 2 352

推荐阅读更多精彩内容