hacomono TECH BLOG

フィットネスクラブ・スクールなど施設・店舗のための会員管理・予約・決済システム「hacomono」 開発チームの技術ブログ

汎用設定用 vscode プロジェクトを作ったら捗った

どうも、みゅーとん(@_mew_ton)です。

今回は小ネタです。

会社支給のPCが新しくなったので、設定をし直しているのですが、どうもその作業が面倒だったので、

vscode を使ってまとめて管理できるようにしてみました。

TL;DR

先に3行でまとめ

  • vscode の project を “ホームディレクトリ” をベースに作成する
  • 設定ファイルのみを抽出して管理できるようにしておく
  • nginx などのコンフィグパスをいちいち調べ直さなくて良いので便利

注意事項

  • mac book 向けの記載なので、win, linux ユーザは都度読み替えてください。

やること

以下の内容の json ファイルをホームディレクトリのどこかに、*.code-workspace というファイル名で保存する

~/.vscode/home.code-workspace に配置しているので、folders[0].path は相対的にホームディレクトリを指すように .. となっています。

{
    "folders": [
        {
            "path": "..",
            "name": "~"
        }
    ],
    "settings": {
        "files.exclude": {
            "Desktop": true,
            "Documents": true,
            "Downloads": true,
            "Library": true,
            "Movies": true,
            "Music": true,
            "Pictures": true,
            "Public": true
        }
    }
}

これを vscode にて、 Open Workspace from File... から開くと、以下のようになります。

ホームディレクトリ配下が vscode で開かれます。

Document や開発用ディレクトリを settings.files.exclude で指定するので、開かなくてよいファイルがツリー上で非表示になっています。

設定フォルダを追加する

あとは、vim や nginx などのコンフィグファイルの配置場所を code-workspacefolders に追加すれば良いだけ。

普段設定を管理するような主要なものをここに追加しておくとよいです。

一例として、私の設定はこうなっています。

{
    "folders": [
        {
            "path": "..",
            "name": "~"
        },
        {
            "path": "../.vscode",
            "name": "#vscode"
        },
        {
            "path": "/opt/homebrew/etc/nginx", // 絶対パスも指定可能 !!
            "name": "#nginx"
        },
        {
            "path": "../.config/gh",
            "name": "#gh"
        },
        {
            "path": "../.config/nvim",
            "name": "#neovim"
        },
        {
            "path": "../.rbenv",
            "name": "#rbenv"
        },
        {
            "path": "../.volta",
            "name": "#volta"
        },
        {
            "path": "../.ssh",
            "name": "#ssh"
        }
    ],
    "settings": {
        "files.exclude": {
            "Desktop": true,
            "Documents": true,
            "Downloads": true,
            "Library": true,
            "Movies": true,
            "Music": true,
            "Pictures": true,
            "Public": true,
            "Workspace": true // 開発コードが置かれるところ
        }
    }
}

保存するとこうなります。

あとはもう、 vscode 上で設定値を編集しやすくなるように、 syntax highlight 用の拡張機能を随時導入すればよいだけ。

簡単です。

意外なメリット

弊社は github enterprise で copilot を導入していたため、 設定ファイルに対しても自動補完が効きました。

vscode で設定値を記述できるようにしたので、思わぬメリットがありました。

まとめ

実は、 nginx の設定フォルダのパスを覚えていられず、毎回調べていました。

これでスッキリ管理できて良いです。


株式会社hacomonoでは一緒に働く仲間を募集しています!
採用情報や採用ウィッシュリストも是非ご覧ください!