代码片段指南
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。