在 VS Code 中试用

contributes.snippets 贡献点允许您将代码片段打包到 Visual Studio Code 扩展中以供共享。

代码片段指南

创建代码片段主题包含创建代码片段的所有信息。本指南/示例仅展示了如何将您自己的代码片段转换为可共享的扩展。建议的工作流程是:

使用代码片段:配置用户代码片段命令创建和测试您的代码片段

  • 当您对代码片段满意后,将整个 JSON 文件复制到扩展文件夹中,例如snippets.json
  • 将以下代码片段贡献添加到您的package.json
  • 提示:使用package.json中的以下配置将您的扩展标记为代码片段扩展
{
  "contributes": {
    "snippets": [
      {
        "language": "javascript",
        "path": "./snippets.json"
      }
    ]
  }
}

您可以在以下网址找到完整的源代码:https://github.com/microsoft/vscode-extension-samples/tree/main/snippet-sample

{
  "categories": ["Snippets"]
}

您还可以使用yo code扩展生成器将 TextMate 代码片段 (.tmSnippets) 添加到您的 VS Code 安装中。该生成器有一个选项新建代码片段,可让您指向包含多个 .tmSnippets 文件的文件夹,并将它们打包成 VS Code 代码片段扩展。该生成器还支持 Sublime 代码片段 (.sublime-snippets)。

最终的生成器输出包含两个文件:一个扩展清单package.json,其中包含将代码片段集成到 VS Code 的元数据;以及一个snippets.json文件,其中包含已转换为 VS Code 代码片段格式的代码片段。

将生成的代码片段文件夹复制到您的.vscode/extensions文件夹下的新文件夹中,然后重新启动 VS Code。

.
├── snippets                    // VS Code integration
│   └── snippets.json           // The JSON file w/ the snippets
└── package.json                // extension's manifest

本文包含 1 个章节