PreMiD Activities CLI工具详解：提升开发效率的10个实用命令

PreMiD Activities CLI工具详解：提升开发效率的10个实用命令

【免费下载链接】Presences🛒 Storage for Activities located at our Activity Library.项目地址: https://gitcode.com/gh_mirrors/pr/Presences

PreMiD Activities CLI工具是GitHub加速计划（pr/Presences）项目中一款高效的开发辅助工具，专为活动（Activity）开发人员设计。它提供了一系列命令来简化活动的创建、构建、测试和发布流程，帮助开发者快速上手并提升工作效率。通过本文介绍的10个实用命令，你将能够轻松掌握PreMiD活动开发的全流程。

一、活动创建与初始化

1.pmd new- 快速创建新活动

pmd new命令是创建新活动的起点，它会引导你完成活动的基本信息设置，并自动生成必要的文件结构。该命令会检查活动名称是否在DMCAblockList中，确保合规性。

使用方法：

pmd new "活动名称"

执行命令后，工具会提示你输入活动名称、作者Discord ID、标签和类别等信息。完成后，会在websites/[首字母]/[活动名称]目录下生成metadata.json和presence.ts等文件。

PreMiD活动创建流程演示，展示了使用pmd new命令创建新活动的完整过程

2.pmd versionize- 版本化现有活动

当需要为现有活动升级API版本时，可以使用pmd versionize命令。它会自动创建新版本目录，并复制现有代码，方便你进行针对性修改。

使用方法：

pmd versionize "活动名称"

该命令会根据当前活动的API版本，创建一个新版本目录（如v2），并更新metadata.json中的apiVersion字段。

二、构建与开发

3.pmd build- 构建活动文件

pmd build命令用于将TypeScript代码编译为JavaScript，并进行必要的验证和打包。它支持多种构建模式，满足不同开发需求。

基本使用方法：

pmd build "活动名称"

常用参数：

• --watch：监听文件变化，自动重新构建
• --all：构建所有活动
• --changed：只构建有变化的活动
• --zip：生成ZIP压缩包

4.pmd dev- 开发模式构建

虽然没有直接的dev命令，但可以通过pmd build结合--watch参数实现开发模式：

pmd build "活动名称" --watch

这会启动一个监听进程，当你修改代码后自动重新构建，非常适合开发过程中使用。

PreMiD活动开发流程演示，展示了使用pmd build --watch命令进行实时开发的过程

三、版本管理

5.pmd bump- 版本号管理

pmd bump命令用于更新活动的版本号，支持语义化版本控制（SemVer）。你可以指定major、minor或patch版本的更新，也可以直接指定版本号。

使用方法：

# 升级补丁版本 pmd bump "活动名称" patch # 升级次要版本 pmd bump "活动名称" minor # 升级主要版本 pmd bump "活动名称" major # 指定具体版本 pmd bump "活动名称" 2.1.0

该命令会自动更新metadata.json中的version字段，并提示更新成功。

四、检查与验证

6.pmd build --validate- 验证活动合法性

在构建活动时，可以添加--validate参数来验证活动是否符合PreMiD的规范：

pmd build "活动名称" --validate

这会检查metadata.json是否符合 schema 要求，确保活动能够被PreMiD正确识别和使用。

7.pmd checkDns- 检查DNS设置

pmd checkDns命令用于检查活动的域名DNS设置是否正确，确保活动能够正常访问。

使用方法：

pmd checkDns

该命令会检查配置的域名是否正确解析，帮助你提前发现潜在的访问问题。

五、发布与部署

8.pmd release- 发布活动

pmd release命令用于将活动发布到PreMiD的活动库。该命令只能在CI环境中运行，确保发布流程的规范性和安全性。

使用方法：

pmd release

该命令会自动构建、验证并上传有变化的活动，同时处理已删除的活动。

9.pmd build --zip- 生成发布压缩包

如果你需要手动发布活动，可以使用--zip参数生成包含所有必要文件的压缩包：

pmd build "活动名称" --zip

这会在dist目录下生成一个ZIP文件，包含编译后的JavaScript文件和metadata.json。

六、其他实用命令

10.pmd updateAssets- 更新静态资源

pmd updateAssets命令用于更新活动所需的静态资源，如图标、缩略图等。

使用方法：

pmd updateAssets

该命令会从指定的URL下载最新的资源文件，并更新到相应的目录中。

结语

PreMiD Activities CLI工具提供了一整套活动开发流程所需的命令，从创建、开发、测试到发布，全方位提升开发效率。通过熟练掌握这些命令，你可以更加专注于活动功能的实现，而不用过多关注繁琐的配置和部署细节。

如果你是PreMiD活动开发的新手，建议从pmd new开始，逐步尝试各个命令。随着使用的深入，你会发现这些工具命令能够极大地简化你的开发工作，让你能够更快速地创建出高质量的PreMiD活动。

要开始使用这些命令，首先需要克隆项目仓库：

git clone https://gitcode.com/gh_mirrors/pr/Presences cd Presences npm install

然后就可以开始你的PreMiD活动开发之旅了！

【免费下载链接】Presences🛒 Storage for Activities located at our Activity Library.项目地址: https://gitcode.com/gh_mirrors/pr/Presences