Rollup-plugin-cleanup使用手册

1. 项目目录结构及介绍

rollup-plugin-cleanup 是一个专为Rollup设计的插件，用于清理、优化JavaScript代码。虽然具体的GitHub仓库未直接展示内部目录结构，一般情况下，Node.js的开源项目目录会有以下典型组成部分：

• src: 包含主要的源代码文件。
• dist: 经过构建后生成的文件通常存放于此。
• index.js 或 main.js: 插件的入口文件，定义了插件的主要逻辑。
• package.json: 描述项目信息、依赖项和脚本命令的文件。
• README.md: 提供快速入门指南、安装和使用说明的文档。
• LICENSE: 许可证文件，说明了项目使用的授权条款。

对于开发者而言，关注点主要在于package.json中关于该插件的信息和使用方法，以及可能的src目录下实现其功能的代码逻辑。

2. 项目的启动文件介绍

在这个上下文中，启动文件并不是直接操作的概念，因为rollup-plugin-cleanup本身不作为独立应用运行，而是集成于Rollup构建流程之中。然而，当你要在项目中使用此插件时，你需要在你的Rollup配置文件(rollup.config.js)中引入并配置它，这个配置文件可以视为启动或启用rollup-plugin-cleanup的间接“启动文件”。

示例配置可能会像这样：

// rollup.config.js
import cleanup from 'rollup-plugin-cleanup';

export default {
    input: 'src/index.js',
    output: {
        file: 'dist/bundle.js',
        format: 'iife'
    },
    plugins: [
        cleanup({
            comments: 'some', // 示例配置，仅保留某些类型的注释
            maxEmptyLines: 1,
            sourcemap: true
        })
    ]
};

3. 项目的配置文件介绍

Rollup配置文件 (rollup.config.js)

在使用rollup-plugin-cleanup时，重点配置位于你的Rollup构建配置文件中。以下是关键配置项的简介：

• cleanup: 插件导入，并作为配置对象的数组成员之一。其配置项包括：
  • comments: 控制注释的处理规则，可以是true（默认，保留所有），false（移除所有），特定字符串或正则表达式来筛选注释。
  • compactComments: 若设为true，则压缩多行注释中的空格和换行。
  • maxEmptyLines: 指定文件中最多允许连续空行的数量。
  • extensions: 可选数组，定义要处理的文件扩展名，默认为['js']，支持.jsx, .mjs等。
  • sourcemap: 若希望生成源映射文件，设为true。

插件使用示例

// 在rollup.config.js中加入此插件的配置
import cleanup from 'rollup-plugin-cleanup';

export default {
    input: 'src/main.js',
    output: {
        file: 'dist/bundle.js',
        format: 'umd',
        name: 'MyBundle'
    },
    plugins: [
        cleanup({ // 清理配置
            comments: 'all', // 移除所有注释
            maxEmptyLines: 0, // 不允许空行
            lineEndings: 'lf', // 规范换行符为Unix风格
            sourcemap: false // 不生成源映射文件
        })
    ]
};

以上描述提供了在实际项目中集成和配置rollup-plugin-cleanup的基本框架和指导，确保你的JavaScript代码更加干净、高效。