VS Code でコードスニペットを作成・管理する方法

著者:Sayaib Sarkar更新日:5 分で読めます

このページの内容 5 セクション

要点:VS Code にはスニペット機能が組み込まれています。Snippets: Configure Snippets を実行し、言語またはプロジェクトのファイルを選んで、各スニペットを prefix と body を持つ JSON として書きます。もっと手早く済ませたいなら、DevSnip Pro の Create Snippet で選択したコードを数秒でスニペットとして保存し、Spring Boot、ASP.NET Core、FastAPI、React、Next.js、Flutter、SwiftUI 向けの ds- スニペットを使いましょう。

よいスニペットが節約するのはキー入力だけではありません。正しいステータスコードを返すエラーハンドラー、正しく準備されたテスト、response.ok をチェックする fetch ラッパーなど、すでにデバッグ済みのパターンをそのまま残せます。

VS Code がスニペットを保存する場所

範囲ファイル用途
1 つの言語ユーザースニペットフォルダーの typescript.json1 つの言語向けの個人用スニペット
グローバルユーザースニペットフォルダーの *.code-snippets複数の言語向けの個人用スニペット
プロジェクトリポジトリの .vscode/*.code-snippetsコードと一緒にコミットするチーム用スニペット

どれもコマンドパレット(Ctrl/Cmd+Shift+P)から Snippets: Configure Snippets(古いバージョンでは Preferences: Configure User Snippets)で開けます。

スニペットを手で書く

スニペットは名前付きのエントリーで、入力するテキスト(prefix)、挿入する行(body)、IntelliSense に表示される任意の description から成ります:

JSON
{
  "Express route handler": {
    "prefix": "exroute",
    "scope": "javascript,typescript",
    "body": [
      "router.${1|get,post,put,delete|}('/${2:path}', async (req, res, next) => {",
      "  try {",
      "    $0",
      "  } catch (err) {",
      "    next(err);",
      "  }",
      "});"
    ],
    "description": "Async Express route that passes errors to next()"
  }
}

スニペットを便利にする構文:

  • $1、$2… はタブストップです。Tab で移動でき、$0 はカーソルの最終位置です。
  • ${1:path} は既定のテキストを持つプレースホルダーで、上書き入力できます。
  • ${1|get,post,put,delete|} は選択肢で、値のドロップダウンになります。
  • $TM_FILENAME_BASE、$CURRENT_YEAR、$CLIPBOARD などの変数でコンテキストを挿入できます。${TM_FILENAME_BASE/(.*)/${1:/pascalcase}/} は user-card を UserCard に変換します。
  • scope(.code-snippets ファイル内)でスニペットを特定の言語に限定できます。

body の中では、文字としての $ は \\$、プレースホルダー内の } は \\} とエスケープします。

選択したコードからスニペットを保存する

エスケープした引用符だらけの JSON を手で書くのは時間がかかります。DevSnip Pro なら:

  1. 再利用したいコードを選択します。
  2. DevSnip Pro: Create Snippet を実行します。
  3. 入力するプレフィックス、名前、任意の説明を入力します。
  4. 求められたらウィンドウを再読み込みします。VS Code は拡張機能が提供するスニペットを起動時に読み込みます。

これで、その言語の IntelliSense にスニペットが表示されます(39 言語に対応)。プレフィックスがすでにほかのスニペットで使われている場合は先に確認されるので、2 つのスニペットが同時に表示されることはありません。DevSnip Pro: Saved Snippets で保存したものを一覧表示し、使わなくなったものを削除できます。

用意されたフレームワークスニペットを使う

対応するファイルで ds- と入力するか、DevSnip Pro: Framework Snippets を実行してリストから選びます。全部で 56 個あり、どれも VS Code で展開してからコンパイル(フレームワークが許す場合は実行も)しているので、挿入したまま動きます:

  • Spring Boot:ds-rest-controller、ds-service、ds-entity、ds-repository、ds-controller-advice、ds-webmvctest、ds-junit
  • ASP.NET Core:ds-minimal-api、ds-api-controller、ds-exception-handler、ds-dbcontext、ds-xunit、ds-webapp-test
  • Python:ds-fastapi-app、ds-fastapi-router、ds-pydantic、ds-flask-route、ds-django-view、ds-pytest、ds-pytest-fixture
  • React と Next.js:ds-rfc、ds-hook、ds-context、ds-next-page、ds-next-route、ds-server-action、ds-rtl
  • TypeScript と Node.js:ds-express-router、ds-express-error、ds-zod、ds-fetch-json、ds-vitest
  • Flutter と SwiftUI:ds-stless、ds-stful、ds-future-builder、ds-swiftui-view、ds-view-model

Java、C#、Python、Swift には ds-logger スニペットもあります。これで作成したロガーを、Insert Debug Log がデバッグ行の出力に使います。

スニペット集を役立つ状態に保つ

  • プレフィックスは作るものに合わせて名付けましょう。出どころで名付けるのは避けます:snippet3 より exroute。共通の接頭辞(ds- など)を付けると IntelliSense でまとまって表示されます。
  • スニペットは小さく。ファイル全体を生成するスニペットは調整しにくいもの。リソース全体が必要なら、ジェネレーターのほうが向いています。DevSnip Pro の API Resource Scaffolder は、Express、NestJS、Next.js、Fastify、Spring Boot、ASP.NET Core、FastAPI 向けに、ページングを備えた検証済みの CRUD API を作成します。
  • チームのスニペットはリポジトリで共有しましょう。.vscode/project.code-snippets ファイルはコードと同じようにバージョン管理・レビューされ、プロジェクトを開いた人全員が使えます。
  • 整理しましょう。何か月も使っていないスニペットは削除すると、よく使うものが見つけやすくなります。

自分のエディターで試してみよう

無料・アカウント不要・ローカルで動作。Windows、macOS、Linux の VS Code 1.93 以降と JetBrains IDE に対応。

code --install-extension sayaib.hue-console