Webpack: 借助 Babel+TS+ESLint 构建现代 JS 工程环境

概述

  • Webpack 场景下处理 JavaScript 的三种常用工具:Babel、TypeScript、ESLint 的历史背景、功能以及接入 Webpack 的步骤
  • 借助这些工具,我们能构建出更健壮、优雅的 JavaScript 应用

使用 Babel

  • ECMAScript 6.0(简称 ES6) 版本补充了大量提升 JavaScript 开发效率的新特性,包括 class 关键字、块级作用域、ES Module 方案、代理与反射等,使得 JavaScript 可以真正被用于编写复杂的大型应用程序,但知道现在浏览器、Node 等 JavaScript 引擎都或多或少存在兼容性问题

  • 为此,现代 Web 开发流程中通常会引入 Babel 等转译工具。Babel 是一个开源 JavaScript 转编译器,它能将高版本 —— 如 ES6 代码等价转译为向后兼容,能直接在旧版 JavaScript 引擎运行的低版本代码,例如:

    // 使用 Babel 转译前
    arr.map(item => item + 1)
    
    // 转译后
    arr.map(function (item){
      return item + 1;
    })
    
  • 示例中高版本的箭头函数语法经过 Babel 处理后被转译为低版本 function 语法,从而能在不支持箭头函数的 JavaScript 引擎中正确执行

  • 借助 Babel 我们既可以始终使用最新版本 ECMAScript 语法编写 Web 应用,又能确保产物在各种环境下正常运行

  • 提示:Babel 还提供了一个在线版的 REPL 页面,读者可在 babeljs.io/repl 实时体验功能效果

  • Webpack 场景下,只需使用 babel-loader 即可接入 Babel 转译功能:

1 ) 安装依赖并配置

npm i -D @babel/core @babel/preset-env babel-loader
  • 添加模块处理规则

    module.exports = {
      /* ... */
      module: {
        rules: [
          {
            test: /\.js$/,
            use: ['babel-loader'],
          },
        ],
      },
    };
    
  • 示例中,module 属性用于声明模块处理规则,module.rules 子属性则用于定义针对什么类型的文件使用哪些 Loader 处理器,上例可解读为:

  • test: /\.js$/:用于声明该规则的过滤条件,只有路径名命中该正则的文件才会应用这条规则,示例中的 /\.js$/ 表示对所有 .js 后缀的文件生效

  • use:用于声明这条规则的 Loader 处理器序列,所有命中该规则的文件都会被传入 Loader 序列做转译处理

2 )执行编译命令

  • $ npx webpack

  • 接入后,可以使用 .babelrc 文件或 rule.options 属性配置 Babel 功能逻辑,例如:

    // 预先安装 @babel/preset-env
    // npm i -D @babel/preset-env
    module.exports = {
      /* ... */
      module: {
        rules: [
          {
            test: /\.js$/,
            use: [
              {
                loader: 'babel-loader',
                options: {
                  presets: ['@babel/preset-env'],
                },
              },
            ],
          },
        ],
      },
    };
    
  • 特别提一下,示例中的 @babel/preset-env 是一种 Babel 预设规则集 —— Preset,这种设计能按需将一系列复杂、数量庞大的配置、插件、Polyfill 等打包成一个单一的资源包,从而简化 Babel 的应用、学习成本。

  • Preset 是 Babel 的主要应用方式之一,社区已经针对不同应用场景打包了各种 Preset 资源,例如:

  • babel-preset-react:包含 React 常用插件的规则集,支持 preset-flowsyntax-jsxtransform-react-jsx 等;

  • @babel/preset-typescript:用于转译 TypeScript 代码的规则集

  • @babel/preset-flow:用于转译 Flow 代码的规则集

  • 提示:关于 Babel 的功能、用法、原理还有非常大的学习空间,感兴趣的同学可以前往阅读官方文档:babeljs.io/docs/en/ ,这里点到为止,把注意力放回 Webpack + Babel 协作上

使用 TypeScript

  • 从 1999年 ECMAScript 发布第二个版本到 2015年发布 ES6 之间十余年时间内,JavaScript 语言本身并没有发生太大变化,语言本身许多老旧特性、不合理设计、功能缺失已经很难满足日益复杂的 Web 应用场景
  • 为了解决这一问题,社区陆续推出了一些 JavaScript 超集方言,例如 TypeScript、CoffeeScript、Flow
  • 其中,TypeScript 借鉴 C# 语言,在 JavaScript 基础上提供了一系列类型约束特性,例如:
  • 示例中,用一个数字类型的变量 num 减去字符串类型的变量 str,这在 TypeScript 的代码编译过程就能提前发现问题,而 JavaScript 环境下则需要到启动运行后才报错。

  • 这种类型检查特性虽然一定程度上损失了语言本身的灵活性,但能够让问题在编译阶段提前暴露,确保运行阶段的类型安全性,特别适合用于构建多人协作的大型 JavaScript 项目,也因此,时至今日 TypeScript 依然是一项应用广泛的 JavaScript 超集语言。

  • Webpack 有很多种接入 TypeScript 的方法,包括 ts-loaderawesome-ts-loaderbabel-loader。通常可使用 ts-loader 构建 TypeScript 代码:

1 )安装依赖并配置

  • $ npm i -D typescript ts-loader
  • 配置 Webpack
    const path = require('path');
    module.exports = {
      module: {
        rules: [
          {
            test: /\.ts$/,
            use: 'ts-loader'
          },
        ],
      },
      resolve: {
        extensions: ['.ts', '.js'],
      }
    };
    
  • 使用 module.rules 声明对所有符合 /\.ts$/ 正则 —— 即 .ts 结尾的文件应用 ts-loader 加载器
  • 使用 resolve.extensions 声明自动解析 .ts 后缀文件,这意味着代码如 import "./a.ts" 可以忽略后缀声明,简化为 import "./a" 文件
  • 创建 tsconfig.json 配置文件,并补充 TypeScript 配置信息
    // tsconfig.json
    {
      "compilerOptions": {
        "noImplicitAny": true,
        "moduleResolution": "node"
      }
    }
    
  • 执行编译命令, $ npx webpack
  • 注意,如果项目中已经使用 babel-loader,你也可以选择使用 @babel/preset-typescript 规则集,借助 babel-loader 完成 JavaScript 与 TypeScript 的转码工作:

1 ) 安装依赖

  • $ npm i -D @babel/preset-typescript
  • 配置 Webpack
    // 预先安装 @babel/preset-env
    // npm i -D @babel/preset-env
    module.exports = {
      /* ... */
      module: {
        rules: [
          {
            test: /\.js$/,
            use: [
              {
                loader: 'babel-loader',
                options: {
                  presets: ['@babel/preset-typescript'],
                },
              },
            ],
          },
        ],
      },
    };
    
  • 不过,@babel/preset-typescript 只是简单完成代码转换,并未做类似 ts-loader 的类型检查工作,大家需要根据实际场景选择适当工具

使用 ESLint

  • JavaScript 被设计成一种高度灵活的动态、弱类型脚本语言,这使得语言本身的上手成本极低,开发者只需要经过短暂学习就可以开始构建简单应用。
  • 但与其它编译语言相比,JavaScript 很难在编译过程发现语法、类型,或其它可能影响稳定性的错误,特别在多人协作的复杂项目下,语言本身的弱约束可能会开发效率与质量产生不小的影响,ESLint 的出现正是为了解决这一问题。
  • ESLint 是一种扩展性极佳的 JavaScript 代码风格检查工具,它能够自动识别违反风格规则的代码并予以修复,例如对于下面的示例:
源码ESLint 修复后
const foo ='foo'; let bar='bar'; console.log(foo,bar) const foo = 'foo' const bar = 'bar' console.log(foo, bar)
ESLint 配置:module.exports = { "extends": "standard" }
ESLint 报错:img
  • 这里先忽略 ESLint 配置的具体规则,样例源码存在诸多风格不统一的地方,例如 1、2 行以 ; 结尾,而第 3 行没有 ;;第一行变量以 const 声明,第二行变量以 let 声明,等等。
  • ESLint 会找出这些风格不一致的地方,并予以告警,甚至自动修复,生成如上表右上角的代码。
  • Webpack 下,可以使用 eslint-webpack-plugin 接入 ESLint 工具,步骤:

1 ) 安装依赖并配置

# 安装 webpack 依赖
yarn add -D webpack webpack-cli

# 安装 eslint 
yarn add -D eslint eslint-webpack-plugin

# 简单起见,这里直接使用 standard 规范
yarn add -D eslint-config-standard eslint-plugin-promise eslint-plugin-import eslint-plugin-node
  • 在项目根目录添加 .eslintrc 配置文件,内容:

    // .eslintrc
    {
      "extends": "standard"
    }
    
  • 提示:关于 ESLint 配置项的更多信息,可参考:eslint.org/docs/user-g…

  • 添加 webpack.config.js 配置文件,补充 eslint-webpack-plugin 配置:

    // webpack.config.js
    const path = require('path')
    const ESLintPlugin = require('eslint-webpack-plugin')
    
    module.exports = {
      entry: './src/index',
      mode: 'development',
      devtool: false,
      output: {
        filename: '[name].js',
        path: path.resolve(__dirname, 'dist')
      },
      // 添加 eslint-webpack-plugin 插件实例
      plugins: [new ESLintPlugin()]
    }
    

2 ) 执行编译命令

  • $ npx webpack
  • 配置完毕后,就可以在 Webpack 编译过程实时看到代码风格错误提示:

img

  • 除常规 JavaScript 代码风格检查外,我们还可以使用适当的 ESLint 插件、配置集实现更丰富的检查、格式化功能,这里推荐几种使用率较高第三方扩展,建议读者跟进学习:

  • eslint-config-airbnb:Airbnb 提供的代码风格规则集,算得上 ESLint 生态第一个成名的规则集合

  • eslint-config-standardStandard.js 代码风格规则集,史上最便捷的统一代码风格的方式

  • eslint-plugin-vue:实现对 Vue SFC 文件的代码风格检查

  • eslint-plugin-react:实现对 React 代码风格检查

  • @typescript-eslint/eslint-plugin:实现对 TypeScript 代码风格检查

  • eslint-plugin-sonarjs:基于 Sonar 的代码质量检查工具,提供圈复杂度、代码重复率等检测功能

综合示例

  • 最后,我们再串联上述三种工具,构建一套功能完备的 JavaScript 应用开发环境,步骤:

  • 安装基础依赖:

    npm i -D webpack webpack-cli \
        # babel 依赖
        @babel/core @babel/cli @babel/preset-env babel-loader \
        # TypeScript 依赖
        typescript @typescript-eslint/parser @typescript-eslint/eslint-plugin \
        @babel/preset-typescript \
        # ESLint 依赖
        eslint eslint-webpack-plugin
    
  • 创建 webpack.config.js 配置文件并输入:

    const path = require('path')
    const ESLintPlugin = require('eslint-webpack-plugin')
    
    module.exports = {
      entry: './src/index.ts',
      mode: 'development',
      devtool: false,
      output: {
        filename: '[name].js',
        path: path.resolve(__dirname, 'dist')
      },
      module: {
        rules: [
          {
            test: /\.ts$/,
            use: {
              loader: 'babel-loader',
              options: { presets: ['@babel/preset-typescript'] }
            }
          }
        ]
      },
      plugins: [new ESLintPlugin({ extensions: ['.js', '.ts'] })]
    }
    
  • 注意,此处使用 @babel/preset-typescript 插件转译 TypeScript 代码。

  • 创建 .eslintrc 文件并输入:

    {
      "parser": "@typescript-eslint/parser",
      "plugins": ["@typescript-eslint"],
      "extends": ["plugin:@typescript-eslint/recommended"]
    }
    
  • 之后只需执行 npx webpack 命令即可完成编译操作,例如:

src/index.ts 源码编译结果
const say = (statements: string) => { console.log(statements) }; // @ts-ignore say("Tecvan"); /******/ (() => { // webpackBootstrap var __webpack_exports__ = {}; /*!**********************!*\ !*** ./src/index.ts ***! \**********************/ const say = statements => { console.log(statements); }; // @ts-ignore say("Tecvan"); /******/ })() ;
img
  • 至此,我们就搭建了一个支持 Babel + TypeScript + ESLint 的开发环境,读者可在此基础上修改各项工具配置,定制适合自己项目的开发环境。

总结

  • 本文介绍了 ESLint、TypeScript、Babel 三类工程化工具的历史背景、功能,以及在 Webpack 中接入这些工具的具体步骤。
  • 这三种工具各自补齐了 JavaScript 语言某些薄弱环节:
    • Babel 提供的语言转译能力,能在确保产物兼容性的同时,让我们大胆使用各种新的 ECMAScript 语言特性;
    • TypeScript 提供的类型检查能力,能有效提升应用代码的健壮性;
    • ESLint 提供的风格检查能力,能确保多人协作时的代码一致性
  • 它们已成为构建现代 JavaScript 应用的基础设施
  • 36
    点赞
  • 29
    收藏
    觉得还不错? 一键收藏
  • 打赏
    打赏
  • 0
    评论
首先,你需要安装WebpackBabel的相关依赖包。 ``` npm install webpack webpack-cli babel-loader @babel/core @babel/preset-env @babel/preset-react --save-dev ``` 接下来,在根目录下创建一个`webpack.config.js`文件,配置WebpackBabel的相关设置。 ``` const path = require('path'); module.exports = { entry: './src/index.js', output: { path: path.resolve(__dirname, 'dist'), filename: 'bundle.js' }, module: { rules: [ { test: /\.jsx?$/, exclude: /node_modules/, use: { loader: 'babel-loader', options: { presets: ['@babel/preset-env', '@babel/preset-react'] } } } ] } }; ``` 其中,`entry`指定了入口文件,`output`指定了打包后的输出路径和文件名。`module`中的`rules`是用来设置Webpack对不同类型的文件进行处理的规则。这里我们使用`babel-loader`来处理`.jsx`文件,将其转换为浏览器可读的JavaScript文件。 接下来,在`src`目录下创建一个`index.js`文件,编写一些JSX代码。 ``` import React from 'react'; import ReactDOM from 'react-dom'; const App = () => <div>Hello World!</div>; ReactDOM.render(<App />, document.getElementById('root')); ``` 最后,在`index.html`中引入打包后的`bundle.js`文件,并在页面中添加一个`id`为`root`的`div`元素。 ``` <!DOCTYPE html> <html> <head> <meta charset="UTF-8"> <title>Webpack + Babel + JSX Demo</title> </head> <body> <div id="root"></div> <script src="./dist/bundle.js"></script> </body> </html> ``` 现在,运行`webpack`命令进行打包,打开`index.html`就可以看到页面中显示了`Hello World!`。

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

Wang's Blog

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付:¥1
获取中
扫码支付

您的余额不足,请更换扫码支付或充值

打赏作者

实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值