VSCode タスクに任意の引数を受け取って実行する

VSCode タスクに任意の引数を受け取って実行する

VSCodeであらかじめビルドやマイグレーションのタスクを定義して使うことがあります。
その場合、コマンドの一部は実行時に引数として入力した値を使いたい場合のタスク定義例を紹介します。

tasks.json サンプル

 

"version": "2.0.0",
"tasks": [
    {
        "label": "Echo param",
        "type": "shell",
        "command": "echo ${input:param1}", // args
        "problemMatcher": []
    }
],
"inputs": [
    {
        "id": "param1", // ${input:***}で指定したID
        "description": "Param1:", // 入力説明文
        "default": "Hello", // デフォルト入力値
        "type": "promptString" // 入力タイプ
    }
]

解説

引数の変数としたい箇所(6行目)を、${input:****}として入力します。
そして、****で指定したIDで10-17行目を参考に入力ダイアログを定義します。

タスクを実行すると、実行直前に設定した入力ダイアログが表示されるので、引数として与えたい文字列を入力します。
あとはEnterで確定すれば、入力した文字列が引数として代入されてタスクが実行されます。

プログラミングカテゴリの最新記事