Slack Cleaner 项目启动与配置教程

1. 项目目录结构及介绍

Slack Cleaner 是一个用于清理 Slack 工作区旧消息的开源项目。以下是项目的目录结构及其简要介绍：

slack-cleaner/
├── bin/             # 存放可执行脚本
├── data/            # 存储临时数据
├── Dockerfile       # Docker 构建文件
├── etc/             # 配置文件
│   └── config.json  # 项目配置文件
├── lib/             # 存放项目核心代码
├── LICENSE          # 项目许可证
├── package.json     # Node.js 项目依赖配置
├── README.md        # 项目说明文件
└── test/            # 测试代码

• bin/: 存放可执行脚本，例如启动项目的脚本。
• data/: 存储临时数据，如日志文件等。
• Dockerfile: 用于构建项目镜像的 Docker 文件。
• etc/: 存放项目配置文件。
• lib/: 存放项目核心代码，包括处理 Slack API 请求的逻辑。
• LICENSE: 项目遵循的开源许可证。
• package.json: 定义了 Node.js 项目所需的依赖和脚本。
• README.md: 包含项目的详细说明和如何使用的信息。
• test/: 存放项目的单元测试代码。

2. 项目的启动文件介绍

项目的启动文件为 bin/slack-cleaner.js，该脚本负责初始化和运行 Slack Cleaner。以下是启动文件的简要介绍：

• 该脚本会加载配置文件 etc/config.json。
• 设置 Slack API 的访问令牌和其他必要参数。
• 初始化日志系统。
• 执行消息清理任务。

启动项目时，可以在命令行中运行以下命令：

node bin/slack-cleaner.js

3. 项目的配置文件介绍

项目的配置文件为 etc/config.json，该文件包含了运行 Slack Cleaner 所需的所有配置项。以下是配置文件的简要介绍：

{
  "slack": {
    "token": "xoxb-your-slack-bot-token",
    "channels": ["general", "random"]
  },
  "days": 30,             // 清理 30 天前的消息
  "dryRun": false         // 若设为 true，将不实际删除消息
}

• slack.token: Slack 机器人的访问令牌，用于认证 API 请求。
• slack.channels: 需要清理消息的频道名称列表。
• days: 指定清理多长时间之前的消息。
• dryRun: 若设为 true，则不会实际删除消息，而是模拟删除过程，用于测试配置。

确保正确配置 etc/config.json 文件，然后就可以通过启动文件来运行 Slack Cleaner 项目了。