次のようなnginxの設定ファイルは、書式が少し崩れるだけで一気に読みにくくなります。
- nginx.conf
- conf.d/*.conf
そこで VS Code で 保存のたびに自動フォーマットしつつ、キーワード・変数・文字列・コメントを見やすく色分けして、編集効率を一段上げる設定を入れます。
本記事を実施していただくと、次のことができます。
- nginx設定ファイルの保存で自動整形
- ディレクティブが色分けされる
順番に解説します。
VS Codeで nginx.conf を「保存時に自動整形」＋「色分け強化」して爆速で読みやすくする方法
結論、以下の設定にしました。
JSON
{
// 保存時にフォーマット
"editor.formatOnSave": true,
// nginx のデフォルトフォーマッタを指定
"[nginx]": {
"editor.defaultFormatter": "AaaaronZhou.nginx-config-formatter-vscode-extension",
"editor.formatOnSave": true
},
"[nginxconf]": {
"editor.defaultFormatter": "AaaaronZhou.nginx-config-formatter-vscode-extension",
"editor.formatOnSave": true
},
"[nginx conf]": {
"editor.defaultFormatter": "AaaaronZhou.nginx-config-formatter-vscode-extension",
"editor.formatOnSave": true
},
"editor.semanticHighlighting.enabled": false,
"editor.tokenColorCustomizations": {
"textMateRules": [
{
// server / location / if / upstream など
"scope": ["keyword", "keyword.*", "entity.name", "entity.name.*"],
"settings": {
"foreground": "#C586C0",
"fontStyle": "bold"
}
},
{
// proxy_pass / rewrite / try_files / add_header など
"scope": ["support", "support.*"],
"settings": {
"foreground": "#DCDCAA"
}
},
{
// $host / $uri / $request_uri など
"scope": ["variable", "variable.*"],
"settings": {
"foreground": "#9CDCFE"
}
},
{
// パス・URL・正規表現
"scope": ["string", "string.*"],
"settings": {
"foreground": "#CE9178"
}
},
{
// コメント
"scope": ["comment", "comment.*"],
"settings": {
"foreground": "#6A9955",
"fontStyle": "italic"
}
}
]
}
}プラグインの導入
Nginx Config Formatterというプラグインを導入しておきましょう。
あわせて読みたい
Nginx Config Formatter – Visual Studio Marketplace
Extension for Visual Studio Code – A formatter with minimal configurations for nginx config files
VSCodeで、拡張機能として以下を検索しても出てきます。
Bash
AaaaronZhou.nginx-config-formatter-vscode-extension設定を書く場所
すぐに設定を有効化したい場合には、プロジェクトルートに.vscode/settings.jsonを作り、そこに上記のコードを書きます。
設定の内容
次のような設定としました。
- editor.formatOnSave: true
保存時にフォーマットをかける - defaultFormatter
フォーマッタを先ほど追加したものに指定
色分けの基準
nginx設定でよく出る要素で、色分けしました。
- ディレクティブ/ブロック系
太字＋目立つ色にして構造を追いやすく - 命令・関数っぽい部分
処理内容を読読みやすく - 変数
動的に変わるものだけ浮いて見えるようにして早期発見 - パス/URL/正規表現
書き間違えが起きやすい部分なので視認性UP - コメント
イタリックにして目につきやすいように
コメント