Bun Plugin DTS 使用教程

1. 项目目录结构及介绍

bun-plugin-dts 项目采用清晰的目录结构来组织代码和资源，以下是项目的主要目录及介绍：

• src/：存放源代码，包括插件的主要逻辑。
• test/：包含用于测试插件的测试代码。
• docs/：存放项目文档。
• examples/：提供了一些使用插件的示例项目。
• .vscode/：包含Visual Studio Code的配置文件。
• package.json：项目的配置文件，定义了项目的依赖、脚本和元数据。
• README.md：项目说明文件，介绍了插件的功能和用法。

2. 项目的启动文件介绍

在 src/ 目录下，index.ts 文件是插件的启动文件。以下是启动文件的简要介绍：

// index.ts

import { createPlugin } from 'bun';

export default createPlugin({
  // 插件配置
  name: 'dts',
  // 插件初始化函数
  setup(build) {
    // 插件逻辑
  }
});

在 index.ts 文件中，我们导入了 bun 包的 createPlugin 函数，并使用它来创建一个插件。插件配置包括名称和一个 setup 函数，该函数在插件被加载时执行，其中包含了插件的逻辑。

3. 项目的配置文件介绍

package.json 是项目的主要配置文件，以下是它的基本结构：

{
  "name": "bun-plugin-dts",
  "version": "1.0.0",
  "description": "A Bun plugin to generate .d.ts files",
  "main": "src/index.ts",
  "scripts": {
    "build": "tsc",
    "test": "jest"
  },
  "dependencies": {
    // 项目的依赖
  },
  "devDependencies": {
    // 开发依赖
  },
  "keywords": [
    "bun",
    "typescript",
    "d.ts",
    "plugin"
  ],
  "author": "Your Name",
  "license": "MIT"
}

在 package.json 文件中：

• name 和 version 定义了项目的名称和版本。
• description 提供了项目的简短描述。
• main 指定了项目的入口文件。
• scripts 定义了一些可执行的脚本，例如构建和测试脚本。
• dependencies 和 devDependencies 分别列出了项目运行和开发所需的依赖。
• keywords 提供了与项目相关的关键字。
• author 和 license 分别提供了项目作者的姓名和项目的许可证类型。