WindowsのVSCodeの統合ターミナルで指定シェルを起動する(だけの)マクロ

2020/12/21 2021/1/15 HTML/CSS/JavaScript/TypeScript, Macros, VSCode, 運用

この記事は公開から4年以上経過しています。

VSCode Macros拡張のサンプルです。

今回はWindowsのVSCodeで既定のターミナルをcmd.exeにしているときに異なるシェル、例えばGitのbash.exeを統合ターミナルで起動するマクロ関数サンプルを作ってみたので、紹介します。

ちなみにマクロや拡張を使わずに一時的に既定のシェルから別のシェルに変更したい場合は、シェルの実行ファイル名(パスが通っていなければフルパス)をターミナルから実行することでシェルを切り替えることが可能です。

動作イメージ

マクロコマンド選択メニューからbashの起動を選択すると、既定のターミナルがcmd.exeの場合でも統合ターミナル上でGitのbashを起動できます。

マクロのサンプルソースコード

当サンプルはWindowsのVSCodeでGitのbash.exeを起動する例です。他のOSでの利用や任意のシェルを起動する場合はターミナル名やパスを任意の値に変更してください。
createTerminal()の第3パラメータで起動するシェルにパラメータを引き渡すことも可能です。

※マクロコンフィギュレーション部分のマクロ名と順番は、現在お使い頂いているマクロファイルに合わせてご利用ください。

const vscode = require('vscode');

/**
 * マクロコンフィギュレーション(環境に合わせてお好みで設定)
 */
module.exports.macroCommands = {
  bashの起動: {
    no: 1,
    func: launchBash
  },
};

/**
 * Git bashの起動
 */
function launchBash() {
  vscode.window.createTerminal(
    'Git Bash',                         // ターミナル名
    'C:/Program Files/Git/bin/bash.exe' // 起動するシェルのパス
  ).show();
}

GitHub Gist

以上です。