VS Code 插件命名规范

命名规则

所有 WTC 项目的 VS Code 插件必须遵循统一的命名规范：

基本格式

wtc-[功能名称]

• 前缀: 所有插件名称必须以 wtc- 开头
• 功能名称: 使用小写字母和连字符，简洁明了地描述插件功能
• 避免: 不要使用 extension、plugin 等冗余后缀

命名映射

旧名称	新名称	说明
google-drive-uploader	wtc-google-drive	Google Drive 上传工具
vscode-toolbar-extension	wtc-toolbars	工具栏快捷操作
wtc-docs-server	wtc-docs-server	文档服务器管理（已符合规范）
wtc-local-server	wtc-local-server	本地开发服务器（已符合规范）

实施要点

1. 目录结构

vscode-extensions/
├── wtc-google-drive/       # Google Drive 上传工具
├── wtc-toolbars/           # 工具栏扩展
├── wtc-docs-server/        # 文档服务器
└── wtc-local-server/       # 本地服务器

2. package.json 配置

插件的 package.json 中的 name 字段必须与目录名一致：

{
  "name": "wtc-toolbars",
  "displayName": "WTC Toolbars",
  "description": "WorldTourCasino 工具栏快捷操作"
}

3. 命令和贡献点

插件提供的命令也应遵循统一的命名规范：

{
  "contributes": {
    "commands": [
      {
        "command": "wtc-toolbars.runCV",
        "title": "WTC: Run Classic Vegas"
      }
    ]
  }
}

4. 配置项

插件的配置项应使用插件名称作为命名空间：

{
  "contributes": {
    "configuration": {
      "title": "WTC Toolbars",
      "properties": {
        "wtc-toolbars.enableAutoReload": {
          "type": "boolean",
          "default": false
        }
      }
    }
  }
}

迁移指南

重命名步骤

1. 停止所有相关服务
2. 重命名插件目录
3. 更新插件 package.json 中的 name 字段
4. 更新所有命令、配置项的命名空间
5. 更新主项目 .vscode/settings.json 中的引用
6. 更新 WorldTourCasino.code-workspace 中的引用
7. 更新相关脚本和文档
8. 重新安装和链接插件

向后兼容性

• 对于已发布的插件，需要考虑向后兼容性
• 可以在过渡期内同时支持新旧命令名称
• 使用别名或重定向来处理旧的配置项

相关文档

• VS Code 扩展开发规范
• [添加新VS Code扩展规范](./添加新VS Code扩展规范.md)
• 扩展开发规则与最佳实践

---

最后更新: 2025-10-10