スニペットガイド

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) もサポートしています。

最終的なジェネレーター出力には、2 つのファイルがあります。スニペットを 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 を再起動します。