使用 `rollup-plugin-esbuild` 插件的教程

使用 rollup-plugin-esbuild 插件的教程

rollup-plugin-esbuildUse ESBuild with Rollup to transform ESNext and TypeScript code.项目地址:https://gitcode.com/gh_mirrors/ro/rollup-plugin-esbuild

1. 项目的目录结构及介绍

rollup-plugin-esbuild 项目的目录结构如下：

rollup-plugin-esbuild/
├── dist/
│   ├── index.d.ts
│   ├── index.js
│   ├── index.js.map
│   ├── transform.d.ts
│   ├── transform.js
│   └── transform.js.map
├── src/
│   ├── index.ts
│   └── transform.ts
├── .gitignore
├── .npmignore
├── .prettierrc
├── LICENSE
├── package.json
├── README.md
├── rollup.config.js
└── tsconfig.json

目录结构介绍

• dist/：编译后的文件目录，包含 TypeScript 编译生成的 JavaScript 文件及其类型定义文件。
• src/：源代码目录，包含项目的 TypeScript 源文件。
• .gitignore：Git 忽略文件列表。
• .npmignore：NPM 发布时忽略的文件列表。
• .prettierrc：Prettier 代码格式化配置文件。
• LICENSE：项目许可证文件。
• package.json：项目的 npm 配置文件，包含依赖、脚本等信息。
• README.md：项目说明文档。
• rollup.config.js：Rollup 打包配置文件。
• tsconfig.json：TypeScript 编译配置文件。

2. 项目的启动文件介绍

项目的启动文件是 src/index.ts，它导出了 rollup-plugin-esbuild 的主要功能。该文件主要负责初始化和配置 Rollup 插件。

// src/index.ts
import { createFilter } from '@rollup/pluginutils'
import { transform, TransformOptions } from 'esbuild'
import { createEsbuildTransformPlugin } from './transform'

export interface Options extends TransformOptions {
  include?: string | string[]
  exclude?: string | string[]
}

export default function esbuild(options: Options = {}) {
  const filter = createFilter(options.include || /\.(tsx?|jsx)$/, options.exclude)
  return {
    name: 'esbuild',
    ...createEsbuildTransformPlugin(filter, options),
  }
}

3. 项目的配置文件介绍

rollup.config.js

rollup.config.js 是 Rollup 的配置文件，用于配置 Rollup 的打包行为。以下是一个示例配置：

// rollup.config.js
import esbuild from 'rollup-plugin-esbuild'

export default {
  input: 'src/index.ts',
  output: {
    file: 'dist/index.js',
    format: 'cjs',
  },
  plugins: [
    esbuild({
      include: /\.tsx?$/,
      target: 'es2015',
    }),
  ],
}

tsconfig.json

tsconfig.json 是 TypeScript 的配置文件，用于配置 TypeScript 编译器的行为。以下是一个示例配置：

{
  "compilerOptions": {
    "target": "es5",
    "module": "commonjs",
    "strict": true,
    "esModuleInterop": true,
    "skipLibCheck": true,
    "forceConsistentCasingInFileNames": true,
    "outDir": "./dist",
    "rootDir": "./src"
  },
  "include": ["src"]
}

通过以上配置，可以确保 TypeScript 文件被正确编译并输出到 dist 目录中。

---

以上是 rollup-plugin-esbuild 项目的目录结构、启动文件和配置文件的介绍。希望这些信息能帮助你更好地理解和使用该开源项目。

rollup-plugin-esbuildUse ESBuild with Rollup to transform ESNext and TypeScript code.项目地址:https://gitcode.com/gh_mirrors/ro/rollup-plugin-esbuild