终极配置指南：定制Esbuild Runner满足你的项目需求

终极配置指南：定制Esbuild Runner满足你的项目需求

【免费下载链接】esbuild-runner⚡️ Super-fast on-the-fly transpilation of modern JS, TypeScript and JSX using esbuild项目地址: https://gitcode.com/gh_mirrors/es/esbuild-runner

Esbuild Runner（简称esr）是一款基于esbuild的超快速即时转译工具，能够高效处理现代JS、TypeScript和JSX文件。本文将详细介绍如何通过灵活配置，让Esbuild Runner完美适配你的项目需求，提升开发效率。

为什么选择Esbuild Runner？

Esbuild Runner作为一款优秀的转译工具，凭借esbuild的强大性能，为开发者带来了极速的代码转译体验。它支持两种转译模式：捆绑模式（默认）和转换模式（使用--cache参数），能够满足不同场景下的开发需求。无论是运行单个脚本还是集成到测试框架，Esbuild Runner都能提供高效的转译支持。

基础配置：命令行参数

Esbuild Runner提供了简单直观的命令行参数，帮助你快速配置转译行为。通过运行esr --help，可以查看所有可用参数：

• --cache：启用文件级转换并缓存代码，首次运行较慢，但后续仅转译修改过的文件
• --clearCache：清除转换缓存
• --help|-h：显示帮助信息

例如，使用缓存模式运行TypeScript文件：

esr --cache your-script.ts

高级配置：esbuild-runner.config.js

为了进一步定制Esbuild Runner的行为，你可以创建esbuild-runner.config.js配置文件。该文件可以放在当前目录或任何祖先目录中，Esbuild Runner会自动查找并加载。

配置文件基本结构

配置文件采用CommonJS模块格式，导出一个包含type和esbuild属性的对象：

// esbuild-runner.config.js module.exports = { type: "bundle", // 或 "transform" esbuild: { // esbuild构建或转换选项 }, }

选择转译模式

• bundle（默认）：一次性转译脚本及其所有依赖，package.json或node_modules中的依赖不会被转译，不使用缓存
• transform：为每个源文件单独调用esbuild，使用缓存，初始运行较慢，后续仅转译修改的文件

配置esbuild选项

你可以在esbuild属性中设置任何esbuild支持的构建或转换选项，例如：

// esbuild-runner.config.js module.exports = { type: "bundle", esbuild: { target: "es2020", // 目标环境 jsxFactory: "h", // JSX工厂函数 jsxFragment: "Fragment", // JSX片段 define: { "process.env.NODE_ENV": "'development'" }, // 定义全局常量 }, }

集成到开发工具

Jest配置

要在Jest中使用Esbuild Runner，需要在jest.config.js中配置转换规则：

module.exports = { transform: { "\\.ts$": "esbuild-runner/jest", }, }

VSCode调试配置

在VSCode中配置调试环境，享受Esbuild Runner带来的即时转译体验：

{ "version": "0.2.0", "configurations": [ { "name": "Debug with esbuild-runner", "program": "${workspaceFolder}/your-script.ts", "runtimeArgs": [ "-r", "esbuild-runner/register" ], "request": "launch", "sourceMaps": true, "skipFiles": [ "<node_internals>/**" ], "type": "pwa-node" } ] }

安装与使用

全局安装

npm install -g esbuild-runner

项目本地安装

npm add --dev esbuild-runner

基本使用

esr your-script.ts

或者使用node -r方式：

node -r esbuild-runner/register your-script.ts

总结

通过本文介绍的配置方法，你可以轻松定制Esbuild Runner以满足项目的特定需求。无论是简单的命令行参数调整，还是复杂的esbuild-runner.config.js配置，Esbuild Runner都能提供灵活的支持。赶快尝试使用Esbuild Runner，体验极速转译带来的开发效率提升吧！

希望本指南对你有所帮助，如果有任何问题或建议，欢迎参与项目贡献。Esbuild Runner的源代码托管在仓库中，你可以通过git clone https://gitcode.com/gh_mirrors/es/esbuild-runner获取完整代码。

【免费下载链接】esbuild-runner⚡️ Super-fast on-the-fly transpilation of modern JS, TypeScript and JSX using esbuild项目地址: https://gitcode.com/gh_mirrors/es/esbuild-runner