片段指南

贡献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 代码扩展生成器将 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。