スニペット ガイド

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 ファイルの 2 つが含まれます。

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

生成されたスニペットフォルダーを .vscode/extensions フォルダー下の新しいフォルダーにコピーし、VS Code を再起動します。