代码片段指南

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

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

• 使用 Snippets: Configure User Snippets (代码片段：配置用户代码片段) 命令创建并测试你的代码片段
• 对代码片段满意后，将整个 JSON 文件复制到扩展文件夹中，例如命名为 snippets.json
• 在你的 package.json 中添加以下代码片段贡献配置

{
  "contributes": {
    "snippets": [
      {
        "language": "javascript",
        "path": "./snippets.json"
      }
    ]
  }
}

提示：通过在 package.json 中添加以下配置，将你的扩展标记为代码片段扩展

{
  "categories": ["Snippets"]
}

你可以在此处找到完整的源代码：https://github.com/microsoft/vscode-extension-samples/tree/main/snippet-sample。

使用 TextMate 代码片段

你还可以使用 yo code 扩展生成器将 TextMate 代码片段 (.tmSnippets) 添加到你的 VS Code 安装中。该生成器提供了一个 New Code Snippets 选项，允许你指向包含多个 .tmSnippets 文件的文件夹，这些文件将被打包成 VS Code 代码片段扩展。该生成器也支持 Sublime 代码片段 (.sublime-snippets)。

最终生成的输出包含两个文件：一个是包含将代码片段集成到 VS Code 所需元数据的扩展清单 package.json，另一个是包含已转换为 VS Code 代码片段格式的 snippets.json 文件。

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

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