Undiscord 项目使用教程

1. 项目目录结构及介绍

Undiscord 项目的目录结构如下：

undiscord/
├── build/
├── help/
├── images/
├── src/
│   ├── eslintrc
│   ├── gitignore
│   ├── CONTRIBUTING.md
│   ├── LICENSE
│   ├── README.md
│   ├── deleteDiscordMessages.user.js
│   ├── package-lock.json
│   ├── package.json
│   └── rollup.config.mjs
└── ...

目录介绍

• build/: 存放构建生成的文件。
• help/: 存放帮助文档和相关资源。
• images/: 存放项目所需的图片资源。
• src/: 项目的源代码目录。
  • eslintrc: ESLint 配置文件。
  • gitignore: Git 忽略文件配置。
  • CONTRIBUTING.md: 贡献指南。
  • LICENSE: 项目许可证。
  • README.md: 项目说明文档。
  • deleteDiscordMessages.user.js: 项目的主要启动文件。
  • package-lock.json: 锁定依赖包版本的文件。
  • package.json: 项目依赖和脚本配置文件。
  • rollup.config.mjs: Rollup 打包配置文件。

2. 项目的启动文件介绍

项目的启动文件是 src/deleteDiscordMessages.user.js。这个文件是 Undiscord 的核心脚本，负责删除 Discord 频道或私信中的消息。

主要功能

• 消息删除: 通过调用 Discord API 删除指定频道或私信中的消息。
• 批量删除: 支持批量删除消息，并根据配置进行延迟处理以避免被 Discord 限制。
• 过滤功能: 支持根据内容、日期、消息类型等条件进行过滤。

使用方法

1. 安装一个支持 UserScript 的浏览器扩展，如 Tampermonkey 或 Violentmonkey。
2. 将 deleteDiscordMessages.user.js 文件添加到扩展中。
3. 打开 Discord 网页版，进入需要删除消息的频道或私信。
4. 点击浏览器扩展中的 Undiscord 按钮，按照提示进行操作。

3. 项目的配置文件介绍

项目的配置文件主要包括 package.json 和 rollup.config.mjs。

package.json

package.json 文件包含了项目的依赖、脚本命令和其他元数据。

{
  "name": "undiscord",
  "version": "5.2.3",
  "description": "Delete all messages in a Discord channel or DM (Bulk deletion)",
  "main": "src/deleteDiscordMessages.user.js",
  "scripts": {
    "build": "rollup -c",
    "test": "echo \"Error: no test specified\" && exit 1"
  },
  "author": "victornpb",
  "license": "MIT",
  "dependencies": {
    "rollup": "^2.0.0"
  }
}

rollup.config.mjs

rollup.config.mjs 是 Rollup 的配置文件，用于打包和构建项目。

import { defineConfig } from 'rollup';

export default defineConfig({
  input: 'src/deleteDiscordMessages.user.js',
  output: {
    file: 'build/deleteDiscordMessages.user.js',
    format: 'iife'
  },
  plugins: [
    // 插件配置
  ]
});

配置说明

• input: 指定入口文件为 src/deleteDiscordMessages.user.js。
• output: 指定输出文件为 build/deleteDiscordMessages.user.js，格式为 iife（立即执行函数表达式）。
• plugins: 配置 Rollup 插件，用于处理代码打包过程中的各种任务。

通过以上配置，可以方便地进行项目的构建和打包，确保代码的正确性和可维护性。