VSNotesのタグ毎にファイルテンプレートを作成する方法

公開日:

2023-01-14

vscode

ブログ

プログラミング

どーも！某 (@7254bou)です！

VSNotesを使っていると、毎回タグを書くのが面倒ですよね！

実はコードスニペットでテンプレートを作成すると、VSNotesのファイル作成時にテンプレートを使うことができます。

そこで今回は、VSNotesのタグ毎にファイルテンプレートを作成する方法を紹介します。

VSNtoesのタグ毎にファイルテンプレートを作成する方法

例えば、articleタグを付けた以下のようなテンプレートを作りたいとします。

---
tags:
    - article
---

VSNotesでテンプレートを作成するには、下記のようにします。

1. VSCodeのsetting.jsonにテンプレートを追加する

まずsettings.jsonを開きます。

setting.jsonを開くには、VSCodeのコマンドパレット（Ctrl + Shift + P、macOSの場合はCmd + Shift + P）から'setting.json'と入力し、基本設定: 設定を開く(Preferences: Open Settings (JSON))を選択します。

setting.jsonが開けたら、下記のように"vsnote.templates"の値にテンプレートの名前を追加します。

"vsnote.templates": [
    "article",
],

"vsnote.templates"の値は、テンプレートの名前になります。

"vsnote.templates"の値は、"vsnote.templates": ["article"]のように、配列で記述します。

この設定をするとVSNotesのファイル作成時（コマンドパレットのVSNotes: New Note選択時）にテンプレート名を選択することができます。

2. VSCodeのスニペットにテンプレートを追加する

テンプレート名は選択できるようになりましたが、そのテンプレートの中身を書いていません。なので次はテンプレートの内容を追加します。

一番上にあるメニューから、Code > 基本設定 > ユーザスニペットの設定を選択します。

検索ボックスにMarkdownと入力し、Markdownのスニペットを選択します。

{...}を選択し、{...}の中身を以下のように変更します。

"vsnote_template_article": {
    "prefix": "vsnote_template_article",
    "body": [
        "---",
        "tags:",
        "\t- article",
        "---",
        "\n# $TM_FILENAME_BASE\n",
        "$1",
    ],
    "description": "VSNotesのarticleタグ用のテンプレート"
},

テンプレート用のスニペット名をつける場合には必ず"vsnote\_template\_"という接頭辞をつけてください。

また、"prefix"の値は、"vsnote_template_"とテンプレート名をつなげたものにしてください。

例えば、"vsnote_template_article"というテンプレートの場合は、"prefix"の値は"vsnote_template_article"になります。

"body"の値は、テンプレートの内容になります。"body"の値は、"body": ["---", "tags:", "\t- article", "---",]のように、一行毎に配列で記述します。

"description"の値は、テンプレートの説明になります。ご自由に記述してください。

この設定をすることで、VSNotesのファイル作成時に指定したテンプレートの内容がファイルに挿入されます。

念の為テンプレートを作成したら、VSCodeを再起動してください。