Project Config

project-config

用途

用直接编辑项目配置文件的方式管理微信小程序 / 小游戏项目设置。

本 scene 不调用 wechatide 工具；用文件系统读写 JSON 即可。

适合场景：

• 开关合法域名校验、热重载、Skyline 调试等本地开发选项
• 调整 ES6 / 增强编译、上传压缩、过滤无依赖文件等编译与上传相关开关
• 修改 appid、miniprogramRoot、libVersion、packOptions 等一级字段
• 区分应写入公共配置还是个人私有配置

不适合：

• 打开 / 关闭项目窗口、预览、上传、自动化（用其他 scene）
• 修改微信开发者工具的全局偏好（非项目级配置）

官方文档：项目配置文件

配置文件位置

两个文件都在项目根目录（与 project.config.json 同级），不在 miniprogramRoot 里面。

生效规则：

1. private 中与 common 同名的字段，以 private 为准。
2. 开发期偏好（见下方「可写 private」）→ 优先改 project.private.config.json 的 setting。
3. 影响编译 / 上传产物的开关（见下方「必须写 common」）→ 只能改 project.config.json 的 setting，写在 private 里不会按预期生效。
4. 改完若看起来没生效，先检查 private 是否覆盖了同名字段。
5. packOptions、watchOptions、部分根路径字段修改后，可能需要重新打开项目才生效。

工作流

1. 在项目根找到并读取 project.config.json；若存在再读 project.private.config.json。
2. 按「private 覆盖 common」理解当前生效值。
3. 根据字段类型选择写入目标文件。
4. 合并修改：只改需要的键，保留其余字段；保证合法 JSON（无注释、无尾逗号）。
5. 写回磁盘。若开发者工具已打开该项目且未生效，提示用户重新编译或重新打开项目。

常见目标

示例：关闭合法域名校验

写入或合并到 project.private.config.json：

{
  "setting": {
    "urlCheck": false
  }
}

示例：开启 ES6 与增强编译

合并到 project.config.json 的 setting（es6 与 enhance 必须同开同关）：

{
  "setting": {
    "es6": true,
    "enhance": true
  }
}

setting 字段速查

完整说明见官方文档。

可写 private（开发期偏好）

必须写 common（编译 / 上传产物）

其他常用一级字段

一般写入 project.config.json：

packOptions.ignore / include 与 debugOptions.hidedInDevtools 的规则项：

示例：

{
  "type": "suffix",
  "value": ".webp"
}

执行约定

• 只通过读写上述 JSON 完成配置变更，不要为此调用 wechatide -t ...。
• 不要编造未在官方文档出现的字段名。
• 修改前先读现有文件；合并写入，避免覆盖掉无关配置。
• 输出给用户时说明改了哪个文件、哪个字段、新旧值（如可知）。

参考

• 项目配置文件（微信开放文档）