Visual Studio Code (VS Code) は多くの異なるプログラミング言語をサポートするオープンソースのコードエディタです。
VS Code のようなフル機能のエディタの使用は、プレーンテキストエディタの使用よりも多くの利点をもたらします。例えば、次のような利点です。:
このページの目的は、QMK ファームウェアを開発するために VS Code をセットアップする方法を文章化することです。
このガイドは Windows および Ubuntu 18.04 で必要な全てを構成する方法を説明します。
はじめに、全てのビルドツールをセットアップし、QMK ファームウェアをクローンする必要があります。まだ設定していない場合は、セットアップに進んでください。
Git for Windows (このリンクはインストーラを保存あるいは実行するように促します)
Git LFS (Large File Support)
および Check daily for Git for Windows updates
以外の全てのオプションを無効にします。Use Visual Studio Code as Git's default editor
に設定します。Use Git from Git Bash only
オプションを選択します。Choosing HTTPS transport backend
については、どちらのオプションでも問題ありません。Checkout as-is, commit Unix-style line endings
オプションを選択します。QMK ファームウェアは Unix スタイルのコミットを使います。このソフトウェアは、VS Code での Git サポートに必要です。これを含めないことも可能ですが、これを使う方が簡単です。
Git Credential Manager for Windows (オプション)
このソフトウェアは、git 証明書、MFA、パーソナルアクセストークン生成のためのセキュアストレージを提供することで、Git のより良いサポートを提供します。
これは厳密には必要ありませんが、お勧めします。
この項は非常に簡単です。ただし、正しく構成されていることを確認するために、しなければならない幾つかの設定があります。
最初に、IntelliSense をセットアップする必要があります。これは厳密には必要ではありませんが、あなたの人生をずっと楽にします。これを行うには、QMK ファームウェアフォルダに .vscode/c_cpp_properties.json
ファイルを作成する必要があります。これは全て手動で行うことができますが、ほとんどの作業は既に完了しています。
このファイル を取得して保存します。MSYS2 をデフォルトの場所にインストールしなかった、または WSL か LxSS を使っている場合、このファイルを編集する必要があります。
このファイルを保存したら、VS Code が既に実行中の場合はリロードする必要があります。
?> また、.vscode
フォルダ に extensions.json
および settings.json
ファイルがあるはずです。
次に、VSCode に統合ターミナルとして表示されるように、MSYS2 ウィンドウを設定します。これには多くの利点があります。ほとんどの場合で、エラー上で Ctrl + クリックするとこれらのファイルにジャンプできます。これによりデバッグがはるかに簡単になります。また、他のウィンドウへジャンプする必要が無いという点でも優れています。
ファイル > ユーザー設定 > > 設定 をクリックします。
右上の {} ボタンをクリックし、settings.json
ファイルを開きます。
ファイルの内容を以下のように設定します:
{
"terminal.integrated.shell.windows": "C:\\msys64\\usr\\bin\\bash.exe",
"terminal.integrated.env.windows": {
"MSYSTEM": "MINGW64",
"CHERE_INVOKING": "1"
},
"terminal.integrated.shellArgs.windows": [
"--login"
],
"terminal.integrated.cursorStyle": "line"
}
ここに既に設定がある場合は、最初と最後の波括弧の間に全てを追加し、既存の設定を新しく追加された設定とカンマで区切ります。
?> MSYS2 を別のフォルダにインストールした場合は、terminal.integrated.shell.windows
のパスをシステムの正しいパスに変更する必要があります。
Ctrl-`
(Grave) を押して、ターミナルを起動するか、表示 > ターミナル (コマンド workbench.action.terminal.toggleTerminal
)に進みます。まだターミナルが開いていない場合は、新しいターミナルが開きます。
これにより、ワークスペースフォルダ(つまり qmk_firmware
フォルダ)でターミナルが起動し、キーボードをコンパイルすることができます。
いいえ、本当に以上です。必要なパスはパッケージのインストール時に既に含まれています。現在のワークスペースのファイルを検出し、IntelliSense 用に解析する方がより良いです。
インストールした方が良い拡張が幾つかあります。
いずれかの拡張機能をインストールしたら、再起動します。
これで、VS Code で QMK ファームウェアをコーディングする準備ができました。