如何在VS Code中正确存储与引用项目常量？

其实settings.json并不是存储这类自定义项目常量的最佳选择哦，主要有两个核心问题：

• 它的设计初衷是存放VS Code官方提供的编辑器配置项，自定义的键会触发linter的“Unknown configuration setting”警告，影响配置文件的整洁性。
• 如果是多人协作项目，.vscode/settings.json通常会被加入.gitignore（因为它可能包含个人编辑器偏好设置），这样你的自定义常量就无法同步给团队其他成员。

那有哪些更合适的替代方案呢？给你推荐几个：

1. 使用.env文件 + 环境变量引用 #

这是最通用的方案，也是多人协作时的首选：

• 在项目根目录创建.env文件，写入你的常量：

  MYVAR=Foo
  

• 安装DotENV扩展（它会自动加载.env文件中的环境变量到VS Code的环境中）。
• 在launch.json或tasks.json中通过${env:MYVAR}引用这个变量。
• 注意：如果是敏感信息（比如密钥），记得把.env加入.gitignore；如果是项目通用的公开常量，可以提交到仓库。

2. 给settings.json添加自定义Schema消除警告（适合个人项目） #

如果你坚持要用settings.json，可以通过自定义JSON Schema来让VS Code识别你的自定义变量，消除警告：

• 在.vscode/settings.json中添加如下配置：

  "json.schemas": [
    {
      "fileMatch": [".vscode/settings.json"],
      "schema": {
        "type": "object",
        "properties": {
          "MYVAR": {
            "type": "string",
            "description": "我的自定义项目常量"
          }
        }
      }
    }
  ]
  

• 这样VS Code的linter就会把MYVAR识别为合法配置项，不会再弹出警告。不过还是要注意，多人协作时如果这个文件被忽略，变量无法同步的问题。

3. 使用VS Code任务的inputs定义变量 #

如果你的常量只在tasks.json中使用，可以直接在任务配置里定义inputs：

{
  "version": "2.0.0",
  "inputs": [
    {
      "id": "myVar",
      "type": "string",
      "default": "Foo",
      "description": "自定义常量"
    }
  ],
  "tasks": [
    {
      "label": "My Task",
      "type": "shell",
      "command": "echo ${input:myVar}",
      "problemMatcher": []
    }
  ]
}

这种方式更贴合tasks.json的设计，但变量只能在任务范围内使用，无法在launch.json中引用。

总结一下：如果是多人协作项目，优先用.env方案；个人项目的话，用settings.json加自定义Schema也能解决问题，但要权衡同步性的问题。

内容的提问来源于stack exchange，提问作者Felix K.