当前位置: 首页 > news >正文

esbuild中文文档-路径解析配置项(Path resolution - Alias、Conditions)

文章目录

  • 路径解析配置项 Path resolution
    • 别名 Alias
    • 条件解析 Conditions
      • conditions是如何工作的
  • 结语

哈喽,大家好!我是「励志前端小黑哥」,我带着最新发布的文章又来了!

老规矩,小手动起来~点赞关注不迷路!

esbuild简单介绍

esbuild为了突破了JavaScript语言的瓶颈,采用了Go语言编写,构建速度与同代码量下的webpack对比提升在10倍以上,开创了构建工具性能的新时代。

它的中文文档,本人正在不断的更新完善中,欢迎大家关注阅读!

路径解析配置项 Path resolution

别名 Alias

Supported by: Build

此功能允许您在打包时用一个包替换另一个包。以下示例将包oldpkg替换为包newpkg

esbuild app.js --bundle --alias:oldpkg=newpkg

这些替换首先会发生在esbuild所有的路径解析逻辑之前。此功能的一个使用场景是使用浏览器兼容包替换仅Node环境可使用的包,从而替换那些您无法控制的第三方代码,。

请注意,当使用Alias替换导入路径时,生成的导入路径将在工作目录中解析,而不是在包含具有导入路径的源文件的目录中解析。如果需要,可以使用Working directory功能设置esbuild所使用的工作目录。

条件解析 Conditions

Supported by: Build

此功能控制如何解析package.json中的exports字段。可以使用conditions设置添加自定义条件。您可以根据需要指定任意多个条件,这完全取决于包的作者。Node目前只推荐使用developmentproduction的自定义条件。以下是添加自定义条件custom1custom2的示例:

esbuild src/app.js --bundle --conditions=custom1,custom2

conditions是如何工作的

contitions允许您在不同的情况下将相同的import路径重定向到不同的文件位置。包含条件和路径的重定向Map存储在包的package.json文件的exports字段中。例如,下面这个例子将使用importrequired条件将require('pkg/foo')重新映射到pkg/required.cjs,并将import 'pkg/foo'导入映射到pkg/imported.mjs

{"name": "pkg","exports": {"./foo": {"import": "./imported.mjs","require": "./required.cjs","default": "./fallback.js"}}
}

conditions配置按照它们在JSON文件中出现的顺序进行检查。所以上面的例子有点像下面这个流程:

if (importPath === './foo') {if (conditions.has('import')) return './imported.mjs'if (conditions.has('require')) return './required.cjs'return './fallback.js'
}

默认情况下,有五种具有特殊含义的条件内置到esbuild中,并且不能禁用:

  • default

这种情况始终处于激活状态。它旨在排在最后,并允许您在没有其他条件适用时提供后备方案。当您在node中以本地方式运行代码时,此条件也处于活动状态。

  • import

只有当导入路径来自ESMimport语句或import()表达式时,此条件才处于活动状态。它可用于提供ESM特定的代码。当您在node中以本地方式运行代码时(但仅在ESM上下文中),此条件也处于活动状态。

  • require

只有当导入路径来自CommonJSrequire()调用时,此条件才处于活动状态。它可以用来提供CommonJS特定的代码。当您在node中以本地方式运行代码时(但仅在CommonJS上下文中),此条件也是活动的。

  • browser

只有当esbuildplatform参数设置为browser时,此条件才处于活动状态。它可以用于提供特定于浏览器的代码。当您在node中以本地方式运行代码时,此条件不处于活动状态。

  • node

只有当esbuildplatform参数设置为node时,此条件才处于活动状态。它可以用于提供特定的nodejs代码。当您在node中以本地方式运行代码时,此条件也处于活动状态。

platform设置为browsernode且未配置自定义条件时,还会自动包含以下条件。如果配置了任何自定义条件(甚至是空列表),则此条件将不再自动包含:

  • module

此条件可用于告诉esbuild为给定的import路径选择合适的ESM变体,以便在打包时提供更好的树抖动tree shaking。当您在node中以本地方式运行代码时,此条件不处于活动状态。它是esbuild打包器特有的,灵感来源源于Webpack

请注意,当您使用requireimport条件时,您的包可能会多次出现在打包文件中!这是一个小问题,除了导致打包文件膨胀之外,可能会由于代码状态的重复副本而导致错误。这通常被称为双包危害。

避免双包危害的一种方法是将所有代码作为CommonJS放入require条件中,并使导入条件仅为一个简单的ESM包装器,该包装器在包上调用require,并使用ESM语法重新导出包。然而,这种方法不能提供良好的树抖动,因为esbuild不会对CommonJS模块进行树抖动。

避免双包危害的另一种方法是使用打包器特定的module条件来指导打包器始终加载包的ESM版本,同时让node始终回退到包的CommonJS版本。importmodule都用于ESM,但与import不同的是,即使使用require调用加载了import路径,module条件也始终处于活动状态。这在打包器中很好地工作,因为打包器支持使用require加载ESM,但它不能与node一起工作,因为node故意不使用require实现加载ESM

结语

笔者根据esbuild文档搭建了一套简洁的ts开发脚手架工程,编译速度非常快!脚手架还整合了eslint,另一篇文章还附带了调试教程,需要的朋友看这里:esbuild配合vscode搭建的ts开发环境,这编译速度,真香

另外,esbuild中文文档专栏,本人目前正在翻译整理,关注我,有最新的翻译文档会第一时间通知你!

(本文完)

励志前端小黑哥,全网唯一账号!
关注我,带你了解更多前端知识!

http://www.lryc.cn/news/169963.html

相关文章:

  • 您的应用存在隐藏最近任务列表名称的行为,不符合华为应用市场审核标准
  • Spring的 webFlux 和 webMVC
  • 【洛谷算法题】P5706-再分肥宅水【入门1顺序结构】
  • android studio环境搭建让你的开发之旅更加简单
  • Java面试_并发编程_线程基础
  • 基于Java的高校实习管理系统设计与实现(亮点:实习记录、实习打分、实习作业,功能新颖、老师没见过、当场唬住!)
  • 傅里叶变换
  • Vue Grid Layout -️ 适用Vue.js的栅格布局系统,在vue3+上使用
  • Electron(v26.2.1)无法加载React Developer Tools(v4.28.0)
  • 网站降权的康复办法(详解百度SEO数据分析)
  • 非对称加密、解密原理及openssl中的RSA示例代码
  • 基于springboot漫画管理系统springboot001
  • 【探索C++】string类详解
  • python 第一次作业
  • 个人博客网站一揽子:Docker建站(Nginx、Wordpress、MySql)
  • Unity 课时 4 : No.4 模拟面试题
  • Golang 基础面试题 01
  • 007-第一代软件需求整理
  • XMLHttpRequest介绍
  • 阿里云无影云电脑和传统PC有什么区别?
  • 基于matlab实现的船舶横摇运动仿真程序
  • Java手写二叉索引树和二叉索引树应用拓展案例
  • 大数据知识点之大数据5V特征
  • Java的Socket通信的断网重连的正确写法
  • Rocketmq--消息发送和接收演示
  • ArcGIS Pro将SHP文件转CAD并保留图层名称
  • GEE:使用for循环合成时间序列影像
  • flink1.13.2版本的对应的hive的Hcatalog的使用记录
  • STM32 ADC介绍和应用
  • vue项目打包_以生产环境prod模式打包_vue-cli-service 不是内部或外部命令,也不是可运行的程序---vue工作笔记0025