Zenn
🟩

VSCodeでKotlinの開発環境構築手順

2024/06/01に公開
Kotlin
VS Code
tech

前提条件

拡張機能のインストール

VScodeで拡張機能（以下の項目）をインストールしていきます。

  • Kotlin
  • Kotlin Language
  • Kotlin Formatter

KotlinコンパイラとGradleインストール 

// TODO brewのアップデートは必要であれば行う
$ brew update
$ brew install kotlin
$ brew install gradle

※　gradleのインストール後の初期処理については以下を参照する

https://qiita.com/rin1024@github/items/074e245fbc430c929d8f

プロジェクト作成

  1. コンソールを起動し以下を行う。

（１）任意の場所にフォルダを作成（プロジェクト名になる）

（２）上記で作成したフォルダに移動

（３）gradle initを使用しプロジェクトを作成

// (1)と(2)は任意の名前
$ mkdir kt-sample-pj ・・・(1)
$ cd kt-sample-pj    ・・・(2)
$ gradle init --type=kotlin-application  ・・・(3)
  1. （３）実行時以下の選択が出てくるので、2を選択しEnter　→　再度Enter
  2. プロジェクト名を入力
  3. パッケージ名を入力（後で設定するので判断しやす名前にする）

ビルドの設定

task.json作成

  1. 下記コマンドを実行して「.vscode」ディレクトリと「tasks.json」を作成します
cd kt-sample-pj // 今の階層と同じであれば以下の２つを実行
mkdir -p .vscode
vi .vscode/tasks.json
  1. 「i」を入力
  2. 以下のを入力
{
    "version": "2.0.0",
    "tasks": [
        {
            "label": "build",
            "type": "shell",
            "command": "./gradlew build -x test",
            "problemMatcher": [],
            "group": {
                "kind": "build",
                "isDefault": true
            }
        },
        {
            "label": "run",
            "type": "shell",
            "command": "./gradlew run"
        },
        {
            "label": "test",
            "type": "shell",
            "command": "./gradlew test"
        }
    ]
}
  1. escを押下
// 保存して閉じる
$ :wq

// vscodeを開く
$ code.
  1. .vscode/task.jsonを開く
  2. ターミナル>タスクの実行...を選択し、build,run,testが選択できるようになっているか確認

デバッグ設定

launch.json 作成

  1. ターミナル戻る
  2. 以下のコマンドを入力
vi .vscode/launch.json

launch.jsonにデバッグを設定

デバッグすべきプロジェクトの情報を書き込む

以下を書き込む

{
    "version": "0.2.0",
    "configurations": [
        {
            "type": "kotlin",
            "request": "launch",
            "name": "Kotlin Launch",
            "projectRoot": "${workspaceFolder}/app",
            // mainClassは格納場所に合わせて変更する
            // 例）以下は、「app/src/main/kotlin/com/sample/hsgw」の場合
            "mainClass": "com/sample/hsgw/AppKt",
            "preLaunchTask": "build"
        }
    ]
}

extension 作成

手順は上記を参考

  1. 以下のコマンドを入力
vi .vscode/extensions.json
  1. 以下を書き込む(配列内の２つをインストールする)
{
    "recommendations": [
        "fwcd.kotlin",
        "vscjava.vscode-java-pack"
    ]
}
  1. vscodeに戻り、ブレイクポイントをはりデバッグ実行を行う。

Discussion