清洁发布（Clean Publish）项目教程

1. 项目目录结构及介绍

clean-publish 项目的主要目录结构如下：

• clean-publish.js：项目的核心脚本文件，用于执行清理和发布操作。
• clear-package-json.js：一个辅助工具，用于清理 package.json 文件。
• core.js：项目核心功能的实现。
• get-config.js：用于获取项目配置信息的脚本。
• utils.js：包含一些实用功能的工具库。
• .editorconfig：用于定义代码风格的配置文件。
• .gitignore：定义在版本控制中应该忽略的文件和目录。
• .npmignore：定义在发布到 npm 时应该忽略的文件和目录。
• LICENSE：项目的许可证文件。
• README.md：项目的自述文件，包含项目介绍和使用说明。
• package.json：项目的元数据文件，包含项目依赖、脚本等信息。

2. 项目的启动文件介绍

项目的启动主要通过 clean-publish.js 文件进行。该脚本会执行以下步骤：

• 创建一个临时目录，并将项目文件（排除配置文件）复制到该目录。
• 清理 package.json 文件，移除开发脚本和依赖。
• 在临时目录中调用 npm publish 命令发布项目。

使用方法如下：

npx clean-publish

可以通过传递参数来定制化清理和发布过程，例如：

npx clean-publish --files "file1.js, file2.js" --fields "scripts, name"

3. 项目的配置文件介绍

clean-publish 支持多种方式来定义配置：

• 在 package.json 中定义 clean-publish 部分。
• 使用单独的 .clean-publish 配置文件。
• 使用 .clean-publish.js 配置文件，可以提供更灵活的配置。

配置文件中可以定义以下内容：

• files：需要删除的文件列表，支持正则表达式和 glob 模式。
• packageManager：使用的包管理器，如 npm、yarn 或 pnpm。
• withoutPublish：是否执行发布操作。
• tempDir：临时目录的名称。
• beforeScript：在发布之前运行的脚本。

例如，以下是一个 .clean-publish.js 配置文件的示例：

module.exports = {
  files: ["file1.js", "file2.js"],
  packageManager: "yarn",
  tempDir: "release",
};

这个配置文件指定了要删除的文件、使用的包管理器以及临时目录的名称。