メインコンテンツへスキップ

Visual Studio Code で mermaid 記法の ER図を書く

    きっかけ

    脱Excelを模索していた中で、その有効な手段として辿り着いたのがMermaid記法でした。Mermaidはテキストで図を作成できる記法で、

    • ER図

    • フローチャート

    • シーケンス図

    などを作成できます。

    また、GitHubでもそのまま表示できるため、設計書をコードと一緒に管理しやすいのも魅力です。導入方法や記法の解説ページはたくさん見つかりました。しかし、私が知りたかった

    「プレビューボタンはどこにあるの?」

    という超基本的な情報がなかなか見つかりませんでした。同じところで迷う人がいるかもしれないので残しておきます。

    手順

    Visual Studio Codeに Markdown Preview Mermaid Support をインストールしておきます。

    新規ファイルを作成し、以下のようなコードを書きます。

    ```mermaid

    erDiagram
    users ||--o{ user_departments : belongs
    departments ||--o{ user_departments : contains

    users {
    int id PK "ID"
    varchar user_name "ユーザー名"
    }

    departments {
    int id PK "ID"
    varchar department_name "部署名"
    }

    user_departments {
    int id PK "ID"
    int user_id FK "ユーザーID"
    int department_id FK "所属ID"
    }
    ```

    重要:拡張子を .md にする

    ここで一つハマりました。ファイルを保存するときは、

    sample.md

    のように、拡張子を .md にします。「*.txt」 や 「*.sql」 のままだと、Markdownプレビュー機能が使えません。

    プレビューボタンの位置

    画像
    プレビューボタンの位置

    拡張子が「*.md」じゃないと、プレビューボタンが表示されません。

    画像
    ER図表示完了

    プレビューボタンを押すと、ER図が表示されます。

    まとめ

    テキストだけで図を管理できるので、

    • Gitで差分管理できる

    • Excelや画像ファイルが不要

    • 修正履歴を追いやすい

    といったメリットがあります。Mermaid自体の使い方は多くの解説記事がありますが、今回一番困ったのは

    「プレビューボタンが出てこない」

    という点でした。Visual Studio CodeでMermaidを表示するときは、

    1. 拡張機能を入れる

    2. ファイルを .md で保存する

    3. プレビューボタンを押す

    この3点を押さえておけば大丈夫です。

     
     
    京都在住のITエンジニア ラーメンと銭湯を巡る日々

    あなたへのおすすめ