Friends - VSCode

DBFluteとは直接無関係ながらも、同時に利用するととても便利なライブラリを紹介します。

• DBFlute と VSCode
• フォーマッター設定の共有
  • Eclipseの設定に合わせる
  • シングルプロジェクトなら
  • マルチプロジェクトなら

DBFlute と VSCode

DBFluteは、利用上において特に VSCode に依存してはいません。ですが、VSCode 上で DBFlute の利用を支援するための情報や設定のExampleなどが提供されています。

フォーマッター設定の共有

Eclipseの設定に合わせる

とりあえずこれで、ほぼEclipseと同じ感じになりました。

e.g. VSCodeのフォーマッターに関する設定ファイルの構成 @settings.json
{
  "editor.defaultFormatter": "redhat.java",
  "java.format.settings.url": "",
  "editor.formatOnSave": true,
  "java.saveActions.organizeImports": true
}

VSCodeは、java.format.settings.url が空っぽの場合、Eclipse の.settingsディレクトリの内容を直接読み込んでフォーマット設定をするようです。

シングルプロジェクトなら

.vscodeディレクトリを .settingsディレクトリとフラットに並べます。

e.g. .vscodeと.settingsの位置関係、シングルプロジェクト @Directory
[PROJECT_ROOT]
 |
 |-.settings  // Eclipseの設定ディレクトリ
 |   |-org.eclipse.core.resources.prefs
 |   |-org.eclipse.core.runtime.prefs
 |   |-org.eclipse.jdt.core.prefs
 |   |-org.eclipse.jdt.ui.prefs
 |
 |-.vscode  // VSCodeの設定ディレクトリ
 |   |-settings.json

マルチプロジェクトなら

.vscodeディレクトリは、(gitの)リポジトリルートに置きます。

(.settingsディレクトリは各プロジェクトに配置されていると想定して)

e.g. .vscodeと.settingsの位置関係、マルチプロジェクト @Directory
[REPOSITORY_ROOT]
 |
 |-.vscode  // VSCodeの設定ディレクトリ
 |   |-settings.json
 |
 |-[PROJECT_ROOT]
 |  |-src/main/java
 |  |-src/test/java
 |  |-.settings  // Eclipseの設定ディレクトリ
 |      |-org.eclipse.core.resources.prefs
 |      |-org.eclipse.core.runtime.prefs
 |      |-org.eclipse.jdt.core.prefs
 |      |-org.eclipse.jdt.ui.prefs
 |
 |-[PROJECT_ROOT]
 |  |-src/main/java
 |  |-src/test/java
 |  |-.settings  // Eclipseの設定ディレクトリ
 |      |-org.eclipse.core.resources.prefs
 |      |-org.eclipse.core.runtime.prefs
 |      |-org.eclipse.jdt.core.prefs
 |      |-org.eclipse.jdt.ui.prefs

この構造で VSCode にて REPOSITORY_ROOT で Open すると、各プロジェクトごとの .settings の設定に従ってフォーマットがされます。

この場合、[PROJECT_ROOT] を単体で Open しないようにしましょう。