12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385 |
- <!DOCTYPE HTML>
- <html lang="zh-hans" >
- <head>
- <meta charset="UTF-8">
- <meta content="text/html; charset=utf-8" http-equiv="Content-Type">
- <title>3-16 检查代码 · 深入浅出 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-17通过Node.jsAPI启动Webpack.html" />
-
-
- <link rel="prev" href="3-15搭配NpmScript.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 " 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 active" 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-16 检查代码</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-16-检查代码">3-16 检查代码</h1>
- <p>当项目代码变得日益庞大复杂时,如何保障代码质量?如何保障多人协助开发时代码的可读性?</p>
- <p>完全解决以上问题不是一个简单的事,但做检查代码能解决大部分问题。本节将教你如何结合构建做代码检查。</p>
- <h2 id="代码检查具体是做什么">代码检查具体是做什么</h2>
- <p>检查代码和 Code Review 很相似,都是去审视提交的代码可能存在的问题。
- 但 Code Review 一般通过人去执行,而检查代码是通过机器去执行一些自动化的检查。
- 自动化的检查代码成本更低,实施代价更小。</p>
- <p>检查代码主要检查以下几项:</p>
- <ul>
- <li>代码风格:让项目成员强制遵守统一的代码风格,例如如何缩进、如何写注释等,保障代码可读性,不把时间浪费在争论如何写代码更好看上;</li>
- <li>潜在问题:分析出代码在运行过程中可能出现的潜在 Bug。</li>
- </ul>
- <p>其中检查代码风格相关的工具很多也很成熟,分析潜在问题的检查由于情况复杂目前还没有成熟的工具。</p>
- <p>目前已经有成熟的工具可以检验诸如 JavaScript、TypeScript、CSS、SCSS 等常用语言。</p>
- <h2 id="怎么做代码检查">怎么做代码检查</h2>
- <p>在做代码风格检查时需要按照不同的文件类型来检查,下面来分别介绍。</p>
- <h3 id="检查-javascript">检查 JavaScript</h3>
- <p>目前最常用的 JavaScript 检查工具是 <a href="https://eslint.org" target="_blank">ESlint</a> ,它不仅内置了大量常用的检查规则,还可以通过插件机制做到灵活扩展。</p>
- <p>ESlint 的使用很简单,在通过</p>
- <pre><code class="lang-bash">npm i -g eslint
- </code></pre>
- <p>按照到全局后,再在项目目录下执行</p>
- <pre><code class="lang-bash">eslint --init
- </code></pre>
- <p>来新建一个 ESlint 配置文件 <code>.eslintrc</code>,该文件格式为 JSON。</p>
- <p>如果你想覆盖默认的检查规则,或者想加入新的检查规则,你需要修改该文件,例如使用以下配置:</p>
- <pre><code class="lang-json">{
- <span class="hljs-comment">// 从 eslint:recommended 中继承所有检查规则</span>
- <span class="hljs-string">"extends"</span>: <span class="hljs-string">"eslint:recommended"</span>,
- <span class="hljs-comment">// 再自定义一些规则 </span>
- <span class="hljs-string">"rules"</span>: {
- <span class="hljs-comment">// 需要在每行结尾加 ; </span>
- <span class="hljs-string">"semi"</span>: [<span class="hljs-string">"error"</span>, <span class="hljs-string">"always"</span>],
- <span class="hljs-comment">// 需要使用 "" 包裹字符串 </span>
- <span class="hljs-string">"quotes"</span>: [<span class="hljs-string">"error"</span>, <span class="hljs-string">"double"</span>]
- }
- }
- </code></pre>
- <p>写好配置文件后,再执行</p>
- <pre><code class="lang-bash">eslint yourfile.js
- </code></pre>
- <p>去检查 <code>yourfile.js</code> 文件,如果你的文件没有通过检查,ESlint 会输出错误原因,例如:</p>
- <pre><code class="lang-text">/yourfile.js
- 296:13 error Strings must use doublequote quotes
- 298:7 error Missing semicolon semi
- ✖ 2 problems (2 errors, 0 warnings)
- </code></pre>
- <p>ESlint 还有很多功能和检查规则,由于篇幅有限这里就不详细介绍,可以去其官网阅读文档。</p>
- <h3 id="检查-typescript">检查 TypeScript</h3>
- <p><a href="https://palantir.github.io/tslint/" target="_blank">TSLint</a> 是一个和 ESlint 相似的 TypeScript 代码检查工具,区别在于 TSLint 只专注于检查 TypeScript 代码。</p>
- <p>TSLint 和 ESlint 的使用方法很相似,首先通过</p>
- <pre><code class="lang-bash">npm i -g tslint
- </code></pre>
- <p>按照到全局,再去项目根目录下执行</p>
- <pre><code class="lang-bash">tslint --init
- </code></pre>
- <p>生成配置文件 <code>tslint.json</code>,在配置好后,再执行</p>
- <pre><code class="lang-bash">tslint yourfile.ts
- </code></pre>
- <p>去检查 <code>yourfile.ts</code> 文件。</p>
- <h3 id="检查-css">检查 CSS</h3>
- <p><a href="https://stylelint.io" target="_blank">stylelint</a> 是目前最成熟的 CSS 检查工具,内置了大量检查规则的同时也提供插件机制让用户自定义扩展。
- stylelint 基于 PostCSS,能检查任何 PostCSS 能解析的代码,诸如 SCSS、Less 等。</p>
- <p>首先通过</p>
- <pre><code class="lang-bash">npm i -g stylelint
- </code></pre>
- <p>按照到全局后,去项目根目录下新建 <code>.stylelintrc</code> 配置文件,
- 该配置文件格式为 JSON,其格式和 ESLint 的配置相似,例如:</p>
- <pre><code class="lang-json">{
- <span class="hljs-comment">// 继承 stylelint-config-standard 中的所有检查规则</span>
- <span class="hljs-string">"extends"</span>: <span class="hljs-string">"stylelint-config-standard"</span>,
- <span class="hljs-comment">// 再自定义检查规则 </span>
- <span class="hljs-string">"rules"</span>: {
- <span class="hljs-string">"at-rule-empty-line-before"</span>: <span class="hljs-literal">null</span>
- }
- }
- </code></pre>
- <p>配置好后,再执行</p>
- <pre><code class="lang-bash">stylelint <span class="hljs-string">"yourfile.css"</span>
- </code></pre>
- <p>去检查 <code>yourfile.css</code> 文件。</p>
- <p>stylelint 还有很多功能和配置项没有介绍到,可以访问其官方进一步了解。</p>
- <blockquote>
- <p>目前很多编辑器,例如 Webstorm、VSCode 等,已经集成了以上介绍过的检查工具,编辑器会实时地把检查工具输出的错误显示编辑的源码上。
- 通过编辑器集成后,你不用通过命令行的方式去定位错误。</p>
- </blockquote>
- <h2 id="结合-webpack-检查代码">结合 Webpack 检查代码</h2>
- <p>以上介绍的代码检查工具可以和 Webpack 结合起来,在开发过程中通过 Webpack 输出实时的检查结果。</p>
- <h3 id="结合-eslint">结合 ESLint</h3>
- <p><a href="https://github.com/MoOx/eslint-loader" target="_blank">eslint-loader</a> 可以方便的把 ESLint 整合到 Webpack 中,使用方法如下:</p>
- <pre><code class="lang-js"><span class="hljs-built_in">module</span>.exports = {
- <span class="hljs-built_in">module</span>: {
- rules: [
- {
- test: <span class="hljs-regexp">/\.js$/</span>,
- <span class="hljs-comment">// node_modules 目录的下的代码不用检查</span>
- exclude: <span class="hljs-regexp">/node_modules/</span>,
- loader: <span class="hljs-string">'eslint-loader'</span>,
- <span class="hljs-comment">// 把 eslint-loader 的执行顺序放到最前面,防止其它 Loader 把处理后的代码交给 eslint-loader 去检查</span>
- enforce: <span class="hljs-string">'pre'</span>,
- },
- ],
- },
- }
- </code></pre>
- <p>接入 eslint-loader 后就能在控制台中看到 ESLint 输出的错误日志了。</p>
- <h3 id="结合-tslint">结合 TSLint</h3>
- <p><a href="https://github.com/wbuchwalter/tslint-loader" target="_blank">tslint-loader</a> 是一个和 eslint-loader 相似的 Webpack Loader,
- 能方便的把 TSLint 整合到 Webpack,其使用方法如下:</p>
- <pre><code class="lang-js"><span class="hljs-built_in">module</span>.exports = {
- <span class="hljs-built_in">module</span>: {
- rules: [
- {
- test: <span class="hljs-regexp">/\.ts$/</span>,
- <span class="hljs-comment">// node_modules 目录的下的代码不用检查</span>
- exclude: <span class="hljs-regexp">/node_modules/</span>,
- loader: <span class="hljs-string">'tslint-loader'</span>,
- <span class="hljs-comment">// 把 tslint-loader 的执行顺序放到最前面,防止其它 Loader 把处理后的代码交给 tslint-loader 去检查</span>
- enforce: <span class="hljs-string">'pre'</span>,
- },
- ],
- },
- }
- </code></pre>
- <h3 id="结合-stylelint">结合 stylelint</h3>
- <p><a href="https://github.com/JaKXz/stylelint-webpack-plugin" target="_blank">StyleLintPlugin</a> 能把 stylelint 整合到 Webpack,其使用方法很简单,如下:</p>
- <pre><code class="lang-js"><span class="hljs-keyword">const</span> StyleLintPlugin = <span class="hljs-built_in">require</span>(<span class="hljs-string">'stylelint-webpack-plugin'</span>);
- <span class="hljs-built_in">module</span>.exports = {
- <span class="hljs-comment">// ...</span>
- plugins: [
- <span class="hljs-keyword">new</span> StyleLintPlugin(),
- ],
- }
- </code></pre>
- <h3 id="一些建议">一些建议</h3>
- <p>把代码检查功能整合到 Webpack 中会导致以下问题:</p>
- <ul>
- <li>由于执行检查步骤计算量大,整合到 Webpack 中会导致构建变慢;</li>
- <li>在整合代码检查到 Webpack 后,输出的错误信息是通过行号来定位错误的,没有编辑器集成显示错误直观;</li>
- </ul>
- <p>为了避免以上问题,还可以这样做:</p>
- <ul>
- <li>使用集成了代码检查功能的编辑器,让编辑器实时直观地显示错误;</li>
- <li>把代码检查步骤放到代码提交时,也就是说在代码提交前去调用以上检查工具去检查代码,只有在检查都通过时才提交代码,这样就能保证提交到仓库的代码都是通过了检查的。</li>
- </ul>
- <p>如果你的项目是使用 Git 管理,Git 提供了 Hook 功能能做到在提交代码前触发执行脚本。</p>
- <p><a href="https://github.com/typicode/husky" target="_blank">husky</a> 可以方便快速地为项目接入 Git Hook,
- 执行</p>
- <pre><code class="lang-bash">npm i -D husky
- </code></pre>
- <p>安装 husky 时,husky 会通过 Npm Script Hook 自动配置好 Git Hook,你需要做的只是在 <code>package.json</code> 文件中定义几个脚本,方法如下:</p>
- <pre><code class="lang-json">{
- <span class="hljs-string">"scripts"</span>: {
- <span class="hljs-comment">// 在执行 git commit 前会执行的脚本 </span>
- <span class="hljs-string">"precommit"</span>: <span class="hljs-string">"npm run lint"</span>,
- <span class="hljs-comment">// 在执行 git push 前会执行的脚本 </span>
- <span class="hljs-string">"prepush"</span>: <span class="hljs-string">"lint"</span>,
- <span class="hljs-comment">// 调用 eslint、stylelint 等工具检查代码</span>
- <span class="hljs-string">"lint"</span>: <span class="hljs-string">"eslint && stylelint"</span>
- }
- }
- </code></pre>
- <p><code>precommit</code> 和 <code>prepush</code> 你需要根据自己的情况选择一个,无需两个都设置。</p>
-
- </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-15搭配NpmScript.html" class="navigation navigation-prev " aria-label="Previous page: 3-15 搭配 Npm Script">
- <i class="fa fa-angle-left"></i>
- </a>
-
-
- <a href="3-17通过Node.jsAPI启动Webpack.html" class="navigation navigation-next " aria-label="Next page: 3-17 通过 Node.js API 启动 Webpack">
- <i class="fa fa-angle-right"></i>
- </a>
-
-
-
- </div>
- <script>
- var gitbook = gitbook || [];
- gitbook.push(function() {
- gitbook.page.hasChanged({"page":{"title":"3-16 检查代码","level":"1.5.16","depth":2,"next":{"title":"3-17 通过 Node.js API 启动 Webpack","level":"1.5.17","depth":2,"path":"3实战/3-17通过Node.jsAPI启动Webpack.md","ref":"3实战/3-17通过Node.jsAPI启动Webpack.md","articles":[]},"previous":{"title":"3-15 搭配 Npm Script","level":"1.5.15","depth":2,"path":"3实战/3-15搭配NpmScript.md","ref":"3实战/3-15搭配NpmScript.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-16检查代码.md","mtime":"2019-03-17T04:09:29.684Z","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>
|