123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446 |
- <!DOCTYPE HTML>
- <html lang="zh-hans" >
- <head>
- <meta charset="UTF-8">
- <meta content="text/html; charset=utf-8" http-equiv="Content-Type">
- <title>3-13 构建 Npm 模块 · 深入浅出 Webpack</title>
- <meta http-equiv="X-UA-Compatible" content="IE=edge" />
- <meta name="description" content="">
- <meta name="generator" content="GitBook 3.2.3">
- <meta name="author" content="吴浩麟">
- <meta name="identifier" content="9787121331725" scheme="ISBN">
-
-
- <link rel="stylesheet" href="../gitbook/style.css">
-
-
-
- <link rel="stylesheet" href="../gitbook/gitbook-plugin-modal/index.css">
-
-
-
- <link rel="stylesheet" href="../gitbook/gitbook-plugin-highlight/website.css">
-
-
-
- <link rel="stylesheet" href="../gitbook/gitbook-plugin-search/search.css">
-
-
-
- <link rel="stylesheet" href="../gitbook/gitbook-plugin-fontsettings/website.css">
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- <meta name="HandheldFriendly" content="true"/>
- <meta name="viewport" content="width=device-width, initial-scale=1, user-scalable=no">
- <meta name="apple-mobile-web-app-capable" content="yes">
- <meta name="apple-mobile-web-app-status-bar-style" content="black">
- <link rel="apple-touch-icon-precomposed" sizes="152x152" href="../gitbook/images/apple-touch-icon-precomposed-152.png">
- <link rel="shortcut icon" href="../gitbook/images/favicon.ico" type="image/x-icon">
-
- <link rel="next" href="3-14构建离线应用.html" />
-
-
- <link rel="prev" href="3-12构建Electron应用.html" />
-
- <style>
- @media only screen and (max-width: 640px) {
- .book-header .hidden-mobile {
- display: none;
- }
- }
- </style>
- <script>
- window["gitbook-plugin-github-buttons"] = {"buttons":[{"user":"gwuhaolin","type":"follow","size":"small","width":"150"},{"user":"gwuhaolin","repo":"dive-into-webpack","type":"star","size":"small"}]};
- </script>
- </head>
- <body>
-
- <div class="book">
- <div class="book-summary">
-
-
- <div id="book-search-input" role="search">
- <input type="text" placeholder="输入并搜索" />
- </div>
-
- <nav role="navigation">
-
- <ul class="summary">
-
-
-
-
-
-
- <li class="chapter " data-level="1.1" data-path="../">
-
- <a href="../">
-
-
- 深入浅出 Webpack
-
- </a>
-
-
- </li>
- <li class="chapter " data-level="1.2" data-path="../前言.html">
-
- <a href="../前言.html">
-
-
- 前言
-
- </a>
-
-
- </li>
- <li class="chapter " data-level="1.3" data-path="../1入门/">
-
- <a href="../1入门/">
-
-
- 第1章 入门
-
- </a>
-
-
- <ul class="articles">
-
- <li class="chapter " data-level="1.3.1" data-path="../1入门/1-1前端的发展.html">
-
- <a href="../1入门/1-1前端的发展.html">
-
-
- 1-1 前端的发展
-
- </a>
-
-
- </li>
- <li class="chapter " data-level="1.3.2" data-path="../1入门/1-2常见的构建工具及对比.html">
-
- <a href="../1入门/1-2常见的构建工具及对比.html">
-
-
- 1-2 常见的构建工具及对比
-
- </a>
-
-
- </li>
- <li class="chapter " data-level="1.3.3" data-path="../1入门/1-3安装与使用.html">
-
- <a href="../1入门/1-3安装与使用.html">
-
-
- 1-3 安装与使用
-
- </a>
-
-
- </li>
- <li class="chapter " data-level="1.3.4" data-path="../1入门/1-4使用Loader.html">
-
- <a href="../1入门/1-4使用Loader.html">
-
-
- 1-4 使用 Loader
-
- </a>
-
-
- </li>
- <li class="chapter " data-level="1.3.5" data-path="../1入门/1-5使用Plugin.html">
-
- <a href="../1入门/1-5使用Plugin.html">
-
-
- 1-5 使用 Plugin
-
- </a>
-
-
- </li>
- <li class="chapter " data-level="1.3.6" data-path="../1入门/1-6使用DevServer.html">
-
- <a href="../1入门/1-6使用DevServer.html">
-
-
- 1-6 使用 DevServer
-
- </a>
-
-
- </li>
- <li class="chapter " data-level="1.3.7" data-path="../1入门/1-7核心概念.html">
-
- <a href="../1入门/1-7核心概念.html">
-
-
- 1-7 核心概念
-
- </a>
-
-
- </li>
- </ul>
-
- </li>
- <li class="chapter " data-level="1.4" data-path="../2配置/">
-
- <a href="../2配置/">
-
-
- 第2章 配置
-
- </a>
-
-
- <ul class="articles">
-
- <li class="chapter " data-level="1.4.1" data-path="../2配置/2-1Entry.html">
-
- <a href="../2配置/2-1Entry.html">
-
-
- 2-1 Entry
-
- </a>
-
-
- </li>
- <li class="chapter " data-level="1.4.2" data-path="../2配置/2-2Output.html">
-
- <a href="../2配置/2-2Output.html">
-
-
- 2-2 Output
-
- </a>
-
-
- </li>
- <li class="chapter " data-level="1.4.3" data-path="../2配置/2-3Module.html">
-
- <a href="../2配置/2-3Module.html">
-
-
- 2-3 Module
-
- </a>
-
-
- </li>
- <li class="chapter " data-level="1.4.4" data-path="../2配置/2-4Resolve.html">
-
- <a href="../2配置/2-4Resolve.html">
-
-
- 2-4 Resolve
-
- </a>
-
-
- </li>
- <li class="chapter " data-level="1.4.5" data-path="../2配置/2-5Plugins.html">
-
- <a href="../2配置/2-5Plugins.html">
-
-
- 2-5 Plugins
-
- </a>
-
-
- </li>
- <li class="chapter " data-level="1.4.6" data-path="../2配置/2-6DevServer.html">
-
- <a href="../2配置/2-6DevServer.html">
-
-
- 2-6 DevServer
-
- </a>
-
-
- </li>
- <li class="chapter " data-level="1.4.7" data-path="../2配置/2-7其它配置项.html">
-
- <a href="../2配置/2-7其它配置项.html">
-
-
- 2-7 其它配置项
-
- </a>
-
-
- </li>
- <li class="chapter " data-level="1.4.8" data-path="../2配置/2-8整体配置结构.html">
-
- <a href="../2配置/2-8整体配置结构.html">
-
-
- 2-8 整体配置结构
-
- </a>
-
-
- </li>
- <li class="chapter " data-level="1.4.9" data-path="../2配置/2-9多种配置类型.html">
-
- <a href="../2配置/2-9多种配置类型.html">
-
-
- 2-9 多种配置类型
-
- </a>
-
-
- </li>
- <li class="chapter " data-level="1.4.10" data-path="../2配置/2-10配置总结.html">
-
- <a href="../2配置/2-10配置总结.html">
-
-
- 2-10 配置总结
-
- </a>
-
-
- </li>
- </ul>
-
- </li>
- <li class="chapter " data-level="1.5" data-path="./">
-
- <a href="./">
-
-
- 第3章 实战
-
- </a>
-
-
- <ul class="articles">
-
- <li class="chapter " data-level="1.5.1" data-path="3-1使用ES6语言.html">
-
- <a href="3-1使用ES6语言.html">
-
-
- 3-1 使用 ES6 语言
-
- </a>
-
-
- </li>
- <li class="chapter " data-level="1.5.2" data-path="3-2使用TypeScript语言.html">
-
- <a href="3-2使用TypeScript语言.html">
-
-
- 3-2 使用 TypeScript 语言
-
- </a>
-
-
- </li>
- <li class="chapter " data-level="1.5.3" data-path="3-3使用Flow检查器.html">
-
- <a href="3-3使用Flow检查器.html">
-
-
- 3-3 使用 Flow 检查器
-
- </a>
-
-
- </li>
- <li class="chapter " data-level="1.5.4" data-path="3-4使用SCSS语言.html">
-
- <a href="3-4使用SCSS语言.html">
-
-
- 3-4 使用 SCSS
-
- </a>
-
-
- </li>
- <li class="chapter " data-level="1.5.5" data-path="3-5使用PostCSS.html">
-
- <a href="3-5使用PostCSS.html">
-
-
- 3-5 使用 PostCSS
-
- </a>
-
-
- </li>
- <li class="chapter " data-level="1.5.6" data-path="3-6使用React框架.html">
-
- <a href="3-6使用React框架.html">
-
-
- 3-6 使用 React 框架
-
- </a>
-
-
- </li>
- <li class="chapter " data-level="1.5.7" data-path="3-7使用Vue框架.html">
-
- <a href="3-7使用Vue框架.html">
-
-
- 3-7 使用 Vue 框架
-
- </a>
-
-
- </li>
- <li class="chapter " data-level="1.5.8" data-path="3-8使用Angular2框架.html">
-
- <a href="3-8使用Angular2框架.html">
-
-
- 3-8 使用 Angular2 框架
-
- </a>
-
-
- </li>
- <li class="chapter " data-level="1.5.9" data-path="3-9为单页应用生成HTML.html">
-
- <a href="3-9为单页应用生成HTML.html">
-
-
- 3-9 为单页应用生成 HTML
-
- </a>
-
-
- </li>
- <li class="chapter " data-level="1.5.10" data-path="3-10管理多个单页应用.html">
-
- <a href="3-10管理多个单页应用.html">
-
-
- 3-10 管理多个单页应用
-
- </a>
-
-
- </li>
- <li class="chapter " data-level="1.5.11" data-path="3-11构建同构应用.html">
-
- <a href="3-11构建同构应用.html">
-
-
- 3-11 构建同构应用
-
- </a>
-
-
- </li>
- <li class="chapter " data-level="1.5.12" data-path="3-12构建Electron应用.html">
-
- <a href="3-12构建Electron应用.html">
-
-
- 3-12 构建 Electron 应用
-
- </a>
-
-
- </li>
- <li class="chapter active" data-level="1.5.13" data-path="3-13构建Npm模块.html">
-
- <a href="3-13构建Npm模块.html">
-
-
- 3-13 构建 Npm 模块
-
- </a>
-
-
- </li>
- <li class="chapter " data-level="1.5.14" data-path="3-14构建离线应用.html">
-
- <a href="3-14构建离线应用.html">
-
-
- 3-14 构建离线应用
-
- </a>
-
-
- </li>
- <li class="chapter " data-level="1.5.15" data-path="3-15搭配NpmScript.html">
-
- <a href="3-15搭配NpmScript.html">
-
-
- 3-15 搭配 Npm Script
-
- </a>
-
-
- </li>
- <li class="chapter " data-level="1.5.16" data-path="3-16检查代码.html">
-
- <a href="3-16检查代码.html">
-
-
- 3-16 检查代码
-
- </a>
-
-
- </li>
- <li class="chapter " data-level="1.5.17" data-path="3-17通过Node.jsAPI启动Webpack.html">
-
- <a href="3-17通过Node.jsAPI启动Webpack.html">
-
-
- 3-17 通过 Node.js API 启动 Webpack
-
- </a>
-
-
- </li>
- <li class="chapter " data-level="1.5.18" data-path="3-18使用WebpackDevMiddleware.html">
-
- <a href="3-18使用WebpackDevMiddleware.html">
-
-
- 3-18 使用 Webpack Dev Middleware
-
- </a>
-
-
- </li>
- <li class="chapter " data-level="1.5.19" data-path="3-19加载图片.html">
-
- <a href="3-19加载图片.html">
-
-
- 3-19 加载图片
-
- </a>
-
-
- </li>
- <li class="chapter " data-level="1.5.20" data-path="3-20加载SVG.html">
-
- <a href="3-20加载SVG.html">
-
-
- 3-20 加载SVG
-
- </a>
-
-
- </li>
- <li class="chapter " data-level="1.5.21" data-path="3-21加载SourceMap.html">
-
- <a href="3-21加载SourceMap.html">
-
-
- 3-21 加载 Source Map
-
- </a>
-
-
- </li>
- <li class="chapter " data-level="1.5.22" data-path="3-22实战总结.html">
-
- <a href="3-22实战总结.html">
-
-
- 3-22 实战总结
-
- </a>
-
-
- </li>
- </ul>
-
- </li>
- <li class="chapter " data-level="1.6" data-path="../4优化/">
-
- <a href="../4优化/">
-
-
- 第4章 优化
-
- </a>
-
-
- <ul class="articles">
-
- <li class="chapter " data-level="1.6.1" data-path="../4优化/4-1缩小文件搜索范围.html">
-
- <a href="../4优化/4-1缩小文件搜索范围.html">
-
-
- 4-1 缩小文件搜索范围
-
- </a>
-
-
- </li>
- <li class="chapter " data-level="1.6.2" data-path="../4优化/4-2使用DllPlugin.html">
-
- <a href="../4优化/4-2使用DllPlugin.html">
-
-
- 4-2 使用 DllPlugin
-
- </a>
-
-
- </li>
- <li class="chapter " data-level="1.6.3" data-path="../4优化/4-3使用HappyPack.html">
-
- <a href="../4优化/4-3使用HappyPack.html">
-
-
- 4-3 使用 HappyPack
-
- </a>
-
-
- </li>
- <li class="chapter " data-level="1.6.4" data-path="../4优化/4-4使用ParallelUglifyPlugin.html">
-
- <a href="../4优化/4-4使用ParallelUglifyPlugin.html">
-
-
- 4-4 使用 ParallelUglifyPlugin
-
- </a>
-
-
- </li>
- <li class="chapter " data-level="1.6.5" data-path="../4优化/4-5使用自动刷新.html">
-
- <a href="../4优化/4-5使用自动刷新.html">
-
-
- 4-5 使用自动刷新
-
- </a>
-
-
- </li>
- <li class="chapter " data-level="1.6.6" data-path="../4优化/4-6开启模块热替换.html">
-
- <a href="../4优化/4-6开启模块热替换.html">
-
-
- 4-6 开启模块热替换
-
- </a>
-
-
- </li>
- <li class="chapter " data-level="1.6.7" data-path="../4优化/4-7区分环境.html">
-
- <a href="../4优化/4-7区分环境.html">
-
-
- 4-7 区分环境
-
- </a>
-
-
- </li>
- <li class="chapter " data-level="1.6.8" data-path="../4优化/4-8压缩代码.html">
-
- <a href="../4优化/4-8压缩代码.html">
-
-
- 4-8 压缩代码
-
- </a>
-
-
- </li>
- <li class="chapter " data-level="1.6.9" data-path="../4优化/4-9CDN加速.html">
-
- <a href="../4优化/4-9CDN加速.html">
-
-
- 4-9 CDN 加速
-
- </a>
-
-
- </li>
- <li class="chapter " data-level="1.6.10" data-path="../4优化/4-10使用TreeShaking.html">
-
- <a href="../4优化/4-10使用TreeShaking.html">
-
-
- 4-10 使用 Tree Shaking
-
- </a>
-
-
- </li>
- <li class="chapter " data-level="1.6.11" data-path="../4优化/4-11提取公共代码.html">
-
- <a href="../4优化/4-11提取公共代码.html">
-
-
- 4-11 提取公共代码
-
- </a>
-
-
- </li>
- <li class="chapter " data-level="1.6.12" data-path="../4优化/4-12按需加载.html">
-
- <a href="../4优化/4-12按需加载.html">
-
-
- 4-12 按需加载
-
- </a>
-
-
- </li>
- <li class="chapter " data-level="1.6.13" data-path="../4优化/4-13使用Prepack.html">
-
- <a href="../4优化/4-13使用Prepack.html">
-
-
- 4-13 使用 Prepack
-
- </a>
-
-
- </li>
- <li class="chapter " data-level="1.6.14" data-path="../4优化/4-14开启ScopeHoisting.html">
-
- <a href="../4优化/4-14开启ScopeHoisting.html">
-
-
- 4-14 开启 Scope Hoisting
-
- </a>
-
-
- </li>
- <li class="chapter " data-level="1.6.15" data-path="../4优化/4-15输出分析.html">
-
- <a href="../4优化/4-15输出分析.html">
-
-
- 4-15 输出分析
-
- </a>
-
-
- </li>
- <li class="chapter " data-level="1.6.16" data-path="../4优化/4-16优化总结.html">
-
- <a href="../4优化/4-16优化总结.html">
-
-
- 4-16 优化总结
-
- </a>
-
-
- </li>
- </ul>
-
- </li>
- <li class="chapter " data-level="1.7" data-path="../5原理/">
-
- <a href="../5原理/">
-
-
- 第5章 原理
-
- </a>
-
-
- <ul class="articles">
-
- <li class="chapter " data-level="1.7.1" data-path="../5原理/5-1工作原理概括.html">
-
- <a href="../5原理/5-1工作原理概括.html">
-
-
- 5-1 工作原理概括
-
- </a>
-
-
- </li>
- <li class="chapter " data-level="1.7.2" data-path="../5原理/5-2输出文件分析.html">
-
- <a href="../5原理/5-2输出文件分析.html">
-
-
- 5-2 输出文件分析
-
- </a>
-
-
- </li>
- <li class="chapter " data-level="1.7.3" data-path="../5原理/5-3编写Loader.html">
-
- <a href="../5原理/5-3编写Loader.html">
-
-
- 5-3 编写 Loader
-
- </a>
-
-
- </li>
- <li class="chapter " data-level="1.7.4" data-path="../5原理/5-4编写Plugin.html">
-
- <a href="../5原理/5-4编写Plugin.html">
-
-
- 5-4 编写 Plugin
-
- </a>
-
-
- </li>
- <li class="chapter " data-level="1.7.5" data-path="../5原理/5-5调试Webpack.html">
-
- <a href="../5原理/5-5调试Webpack.html">
-
-
- 5-5 调试 Webpack
-
- </a>
-
-
- </li>
- <li class="chapter " data-level="1.7.6" data-path="../5原理/5-6原理总结.html">
-
- <a href="../5原理/5-6原理总结.html">
-
-
- 5-6 原理总结
-
- </a>
-
-
- </li>
- </ul>
-
- </li>
- <li class="chapter " data-level="1.8" >
-
- <span>
-
-
- 附录
-
- </span>
-
-
- <ul class="articles">
-
- <li class="chapter " data-level="1.8.1" data-path="../附录/常用Loaders.html">
-
- <a href="../附录/常用Loaders.html">
-
-
- 常用 Loaders
-
- </a>
-
-
- </li>
- <li class="chapter " data-level="1.8.2" data-path="../附录/常用Plugins.html">
-
- <a href="../附录/常用Plugins.html">
-
-
- 常用 Plugins
-
- </a>
-
-
- </li>
- <li class="chapter " data-level="1.8.3" data-path="../附录/其它Webpack学习资源.html">
-
- <a href="../附录/其它Webpack学习资源.html">
-
-
- 其它 Webpack 学习资源
-
- </a>
-
-
- </li>
- </ul>
-
- </li>
-
- <li class="divider"></li>
- <li id="codefund_ad">
- <script src="https://codesponsor.io/scripts/5da524c5-301a-4ef4-8b42-696edd22e693/embed.js"></script>
- </li>
- </ul>
- </nav>
-
-
- </div>
- <div class="book-body">
-
- <div class="body-inner">
-
-
- <div class="book-header" role="navigation">
-
- <!-- Title -->
- <h1>
- <i class="fa fa-circle-o-notch fa-spin"></i>
- <a href=".." >3-13 构建 Npm 模块</a>
- </h1>
- </div>
- <div class="page-wrapper" tabindex="-1" role="main">
- <div class="page-inner">
-
- <div id="book-search-results">
- <div class="search-noresults">
-
- <section class="normal markdown-section">
-
- <h1 id="3-13-构建-npm-模块">3-13 构建 Npm 模块</h1>
- <h2 id="认识-npm">认识 Npm</h2>
- <p><a href="https://www.npmjs.com" target="_blank">Npm</a> 是目前最大的 JavaScript 模块仓库,里面有来自全世界开发者上传的可复用模块。
- 虽然大多数情况下你都是这些开放模块的使用者,但有时候你也许会成为贡献者,开发一个模块上传到 Npm 仓库。</p>
- <p>发布到 Npm 仓库的模块有以下几个特点:</p>
- <ul>
- <li>每个模块根目录下都必须有一个描述该模块的 <code>package.json</code> 文件。该文件描述了模块的入口文件是哪个,该模块又依赖哪些模块等。想深入了解可以阅读文章 <a href="http://javascript.ruanyifeng.com/nodejs/packagejson.html" target="_blank">package.json文件</a>。</li>
- <li>模块中的文件以 JavaScript 文件为主,但不限于 JavaScript 文件。例如一个 UI 组件模块可能同时需要 JavaScript、CSS、图片文件等。</li>
- <li>模块中的代码大多采用模块化规范,因为你的这个模块可能依赖其它模块,而且别的模块又可能依赖你的这个模块。因为目前支持比较广泛的是 CommonJS 模块化规范,上传到 Npm 仓库的代码最好遵守该规范。</li>
- </ul>
- <h2 id="抛出问题">抛出问题</h2>
- <p>Webpack 不仅可用于构建运行的应用,也可用于构建上传到 Npm 的模块。
- 接下来用教大家如何用 Webpack 构建一个可上传的 Npm 仓库的 React 组件,具体要求如下:</p>
- <ol>
- <li>源代码采用 ES6 写,但发布到 Npm 仓库的需要是 ES5 的,并且遵守 CommonJS 模块化规范。如果发布到 Npm 上去的 ES5 代码是经过转换的,请同时提供 Source Map 以方便调试。</li>
- <li>该 UI 组件依赖的其它资源文件例如 CSS 文件也需要包含在发布的模块里。</li>
- <li>尽量减少冗余代码,减少发布出去的组件的代码文件大小。</li>
- <li>发布出去的组件的代码中不能含有其依赖的模块的代码,而是让用户可选择性的去安装。例如不能内嵌 React 库的代码,这样做的目的是在其它组件也依赖 React 库时,防止 React 库的代码被重复打包。</li>
- </ol>
- <p>在开始前先看下最终发布到 Npm 仓库的模块的目录结构:</p>
- <pre><code>node_modules/hello-webpack
- ├── lib
- │ ├── index.css (组件所有依赖的 CSS 都在这个文件中)
- │ ├── index.css.map
- │ ├── index.js (符合 CommonJS 模块化规范的 ES5 代码)
- │ └── index.js.map
- ├── src (ES6 源码)
- │ ├── index.css
- │ └── index.js
- └── package.json (模块描述文件)
- </code></pre><p>由于本节的重点不在于 React 而在于 Webpack,所以写一个最简单的 React 组件,其代码放在 <code>src/index.js</code> 文件中,内容如下:</p>
- <pre><code class="lang-jsx"><span class="hljs-keyword">import</span> React, { Component } <span class="hljs-keyword">from</span> <span class="hljs-string">'react'</span>;
- <span class="hljs-keyword">import</span> <span class="hljs-string">'./index.css'</span>;
- <span class="hljs-comment">// 导出该组件供给其它模块使用</span>
- <span class="hljs-keyword">export</span> <span class="hljs-keyword">default</span> <span class="hljs-class"><span class="hljs-keyword">class</span> <span class="hljs-title">HelloWebpack</span> <span class="hljs-keyword">extends</span> <span class="hljs-title">Component</span> </span>{
- render() {
- <span class="hljs-keyword">return</span> <span class="xml"><span class="hljs-tag"><<span class="hljs-name">h1</span> <span class="hljs-attr">className</span>=<span class="hljs-string">"hello-component"</span>></span>Hello,Webpack<span class="hljs-tag"></<span class="hljs-name">h1</span>></span></span>
- }
- }
- </code></pre>
- <p>要使用该模块时只需要这样:</p>
- <pre><code class="lang-jsx"><span class="hljs-comment">// 通过 ES6 语法导入</span>
- <span class="hljs-keyword">import</span> HelloWebpack <span class="hljs-keyword">from</span> <span class="hljs-string">'hello-webpack'</span>;
- <span class="hljs-keyword">import</span> <span class="hljs-string">'hello-webpack/lib/index.css'</span>;
- <span class="hljs-comment">// 或者通过 ES5 语法导入</span>
- <span class="hljs-keyword">var</span> HelloWebpack = <span class="hljs-built_in">require</span>(<span class="hljs-string">'hello-webpack'</span>);
- <span class="hljs-built_in">require</span>(<span class="hljs-string">'hello-webpack/lib/index.css'</span>);
- <span class="hljs-comment">// 使用 react-dom 渲染</span>
- render(<span class="xml"><span class="hljs-tag"><<span class="hljs-name">HelloWebpack</span>/></span></span>);
- </code></pre>
- <h2 id="使用-webpack-构建-npm-模块">使用 Webpack 构建 Npm 模块</h2>
- <p>接下来用 Webpack 一条条来解决上面抛出问题的4点要求。</p>
- <h4 id="对于要求1,可以这样做到:">对于要求1,可以这样做到:</h4>
- <ul>
- <li>使用 babel-loader 把 ES6 代码转换成 ES5 的代码。</li>
- <li>通过开启 <code>devtool: 'source-map'</code> 输出 Source Map 以发布调试。</li>
- <li>设置 <code>output.libraryTarget='commonjs2'</code> 使输出的代码符合CommonJS2 模块化规范,以供给其它模块导入使用。在<a href="../2配置/2-2Output.html">2-2 Output-libraryTarget 和 library</a> 有介绍这个配置的含义。</li>
- </ul>
- <p>相关的 Webpack 配置代码如下:</p>
- <pre><code class="lang-js"><span class="hljs-built_in">module</span>.exports = {
- output: {
- <span class="hljs-comment">// 输出的代码符合 CommonJS 模块化规范,以供给其它模块导入使用。</span>
- libraryTarget: <span class="hljs-string">'commonjs2'</span>,
- },
- <span class="hljs-comment">// 输出 Source Map</span>
- devtool: <span class="hljs-string">'source-map'</span>,
- };
- </code></pre>
- <h4 id="对于要求2,需要通过-css-loader-和-extract-text-webpack-plugin-实现,相关的-webpack-配置代码如下:">对于要求2,需要通过 css-loader 和 extract-text-webpack-plugin 实现,相关的 Webpack 配置代码如下:</h4>
- <pre><code class="lang-js"><span class="hljs-keyword">const</span> ExtractTextPlugin = <span class="hljs-built_in">require</span>(<span class="hljs-string">'extract-text-webpack-plugin'</span>);
- <span class="hljs-built_in">module</span>.exports = {
- <span class="hljs-built_in">module</span>: {
- rules: [
- {
- <span class="hljs-comment">// 增加对 CSS 文件的支持</span>
- test: <span class="hljs-regexp">/\.css$/</span>,
- <span class="hljs-comment">// 提取出 Chunk 中的 CSS 代码到单独的文件中</span>
- use: ExtractTextPlugin.extract({
- use: [<span class="hljs-string">'css-loader'</span>]
- }),
- },
- ]
- },
- plugins: [
- <span class="hljs-keyword">new</span> ExtractTextPlugin({
- <span class="hljs-comment">// 输出的 CSS 文件名称</span>
- filename: <span class="hljs-string">'index.css'</span>,
- }),
- ],
- };
- </code></pre>
- <p>此步引入了3个新依赖:</p>
- <pre><code class="lang-bash"><span class="hljs-comment"># 安装 Webpack 构建所需要的新依赖</span>
- npm i -D style-loader css-loader extract-text-webpack-plugin
- </code></pre>
- <h4 id="对于要求3,需要注意的是-babel-在把-es6-代码转换成-es5-代码时会注入一些辅助函数。">对于要求3,需要注意的是 Babel 在把 ES6 代码转换成 ES5 代码时会注入一些辅助函数。</h4>
- <p>例如下面这段 ES6 代码</p>
- <pre><code class="lang-js"><span class="hljs-class"><span class="hljs-keyword">class</span> <span class="hljs-title">HelloWebpack</span> <span class="hljs-keyword">extends</span> <span class="hljs-title">Component</span></span>{
- }
- </code></pre>
- <p>在被转换成能正常运行的 ES5 代码时需要以下2个辅助函数:</p>
- <ul>
- <li><code>babel-runtime/helpers/createClass</code> 用于实现 class 语法</li>
- <li><code>babel-runtime/helpers/inherits</code> 用于实现 extends 语法</li>
- </ul>
- <p>默认的情况下 Babel 会在每个输出文件中内嵌这些依赖的辅助函数的代码,如果多个源代码文件都依赖这些辅助函数,那么这些辅助函数的代码将会重复的出现很多次,造成代码冗余。
- 为了不让这些辅助函数的代重复出现,可以在依赖它们的时候通过 <code>require('babel-runtime/helpers/createClass')</code> 的方式去导入,这样就能做到只让它们出现一次。
- <a href="https://babeljs.io/docs/plugins/transform-runtime/" target="_blank">babel-plugin-transform-runtime</a> 插件就是用来做这个事情的。</p>
- <p>修改 <code>.babelrc</code> 文件,为其加入 transform-runtime 插件:</p>
- <pre><code class="lang-json">{
- <span class="hljs-string">"plugins"</span>: [
- [
- <span class="hljs-string">"transform-runtime"</span>,
- {
- <span class="hljs-comment">// transform-runtime 默认会自动的为你使用的 ES6 API 注入 polyfill</span>
- <span class="hljs-comment">// 假如你在源码中使用了 Promise,输出的代码将会自动注入 require('babel-runtime/core-js/Promise') 语句</span>
- <span class="hljs-comment">// polyfill 的注入应该交给模块使用者,因为使用者可能在其它地方已经注入了其它的 Promise polyfill 库</span>
- <span class="hljs-comment">// 所以关闭该功能</span>
- <span class="hljs-string">"polyfill"</span>: <span class="hljs-literal">false</span>
- }
- ]
- ]
- }
- </code></pre>
- <p>由于加入 babel-plugin-transform-runtime 后生成的代码中会大量出现类似 <code>require('babel-runtime/helpers/createClass')</code> 这样的语句,所以输出的代码将依赖 <code>babel-runtime</code> 模块。</p>
- <p>此步引入了3个新依赖:</p>
- <pre><code class="lang-bash"><span class="hljs-comment"># 安装 Webpack 构建所需要的新依赖</span>
- npm i -D babel-plugin-transform-runtime
- <span class="hljs-comment"># 安装输出代码运行时所需的新依赖</span>
- npm i -S babel-runtime
- </code></pre>
- <h4 id="对于要求4,需要通过在-2-7其它配置项-中介绍过的-externals-来实现。">对于要求4,需要通过在 <a href="../2配置/2-7其它配置项.html">2-7其它配置项</a> 中介绍过的 Externals 来实现。</h4>
- <p>Externals 用来告诉 Webpack 要构建的代码中使用了哪些不用被打包的模块,也就是说这些模版是外部环境提供的,Webpack 在打包时可以忽略它们。</p>
- <p>相关的 Webpack 配置代码如下:</p>
- <pre><code class="lang-js"><span class="hljs-built_in">module</span>.exports = {
- <span class="hljs-comment">// 通过正则命中所有以 react 或者 babel-runtime 开头的模块</span>
- <span class="hljs-comment">// 这些模块通过注册在运行环境中的全局变量访问,不用被重复打包进输出的代码里</span>
- externals: <span class="hljs-regexp">/^(react|babel-runtime)/</span>,
- };
- </code></pre>
- <p>开启以上配置后,输出的代码中会存在导入 react 或者 babel-runtime 模块的代码,但是它们的 react 或者 babel-runtime 的内容不会被包含进去,如下:</p>
- <pre><code class="lang-js">[
- (<span class="hljs-function"><span class="hljs-keyword">function</span> (<span class="hljs-params">module, exports</span>) </span>{
- <span class="hljs-built_in">module</span>.exports = <span class="hljs-built_in">require</span>(<span class="hljs-string">"babel-runtime/helpers/inherits"</span>);
- }),
- (<span class="hljs-function"><span class="hljs-keyword">function</span> (<span class="hljs-params">module, exports</span>) </span>{
- <span class="hljs-built_in">module</span>.exports = <span class="hljs-built_in">require</span>(<span class="hljs-string">"react"</span>);
- })
- ]
- </code></pre>
- <p>这样就做到了在保持代码正确性的情况下,输出文件不存放 react 或者 babel-runtime 模块的代码。</p>
- <p>实际上当你在开发 Npm 模块时,不只需要对 react 和 babel-runtime 模块做这样的处理,而是需要对所有正在开发的模块所依赖的模块进行这样的处理。
- 因为正在开发的模块所依赖的模块也可能被其它模块所依赖。
- 当一个项目中一个模块被依赖多次时,Webpack 只会将其打包一次,想更深入的了解可以阅读 <a href="../5原理/5-2输出文件分析.html">5-2 输出文件分析</a>。</p>
- <hr>
- <p>完成以上4步后最终的 Webpack 完整配置代码如下:</p>
- <pre><code class="lang-js"><span class="hljs-keyword">const</span> path = <span class="hljs-built_in">require</span>(<span class="hljs-string">'path'</span>);
- <span class="hljs-keyword">const</span> ExtractTextPlugin = <span class="hljs-built_in">require</span>(<span class="hljs-string">'extract-text-webpack-plugin'</span>);
- <span class="hljs-built_in">module</span>.exports = {
- <span class="hljs-comment">// 模块的入口文件</span>
- entry: <span class="hljs-string">'./src/index.js'</span>,
- output: {
- <span class="hljs-comment">// 输出文件的名称</span>
- filename: <span class="hljs-string">'index.js'</span>,
- <span class="hljs-comment">// 输出文件的存放目录</span>
- path: path.resolve(__dirname, <span class="hljs-string">'lib'</span>),
- <span class="hljs-comment">// 输出的代码符合 CommonJS 模块化规范,以供给其它模块导入使用。</span>
- libraryTarget: <span class="hljs-string">'commonjs2'</span>,
- },
- <span class="hljs-comment">// 通过正则命中所有以 react 或者 babel-runtime 开头的模块,</span>
- <span class="hljs-comment">// 这些模块使用外部的,不能被打包进输出的代码里,防止它们出现多次。</span>
- externals: <span class="hljs-regexp">/^(react|babel-runtime)/</span>,
- <span class="hljs-built_in">module</span>: {
- rules: [
- {
- test: <span class="hljs-regexp">/\.js$/</span>,
- use: [<span class="hljs-string">'babel-loader'</span>],
- <span class="hljs-comment">// 排除 node_modules 目录下的文件,</span>
- <span class="hljs-comment">// node_modules 目录下的文件都是采用的 ES5 语法,没必要再通过 Babel 去转换。</span>
- exclude: path.resolve(__dirname, <span class="hljs-string">'node_modules'</span>),
- },
- {
- <span class="hljs-comment">// 增加对 CSS 文件的支持</span>
- test: <span class="hljs-regexp">/\.css$/</span>,
- <span class="hljs-comment">// 提取出 Chunk 中的 CSS 代码到单独的文件中</span>
- use: ExtractTextPlugin.extract({
- use: [<span class="hljs-string">'css-loader'</span>]
- }),
- },
- ]
- },
- plugins: [
- <span class="hljs-keyword">new</span> ExtractTextPlugin({
- <span class="hljs-comment">// 输出的 CSS 文件名称</span>
- filename: <span class="hljs-string">'index.css'</span>,
- }),
- ],
- <span class="hljs-comment">// 输出 Source Map</span>
- devtool: <span class="hljs-string">'source-map'</span>,
- };
- </code></pre>
- <p>重新执行构建后,你将会在项目目录下看到一个新目录 <code>lib</code>,里面放着要发布到 Npm 仓库的最终代码。</p>
- <h2 id="发布到-npm">发布到 Npm</h2>
- <p>在把构建出的代码发布到 Npm 仓库前,还需要确保你的模块描述文件 <code>package.json</code> 是正确配置的。</p>
- <p>由于构建出的代码的入口文件是 <code>./lib/index.js</code>,需要修改 <code>package.json</code> 中的 <code>main</code> 字段如下:</p>
- <pre><code class="lang-json">{
- <span class="hljs-string">"main"</span>: <span class="hljs-string">"lib/index.js"</span>,
- <span class="hljs-string">"jsnext:main"</span>: <span class="hljs-string">"src/index.js"</span>
- }
- </code></pre>
- <p>其中 <code>jsnext:main</code> 字段用于指出采用 ES6 编写的模块入口文件所在的位置,这样做的目的是为了方便实现在 <a href="../4优化/4-10使用TreeShaking.html">4-10 中介绍的 Tree Shaking</a>。</p>
- <p>修改完毕后在项目目录下执行 <code>npm publish</code> 就能把构建出的代码发布到 Npm 仓库中(确保已经 <code>npm login</code> 过)。</p>
- <blockquote>
- <p>如果你想让发布到 Npm 上去的代码保持和源码的目录结构一致,那么用 Webpack 将不在适合。
- 因为源码是一个个分割的模块化文件,而 Webpack 会把这些模块组合在一起。
- 虽然 Webpack 输出的文件也可以是采用 CommonJS 模块化语法的,但在有些场景下把所有模块打包成一个文件发布到 Npm 是不适合的。
- 例如像 Lodash 这样的工具函数库在项目中可能只用到了其中几个工具函数,如果所有工具函数打包在一个文件中,那么所有工具函数都会被打包进去,而保持模块文件的独立能做到只打包进使用到的。
- 还有就是像 UI 组件库这样由大量独立组件组成的库也和 Lodash 类似。</p>
- <p>所以 Webpack 适合于构建完整不可分割的 Npm 模块。</p>
- <p>本实例<a href="http://webpack.wuhaolin.cn/3-13构建Npm库.zip" target="_blank">提供项目完整代码</a></p>
- </blockquote>
-
- </section>
-
- </div>
- <div class="search-results">
- <div class="has-results">
-
- <h1 class="search-results-title"><span class='search-results-count'></span> results matching "<span class='search-query'></span>"</h1>
- <ul class="search-results-list"></ul>
-
- </div>
- <div class="no-results">
-
- <h1 class="search-results-title">No results matching "<span class='search-query'></span>"</h1>
-
- </div>
- </div>
- </div>
- </div>
- </div>
-
- </div>
-
-
- <a href="3-12构建Electron应用.html" class="navigation navigation-prev " aria-label="Previous page: 3-12 构建 Electron 应用">
- <i class="fa fa-angle-left"></i>
- </a>
-
-
- <a href="3-14构建离线应用.html" class="navigation navigation-next " aria-label="Next page: 3-14 构建离线应用">
- <i class="fa fa-angle-right"></i>
- </a>
-
-
-
- </div>
- <script>
- var gitbook = gitbook || [];
- gitbook.push(function() {
- gitbook.page.hasChanged({"page":{"title":"3-13 构建 Npm 模块","level":"1.5.13","depth":2,"next":{"title":"3-14 构建离线应用","level":"1.5.14","depth":2,"path":"3实战/3-14构建离线应用.md","ref":"3实战/3-14构建离线应用.md","articles":[]},"previous":{"title":"3-12 构建 Electron 应用","level":"1.5.12","depth":2,"path":"3实战/3-12构建Electron应用.md","ref":"3实战/3-12构建Electron应用.md","articles":[]},"dir":"ltr"},"config":{"plugins":["github-buttons","ga","modal","adsense"],"root":"./docs","styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"pluginsConfig":{"search":{},"adsense":{"client":"ca-pub-9697944574373240","slot":"9319793387","format":"auto","element":".page-inner section","position":"top"},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"modal":{"closable":true,"excludeUrls":["\\?q=.+$","index.html","前言.html","\\/$","1-.+","2-2Output","3-1使用ES6语言","3-2使用TypeScript语言","3-4使用SCSS语言.html","3-5使用PostCSS.html","3-6使用React框架","3-7使用Vue框架","3-8使用Angular2框架","3-9为单页应用生成HTML","3-10管理多个单页应用","3-17通过Node.jsAPI启动Webpack","3-20加载SVG"],"html":"<div style='text-align: center'><a href='http://union-click.jd.com/jdc?d=1AMcaz'><img src='http://p0.meituan.net/scarlett/df16c51ffb95186df6f75d8c0e22b965842464.png' width='306px' height='411px'><a/> <h2><a target='_blank' href='http://union-click.jd.com/jdc?d=1AMcaz'>购买本书纸质版</a></h2></div>"},"fontsettings":{"theme":"white","family":"sans","size":2},"highlight":{},"github-buttons":{"buttons":[{"user":"gwuhaolin","type":"follow","size":"small","width":"150"},{"user":"gwuhaolin","repo":"dive-into-webpack","type":"star","size":"small"}]},"ga":{"configuration":"auto","token":"UA-54964850-3"},"sharing":{"facebook":false,"twitter":false,"google":false,"weibo":true,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false}},"theme":"default","author":"吴浩麟","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"isbn":"9787121331725","variables":{},"title":"深入浅出 Webpack","language":"zh-hans","gitbook":"*","description":"本书按照入门、配置、实战、优化、原理的路线层层深入,涵盖了 Webpack 的方方面面。对于小白,本书可以作为 Webpack 入门教程,对于老手,本书可以进一步加深你对 Webpack 的理解。"},"file":{"path":"3实战/3-13构建Npm模块.md","mtime":"2019-02-28T08:16:23.293Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2019-03-17T07:14:49.167Z"},"basePath":"..","book":{"language":""}});
- });
- </script>
- </div>
-
- <script src="../gitbook/gitbook.js"></script>
- <script src="../gitbook/theme.js"></script>
-
-
- <script src="../gitbook/gitbook-plugin-github-buttons/plugin.js"></script>
-
-
-
- <script src="../gitbook/gitbook-plugin-ga/plugin.js"></script>
-
-
-
- <script src="../gitbook/gitbook-plugin-modal/index.js"></script>
-
-
-
- <script src="../gitbook/gitbook-plugin-adsense/plugin.js"></script>
-
-
-
- <script src="../gitbook/gitbook-plugin-search/search-engine.js"></script>
-
-
-
- <script src="../gitbook/gitbook-plugin-search/search.js"></script>
-
-
-
- <script src="../gitbook/gitbook-plugin-lunr/lunr.min.js"></script>
-
-
-
- <script src="../gitbook/gitbook-plugin-lunr/search-lunr.js"></script>
-
-
-
- <script src="../gitbook/gitbook-plugin-sharing/buttons.js"></script>
-
-
-
- <script src="../gitbook/gitbook-plugin-fontsettings/fontsettings.js"></script>
-
-
- </body>
- </html>
|