いろいろ備忘録日記

主に .NET とか Go とか Flutter とか Python絡みのメモを公開しています。

VSCodeのスニペットで利用できる変数 (Visual Studio Code, Snippet, code-snippets)

関連記事

GitHub - devlights/blog-summary: ブログ「いろいろ備忘録日記」のまとめ

概要

以下、自分用のメモです。よく公式ドキュメントのURLとかも忘れるのでここにメモメモ。。。

VSCodeのスニペット機能、結構便利なのでよく利用しています。

で、このスニペット定義ファイルの中で利用できる変数とかをたいだい忘れる。。。

なので、ここにメモしておこうと思います。

個人的にすごく利用している変数

  • ${数字:デフォルト値}
    • タブストップの番号でエディタ上に「デフォルト値」が表示される

数字をインクリメントしていくことで、ユーザさんが入力してタブキーを押すと次の番号の位置に飛びます。

一般的によく使う変数

  • TM_SELECTED_TEXT
    • 選択中のテキスト
  • TM_CURRENT_LINE
    • 現在の行の内容
  • TM_CURRENT_WORD
    • カーソル位置の単語
  • TM_LINE_INDEX
    • ゼロ始まりの行番号(0,1,2,...)
  • TM_LINE_NUMBER
    • 1始まりの行番号(1,2,3,...)
  • TM_FILENAME
    • ファイル名(拡張子込み)
  • TM_FILENAME_BASE
    • 拡張子なしファイル名
  • TM_DIRECTORY
    • ディレクトリパス
  • TM_FILEPATH
    • 絶対パス
  • RELATIVE_FILEPATH
    • ワークスペースやフォルダからの相対パス

クリップボード・ワークスペース関連

  • CLIPBOARD
    • クリップボードの内容
  • WORKSPACE_NAME
    • ワークスペースやプロジェクトフォルダ名
  • WORKSPACE_FOLDER
    • ワークスペースやプロジェクトフォルダのパス

日時関連

  • CURRENT_YEAR
    • 西暦
  • CURRENT_YEAR_SHORT
    • 西暦下2桁
  • CURRENT_MONTH
    • 2桁月(例:07)
  • CURRENT_MONTH_NAME
    • 月名(例:July)
  • CURRENT_MONTH_NAME_SHORT
    • 短い月名(例:Jul)
  • CURRENT_DATE
  • CURRENT_DAY_NAME
    • 曜日名(例:Tuesday)
  • CURRENT_DAY_NAME_SHORT
    • 短い曜日名(例:Tue)
  • CURRENT_HOUR
    • 時(00-23)
  • CURRENT_MINUTE
    • 分(00-59)
  • CURRENT_SECOND
    • 秒(00-59)
  • CURRENT_SECONDS_UNIX
    • Unixエポックからの秒数

コメント関連

  • BLOCK_COMMENT_START
    • ブロックコメント開始記号(言語に依存)
  • BLOCK_COMMENT_END
    • ブロックコメント終了記号(言語に依存)
  • LINE_COMMENT
    • 行コメント(言語に依存)

ランダム・UUID

  • RANDOM
    • ランダムな数値
  • RANDOM_HEX
    • ランダムな16進数
  • UUID
    • UUID(ユニークID)

その他

  • PATH_SEPARATOR
    • OSごとのパス区切り文字(例:/ や \)
  • USER
    • ユーザー名(環境による。vscodeのタスク変数と混同注意)

入力用(特殊用途)

  • ${input:変数ID}
    • tasks.jsonlaunch.json内で入力プロンプトを表示できる

参考情報

code.visualstudio.com


過去の記事については、以下のページからご参照下さい。

サンプルコードは、以下の場所で公開しています。