unbuild 项目使用教程

unbuild 项目使用教程

unbuild 📦 A unified JavaScript build system 项目地址: https://gitcode.com/gh_mirrors/un/unbuild

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

unbuild 是一个统一的 JavaScript 打包系统，它的目录结构如下：

• src/: 源代码目录，所有的项目源代码都放在这个目录下。
• dist/: 打包输出目录，unbuild 会将编译后的文件输出到这个目录。
• .github/: 存放 GitHub 相关的配置文件，如工作流（workflows）等。
• examples/: 示例项目目录，包含了一些使用 unbuild 的示例。
• test/: 测试代码目录，包含了项目的单元测试代码。
• editorconfig/: 编辑器配置文件，用于统一团队成员的代码风格。
• .gitignore: Git 忽略文件，定义了不需要提交到 Git 仓库的文件和目录。
• prettierrc: Prettier 配置文件，用于格式化代码。
• CHANGELOG.md: 变更日志文件，记录了项目的历史更新和改动。
• LICENSE: 许可证文件，本项目使用 MIT 许可证。
• README.md: 项目的自述文件，介绍了项目的相关信息和使用方法。
• build.config.ts: unbuild 的配置文件，用于定制打包行为。
• package.json: 项目配置文件，定义了项目的依赖、脚本和元数据。
• pnpm-lock.yaml: pnpm 锁文件，记录了项目的依赖关系和版本。
• renovate.json: Renovate 配置文件，用于自动化依赖更新。
• tsconfig.json: TypeScript 配置文件，定义了 TypeScript 编译器的选项。

2. 项目的启动文件介绍

项目的启动主要是通过 package.json 中的脚本实现的。以下是 package.json 中定义的一些常用脚本：

• build: 使用 unbuild 进行项目打包。
• prepack: 在打包之前运行的脚本，通常用于执行一些检查或清理工作。

例如，以下是如何在 package.json 中定义 build 脚本：

{
  "scripts": {
    "build": "unbuild"
  }
}

当运行 npm run build 或 yarn build 时，unbuild 会自动读取项目的配置，并开始打包过程。

3. 项目的配置文件介绍

项目的配置主要通过 build.config.ts 文件进行。以下是 build.config.ts 的一个基础示例：

export default {
  entries: [
    './src/index' // 指定项目入口文件
  ],
  outDir: 'dist', // 指定打包输出目录
  declaration: true // 是否生成类型声明文件
};

在 build.config.ts 中，可以详细配置 unbuild 的行为，如：

• entries: 指定打包的入口文件。
• outDir: 指定打包输出的目录。
• declaration: 是否生成类型声明文件。
• rollup: 配置 Rollup 打包工具的选项。
• sourcemap: 是否生成源码映射文件。

通过修改这些配置，可以满足不同项目的打包需求。

unbuild 📦 A unified JavaScript build system 项目地址: https://gitcode.com/gh_mirrors/un/unbuild