VSCode插件开发如何阻止package.json自动添加开发相关字段

问题原因 #

你猜测的触发条件完全准确：用于extensionHost调试的工作区同时安装了同ID的Marketplace正式版插件，是触发该问题的核心原因。
这些被自动写入的字段本质是VSCode扩展管理模块的运行时内部元数据，正常情况下只会保存在VSCode的扩展缓存数据库的内存/本地存储中，根本不属于插件package.json要求的公开Schema字段。当调试会话启动时，VSCode需要同时加载正式版插件和本地开发版插件，两个同ID插件的元数据写入逻辑出现路径串扰，就会把本该写入内部缓存的元数据，直接写到本地开发目录的package.json文件里。该问题属于VSCode扩展加载逻辑的边缘bug，出现概率不高，和你遇到的「长期开发仅少数几次触发」的表现完全一致。

解决方案 #

按优先级排序，可组合使用彻底避免问题复发：

• 调试前卸载调试工作区中同ID的正式发布版插件
  扩展宿主调试窗口本身会自动加载当前正在开发的本地插件，不需要额外安装商店版本。同ID多版本共存不仅会触发元数据串写，还可能导致调试断点不命中、插件逻辑加载错乱等其他问题。如果日常使用需要保留正式版插件，可以创建独立的调试专用工作区，和日常开发使用的全局VSCode配置隔离。
• 配置独立的调试扩展目录，从环境层面隔离
  在项目.vscode/launch.json的扩展调试配置中，添加独立扩展目录参数，让调试会话使用的扩展安装路径和全局路径完全隔离，从根源上避免串扰：

  {
    "version": "0.2.0",
    "configurations": [
      {
        "name": "Run Extension",
        "type": "extensionHost",
        "request": "launch",
        "args": [
          "--extensionDevelopmentPath=${workspaceFolder}",
          // 指定调试专用的扩展目录，和全局扩展隔离
          "--extensions-dir", "${workspaceFolder}/.vscode-debug-extensions"
        ],
        "outFiles": ["${workspaceFolder}/out/**/*.js"]
      }
    ]
  }
  

  配置后调试会话安装的所有插件都会存在项目本地的.vscode-debug-extensions目录下，把这个目录加入.gitignore即可，不会和全局安装的正式版插件产生冲突。
• 加发布前强制校验钩子，流程上兜底
  不管是调试误改还是其他原因导致的package.json脏字段，都可以在发布流程加前置检查自动清理，避免异常内容被发布到Marketplace。在项目中添加prepublishOnly生命周期脚本，打包发布前自动移除所有VSCode内部运行时字段：
  首先在package.json的scripts中添加钩子：

  {
    "scripts": {
      "prepublishOnly": "node ./scripts/clean-package.js",
      // 其他原有脚本保留
    }
  }
  

  然后新建scripts/clean-package.js文件，内容如下：

  const fs = require('fs');
  const path = require('path');
  const pkgPath = path.join(__dirname, '../package.json');
  const pkg = JSON.parse(fs.readFileSync(pkgPath, 'utf8'));
  // 所有需要移除的VSCode内部运行时字段
  const INVALID_FIELDS = [
    'identifier', 'isBuiltin', 'isUserBuiltin',
    'isUnderDevelopment', 'extensionLocation', 'targetPlatform'
  ];
  INVALID_FIELDS.forEach(field => delete pkg[field]);
  fs.writeFileSync(pkgPath, JSON.stringify(pkg, null, 2) + '\n');
  

  配置后只要执行vsce publish或者vsce package，脚本都会自动运行清理异常字段，完全避免脏包发布的问题。

内容的提问来源于stack exchange，提问作者Mark