代码片段指南
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)。
最终的生成器输出包含两个文件:一个扩展清单 `package.json`,其中包含将代码片段集成到 VS Code 的元数据;以及一个 `snippets.json` 文件,其中包含转换为 VS Code 代码片段格式的代码片段。
.
├── snippets // VS Code integration
│ └── snippets.json // The JSON file w/ the snippets
└── package.json // extension's manifest
将生成的代码片段文件夹复制到您的 `.vscode/extensions` 文件夹下的新文件夹中,然后重新启动 VS Code。