Python 設定のリファレンス
Visual Studio Code 用の Python 拡張機能は高度に設定可能です。このページでは、操作できる主要な設定について説明します。
VS Code での設定の操作に関する一般的な情報については、「ユーザー設定とワークスペース設定」を参照してください。また、定義済みの変数サポートに関する情報については、「変数リファレンス」を参照してください。
一般的な Python 設定
| 設定 (python.) |
既定値 | 説明 |
|---|---|---|
| condaPath | "conda" |
conda 実行可能ファイルへのパス。 |
| defaultInterpreterPath | "python" |
ワークスペースに初めてロードされたときに Python 拡張機能が使用するデフォルトの Python インタープリターへのパス、または Python インタープリターを含むフォルダーへのパス。${workspaceFolder} や ${workspaceFolder}/.venv などの変数を使用できます。フォルダーへのパスを使用すると、プロジェクトを操作する誰もが、プラットフォーム固有の正確なパスを指定する代わりに、自分のオペレーティングシステムに適した環境を .venv フォルダーに作成できます。その後、settings.json ファイルをソースコードリポジトリに含めることができます。注: ワークスペースにインタープリターが選択された後にこの設定に加えられた変更は、Python 拡張機能によって適用または考慮されません。Python 拡張機能は、この設定を自動的に追加または変更しません。 |
| envFile | "${workspaceFolder}/.env" |
環境変数定義を含むファイルへの絶対パス。 「Python 環境の設定 - 環境変数定義ファイル」を参照してください。 |
| experiments.enabled | true |
Python 拡張機能での A/B 実験を有効にします。有効にすると、提案された機能強化や機能が提供される場合があります。 |
| globalModuleInstallation | false |
--user コマンドライン引数 (デフォルト) を使用して現在のユーザーのみにパッケージをインストールするか、グローバル環境のすべてのユーザーにインストールするか (true に設定した場合) を指定します。仮想環境を使用している場合は無視されます。--user 引数に関する詳細については、「pip - ユーザーインストール」を参照してください。 |
| interpreter.infoVisibility | "onPythonRelated" |
選択したインタープリター情報をステータスバーに表示するタイミングを制御します。 デフォルトでは、エディターで Python 関連ファイルが開かれている場合にのみ表示されます。 常にステータスバーに表示したい場合は "always" に、完全に非表示にしたい場合は "never" に設定できます。 |
| pipenvPath | "pipenv" |
アクティベーションに使用する pipenv 実行可能ファイルへのパス。 |
| poetryPath | "poetry" |
Poetry 依存関係マネージャーの実行可能ファイルがインストールされている場合、その場所を指定します。デフォルト値の "poetry" は、実行可能ファイルが現在のパスにあると仮定しています。Python 拡張機能は、Poetry が利用可能で、ワークスペースフォルダーに poetry.lock ファイルがある場合、この設定を使用してパッケージをインストールします。 |
| REPL.enableREPLSmartSend | true |
Shift+Enter が Smart Send を利用するかどうかを指定します。Smart Send は、カーソルが置かれているコードを調べ、実行可能な最小のコードチャンクを Python REPL に送信し、カーソルを次のコード行に置きます。 |
| terminal.activateEnvInCurrentTerminal | false |
Python 拡張機能がアクティブ化されたときに、選択した仮想環境を使用して現在開いているターミナルをアクティブ化するかどうかを指定します。 |
| terminal.activateEnvironment | true |
新しいターミナルが作成されたときに、Python: インタープリターの選択 コマンドを使用して選択した環境を自動的にアクティブ化するかどうかを示します。 たとえば、この設定が true で、仮想環境を選択した場合、新しいターミナルを作成するときに拡張機能が環境の activate コマンドを自動的に実行します (macOS/Linux では source env/bin/activate、Windows では env\scripts\activate)。 |
| terminal.executeInFileDir | false |
現在のフォルダーの代わりに、ファイルのディレクトリでファイルを実行するかどうかを示します。 |
| terminal.focusAfterLaunch | false |
Python ターミナルを起動するときに、カーソルフォーカスをターミナルに切り替えるかどうか。 |
| terminal.launchArgs | [] |
Python: ターミナルで Python ファイルを実行 などのコマンドを使用してファイルを起動するときに、Python インタープリターに渡される起動引数。launchArgs リストでは、各項目はスペースで区切られた最上位のコマンドライン要素です (スペースを含む引用符で囲まれた値は単一の最上位要素であり、リスト内の1つの項目となります)。例: 引数 --a --b --c {"value1" : 1, "value2" : 2} の場合、リスト項目は ["--a", "--b", "--c", "{\"value1\" : 1, \"value2\" : 2}\""] となります。デバッグ時には、 launch.json で選択したデバッグ構成からの引数が使用されるため、VS Code はこの設定を無視することに注意してください。 |
| venvFolders | [] |
仮想環境が作成されるフォルダーへのパス。 使用される仮想化ツールによっては、プロジェクト自体 ( ${workspaceFolder}) である場合もあれば、すべての仮想環境が隣接して配置された個別のフォルダー (.\envs、~/.virtualenvs など) である場合もあります。 |
デバッガー設定
一般的なデバッグ
| 設定 (python.debugpy.) |
既定値 | 説明 | 関連項目 |
|---|---|---|---|
| debugJustMyCode | true |
デバッガーがユーザーが記述したコードのみをステップ実行するかどうかを指定します。無効にすると、ライブラリコードもステップ実行できます。 | デバッグ |
テスト設定
一般的なテスト
| 設定 (python.testing.) |
既定値 | 説明 | 関連項目 |
|---|---|---|---|
| autoTestDiscoverOnSaveEnabled | true |
テストファイルを保存するときに、自動テスト検出を有効または無効にするかどうかを指定します。 | テスト |
| cwd | null | テストのオプションの作業ディレクトリを指定します。 | テスト |
| debugPort | 3000 |
unittest テストのデバッグに使用されるポート番号。 | テスト |
| promptToConfigure | true |
潜在的なテストが検出された場合に、VS Code がテストフレームワークの設定を促すかどうかを指定します。 | テスト |
unittest フレームワーク
| 設定 (python.testing.) |
既定値 | 説明 | 関連項目 |
|---|---|---|---|
| unittestArgs | ["-v", "-s", ".", "-p", "*test*.py"] |
unittest に渡す引数。スペースで区切られた各最上位要素は、リスト内の個別の項目です。 | テスト |
| unittestEnabled | false |
テストに unittest を有効にするかどうかを指定します。 | テスト |
pytest フレームワーク
| 設定 (python.testing.) |
既定値 | 説明 | 関連項目 |
|---|---|---|---|
| pytestArgs | [] |
pytest に渡す引数。スペースで区切られた各最上位要素は、リスト内の個別の項目です。pytest-cov がインストールされている状態でテストをデバッグする場合は、これらの引数に --no-cov を含めます。 |
テスト |
| pytestEnabled | false |
テストに pytest を有効にするかどうかを指定します。 | テスト |
| pytestPath | "pytest" |
pytest へのパス。pytest が現在の環境の外にある場合は、完全パスを使用します。 | テスト |
コード分析設定
IntelliSense エンジン設定
注: 言語サーバー設定を変更したことがない場合、言語サーバーは「Default」設定値により Pylance に設定されています。
| 設定 (python.) |
既定値 | 説明 |
|---|---|---|
| languageServer | 既定値 | 言語サーバーの種類 (Default、Pylance、Jedi、および None) を定義します。 |
Python 言語サーバー設定
Pylance 言語サーバー
言語サーバー設定は、python.languageServer が Pylance または Default の場合に適用されます。言語サーバーに問題がある場合は、言語サーバーリポジトリの「トラブルシューティング」を参照してください。
| 設定 (python.analysis.) |
既定値 | 説明 | |||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| aiCodeActions | true | 特定の AI 支援コードアクションを有効にするかどうか。GitHub Copilot Chat 拡張機能が有効になっている必要があります。 受け入れられる値は、コードアクションをキーとし、ブール値を値とするオブジェクトです。 キーとして使用できるコードアクション
{"implementAbstractClasses": true} |
|||||||||||||||
| autoFormatStrings | false | 文字列内に「{」と入力したときに、自動的に「f」をプレフィックスとして付けるかどうか。 | |||||||||||||||
| autoImportCompletions | false | 補完で自動インポートを提供するかどうかを制御します。利用可能な値は true と false です。 |
|||||||||||||||
| autoIndent | true | Python コードを入力するときに、言語の意味論に基づいてインデントを自動的に調整するかどうか。 受け入れられる値は true または false です。 |
|||||||||||||||
| autoSearchPaths | true | 一部の定義済み名 (src など) に基づいて検索パスを自動的に追加するかどうかを示します。利用可能な値は true と false です。 |
|||||||||||||||
| completeFunctionParens | false | 関数補完に括弧を追加します。受け入れられる値は true と false です。 |
|||||||||||||||
| diagnosticMode | openFilesOnly | 言語サーバーが問題を分析するコードファイルを指定します。 利用可能な値は workspace と openFilesOnly です。 |
|||||||||||||||
| diagnosticSeverityOverrides | {} | ユーザーが個々の診断の重大度レベルを上書きできるようにします。 各ルールについて、利用可能な重大度レベルは error (赤の波線)、warning (黄色の波線)、information (青の波線)、および none (ルール無効) です。診断重大度ルールに使用するキーに関する情報については、以下の診断重大度ルールセクションを参照してください。 |
|||||||||||||||
| enableEditableInstalls | false |
PEP 660 で定義されているように、編集可能なモード (pip install -e .) でインストールされたパッケージのインポートパスを解決することで、改善された IntelliSense サポートを有効にします。 |
|||||||||||||||
| exclude | [] | 分析に含めるべきではないディレクトリまたはファイルのパス。 これらは python.analysis.include 設定の下にリストされているディレクトリを上書きし、特定のサブディレクトリを除外できるようにします。この exclude 設定にリストされているファイルは、除外されていないソースファイルによって参照/インポートされた場合でも、分析に含まれる可能性があることに注意してください。パスには、 ** (ディレクトリまたは複数レベルのディレクトリ)、* (0 個以上の文字のシーケンス)、? (単一の文字) などのワイルドカード文字を含めることができます。除外パスが指定されていない場合、Pylance は自動的に次のものを除外します: **/node_modules、**/\_\_pycache\_\_、.git、および任意の仮想環境ディレクトリ。 |
|||||||||||||||
| extraPaths | [] | インポート解決のための追加の検索パスを指定します。 複数のパスがある場合は、文字列として指定され、コンマで区切られたパスを受け入れます。例: ["path 1","path 2"]。 |
|||||||||||||||
| importFormat | absolute | モジュールを自動インポートするときのデフォルトの形式を定義します。受け入れられる値は absolute または relative です。 |
|||||||||||||||
| include | [] | 分析に含めるべきディレクトリまたはファイルのパス。 パスが指定されていない場合、Pylance はワークスペースルートを含むディレクトリをデフォルトとします。 パスには、 ** (ディレクトリまたは複数レベルのディレクトリ)、* (0 個以上の文字のシーケンス)、? (単一の文字) などのワイルドカード文字を含めることができます。 |
|||||||||||||||
| fixAll | [] |
Fix All コマンドまたは source.fixAll コードアクションを実行するときに実行するコードアクションのリスト。このリストで受け入れられる値
|
|||||||||||||||
| includeAliasesFromUserFiles | false | 自動インポートの提案およびインポート追加のクイックフィックスに、ユーザーファイルからのエイリアスシンボルを含めるかどうか。無効にすると、Pylance はシンボルが定義されている場所からのインポート提案を提供します。有効にすると、シンボルがインポートされている (つまり、エイリアスされている) ファイルからのインポート提案も提供します。利用可能な値は true と false です。 |
|||||||||||||||
| ignore | [] | 診断出力 (エラーと警告) を抑制すべきディレクトリまたはファイルのパス。たとえそれらが含まれるファイルであるか、含まれるファイルの推移的閉包内にある場合でも抑制します。 パスには、 ** (ディレクトリまたは複数レベルのディレクトリ)、* (0 個以上の文字のシーケンス)、? (単一の文字) などのワイルドカード文字を含めることができます。値が指定されていない場合、 python.linting.ignorePatterns の値 (設定されている場合) が使用されます。 |
|||||||||||||||
| indexing | true | Pylance が起動時にユーザーファイルとインストールされているサードパーティライブラリをインデックス化するかどうかを指定するために使用され、自動インポート、クイックフィックス、自動補完などの機能でより完全なシンボルセットを提供します。 受け入れられる値は true または false です。true に設定すると、デフォルトで Pylance はインストールされているパッケージのトップレベルシンボル (つまり、package/__init__.py の __all__ 内のシンボル) と、最大 2000 個のユーザーファイルからのすべてのシンボルをインデックス化します。false に設定すると、Pylance はエディターで以前に開かれたりロードされたファイルで既に参照または使用されているシンボルのみを表示します。 |
|||||||||||||||
| inlayHints.callArgumentNames | off | 呼び出し引数名に対するインレイヒントの表示を制御します。 利用可能な値は off、partial、および all です。off に設定すると、インレイヒントは表示されません。partial に設定すると、位置のみのパラメーターとキーワードのみのパラメーターではヒントが無効になります。all に設定すると、すべてのパラメーターでヒントが表示されます。 |
|||||||||||||||
| inlayHints.functionReturnTypes | false | 関数の戻り値型に対するインレイヒントを表示するかどうか。受け入れられる値は true または false です。 |
|||||||||||||||
| inlayHints.pytestParameters | false | pytest フィクスチャ引数型に対するインレイヒントを表示するかどうか。受け入れられる値は true または false です。 |
|||||||||||||||
| inlayHints.variableTypes | false | 変数型に対するインレイヒントを表示するかどうか。受け入れられる値は true または false です。 |
|||||||||||||||
| languageServerMode | default | 開発ニーズに基づいて Pylance のパフォーマンスを最適化するための、定義済みの構成を提供します。 利用可能な値は default と light です。default に設定すると、言語サーバーはシステムに過負荷をかけることなく、ほとんどのマシンに十分な機能を提供します。light に設定すると、軽量でメモリ効率の良い設定が有効になります。このモードでは、Pylance がより合理化されたテキストエディターのように機能するようにさまざまな機能が無効になり、IntelliSense のすべての機能を必要とせず、Pylance が可能な限りリソースフレンドリーであることを好むユーザーに最適です。各モードでデフォルト設定値は次の値に上書きされます
|
|||||||||||||||
| logLevel | Error |
言語サーバーが実行するログレベルを指定します。 提供される情報レベルが上がるにつれて、可能なログレベルは Error、Warning、Information、Trace です。 |
|||||||||||||||
| nodeArguments | "--max-old-space-size=8192" |
python.analysis.nodeExecutable で定義されたカスタム Node.js 実行可能ファイルに直接カスタム引数を指定します。これは、より多くのメモリを割り当てたり、Node.js の動作を設定したりするために使用できます。Node.js でサポートされている引数のリストを受け入れます。各 "arg=value" はリスト内でコンマで区切る必要があります。使用例: "python.analysis.nodeArguments": ["--max-old-space-size=8192"] |
|||||||||||||||
| nodeExecutable | "" |
使用する Node.js 実行可能ファイルを指定し、Pylance がより多くのメモリを割り当てられるようにします。 受け入れられる値は、実行可能パスを含む文字列、空の文字列、または "auto" です。空の文字列に設定すると、Pylance は VS Code の node 実行可能ファイルを使用します。 "auto" に設定すると、自動的に Node.js をダウンロードします。 |
|||||||||||||||
| packageIndexDepths | [] | インストールされているパッケージの何レベル下までインデックス化するかをパッケージごとに上書きするために使用されます。 デフォルトでは、トップレベルモジュールのみがインデックス化されます (depth = 1)。 サブモジュールをインデックス化するには、インデックス化したいサブモジュールのレベルごとに depth を 1 ずつ増やします。 受け入れられる値は、 {"name": "package name (str)", "depth": "depth to scan (int)", "includeAllSymbols": "whether to include all symbols (bool)"} のようなオブジェクトのタプルです。includeAllSymbols が false に設定されている場合、各パッケージの __all__ 内のシンボルのみが含まれます。true に設定されている場合、Pylance はファイル内のすべてのモジュール/トップレベルシンボル宣言をインデックス化します。使用例: [{"name": "sklearn", "depth": 2, "includeAllSymbols": true}, {"name": "matplotlib", "depth": 3, "includeAllSymbols": false}] |
|||||||||||||||
| stubPath | ./typings | カスタム型スタブを含むディレクトリへのパスを指定します。各パッケージの型スタブファイルは、独自のサブディレクトリにあることが期待されます。 | |||||||||||||||
| typeCheckingMode | off | 実行する型チェック分析のレベルを指定します。 利用可能な値は off、basic、および strict です。off に設定すると、型チェック分析は行われません。解決されていないインポート/変数の診断が生成されます。basic に設定すると、型チェックに関連しないルール (off のすべてのルール) と、基本的な型チェックルールが使用されます。strict に設定すると、すべての型チェックルールが最高レベルのエラー重大度で使用されます (off と basic カテゴリのすべてのルールを含む)。 |
|||||||||||||||
| useLibraryCodeForTypes | true | 型スタブが見つからない場合に、パッケージのソースコードを解析します。利用可能な値は true と false です。 |
|||||||||||||||
| userFileIndexingLimit | 2000 | ワークスペース内で Pylance がインデックス化するユーザーファイルの最大数を設定します。-1 に設定すると、Pylance はすべてのファイルをインデックス化します。 ファイルのインデックス化はパフォーマンスを集中させるタスクであることに注意してください。 |
診断重大度ルール
このセクションでは、以下の例に示すように、python.analysis.diagnosticSeverityOverrides 設定を使用してカスタマイズできるすべての利用可能なルールについて詳しく説明します。
{
"python.analysis.diagnosticSeverityOverrides": {
"reportUnboundVariable": "information",
"reportImplicitStringConcatenation": "warning"
}
}
| 値 | 説明 |
|---|---|
| reportAssertAlwaysTrue | おそらく常にアサートされる 'assert' ステートメントの診断。これはプログラミングエラーを示している可能性があります。 |
| reportCallInDefaultInitializer | デフォルト値初期化式内の関数呼び出しの診断。このような呼び出しは、モジュール初期化時に実行される高価な操作を隠蔽する可能性があります。 |
| reportConstantRedefinition | 名前がすべて大文字でアンダースコアと数字からなる変数を再定義しようとする試みの診断。 |
| reportDuplicateImport | 複数回インポートされたインポートシンボルまたはモジュールの診断。 |
| reportFunctionMemberAccess | 関数に対するメンバーアクセスの診断。 |
| reportGeneralTypeIssues | 一般的な型の不整合、サポートされていない操作、引数/パラメーターの不一致などの診断。これは、他のルールでカバーされていない基本的な型チェックルールのすべてをカバーします。構文エラーは含まれません。 |
| reportImportCycles | 循環インポートチェーンの診断。これらは Python のエラーではありませんが、型分析を遅くし、しばしばアーキテクチャのレイヤーに関する問題を示唆します。一般的には避けるべきです。 |
| reportImplicitStringConcatenation | 暗黙的な連結を示す、2つ以上の文字列リテラルが連続している場合の診断。これは悪い習慣と見なされ、コンマの欠落などのバグを隠蔽することがよくあります。 |
| reportIncompatibleMethodOverride | 基底クラスの同名のメソッドを互換性のない方法でオーバーライドするメソッド (パラメーター数の誤り、互換性のないパラメーター型、または互換性のない戻り値型) の診断。 |
| reportIncompatibleVariableOverride | 基底クラスの同名のシンボルを、基底クラスシンボルの型と互換性のない型でオーバーライドするクラス変数宣言の診断。 |
| reportInvalidStringEscapeSequence | 文字列リテラル内で使用されている無効なエスケープシーケンスの診断。Python 仕様では、このようなシーケンスは将来のバージョンで構文エラーを生成すると示されています。 |
| reportInvalidStubStatement | スタブファイル内に現れてはならないステートメントの診断。 |
| reportInvalidTypeVarUse | 関数シグネチャでの型変数の不適切な使用の診断。 |
| reportMissingImports | 対応するインポートされた Python ファイルまたは型スタブファイルがないインポートの診断。 |
| reportMissingModuleSource | 対応するソースファイルがないインポートの診断。これは、型スタブが見つかったが、モジュールソースファイルが見つからなかった場合に発生し、この実行環境を使用すると実行時にコードが失敗する可能性があることを示します。型チェックは型スタブを使用して行われます。 |
| reportMissingTypeArgument | 明示的または暗黙的な型引数を提供せずにジェネリッククラスが使用された場合の診断。 |
| reportMissingTypeStubs | 対応する型スタブファイル (typeshed ファイルまたはカスタム型スタブのいずれか) がないインポートの診断。型チェッカーは、分析を最大限に活用するために型スタブを必要とします。 |
| reportOptionalCall | Optional 型の変数を呼び出そうとする試みの診断。 |
| reportOptionalContextManager | Optional 型をコンテキストマネージャーとして使用しようとする試み (with ステートメントのパラメーターとして) の診断。 |
| reportOptionalIterable | Optional 型を反復可能な値として使用しようとする試み (for ステートメント内など) の診断。 |
| reportOptionalMemberAccess | Optional 型の変数のメンバーにアクセスしようとする試みの診断。 |
| reportOptionalOperand | Optional 型を二項演算子または単項演算子 ('+'、'=='、'or'、'not' など) のオペランドとして使用しようとする試みの診断。 |
| reportOptionalSubscript | Optional 型の変数を添字付け (インデックス付け) しようとする試みの診断。 |
| reportPrivateUsage | プライベートまたはプロテクトされた変数または関数の不正な使用の診断。プロテクトされたクラスメンバーは単一のアンダースコア _ で始まり、サブクラスからのみアクセスできます。プライベートなクラスメンバーは二重のアンダースコアで始まりますが、二重のアンダースコアで終わることはなく、宣言するクラス内からのみアクセスできます。クラスの外で宣言された変数と関数は、名前が単一または二重のアンダースコアで始まる場合、プライベートと見なされ、宣言するモジュールの外からアクセスすることはできません。 |
| reportPropertyTypeMismatch | セッターに渡される値の型がゲッターによって返される値に割り当て可能でないプロパティの診断。このような不一致は、変数のように機能することを意図されたプロパティの意図された使用法に違反します。 |
| reportSelfClsParameterName | インスタンスメソッドの「self」パラメーターとクラスメソッドの「cls」パラメーターの欠落または誤った名前の診断。メタクラス (「type」から派生するクラス) のインスタンスメソッドでは、インスタンスメソッドに「cls」を使用することが許可されています。 |
| reportUndefinedVariable | 未定義変数の診断。 |
| reportUnboundVariable | 未バインド変数およびおそらく未バインド変数の診断。 |
| reportUnknownArgumentType | 不明な型の関数またはメソッドの呼び出し引数の診断。 |
| reportUnknownLambdaType | 不明な型のラムダの入力または戻り値パラメーターの診断。 |
| reportUnknownMemberType | 不明な型のクラスまたはインスタンス変数の診断。 |
| reportUnknownParameterType | 不明な型の関数またはメソッドの入力または戻り値パラメーターの診断。 |
| reportUnknownVariableType | 不明な型の変数の診断。 |
| reportUnnecessaryCast | 静的に不要と判断される「cast」呼び出しの診断。このような呼び出しはプログラミングエラーを示している場合があります。 |
| reportUnnecessaryIsInstance | 「isinstance」または「issubclass」呼び出しの診断。結果が静的に常に true または常に false と判断される場合。このような呼び出しは、しばしばプログラミングエラーを示唆します。 |
| reportUnusedCallResult | 結果が消費されず、None でもない呼び出し式の診断。 |
| reportUnusedClass | プライベート名 (アンダースコアで始まる) を持ち、アクセスされていないクラスの診断。 |
| reportUnusedCoroutine | Coroutine を返し、結果が消費されていない呼び出し式の診断。 |
| reportUnusedFunction | プライベート名 (アンダースコアで始まる) を持ち、アクセスされていない関数またはメソッドの診断。 |
| reportUnusedImport | そのファイル内で参照されていないインポートシンボルの診断。 |
| reportUnusedVariable | アクセスされていない変数の診断。 |
| reportUnsupportedDunderAll | __all__ に対して実行されたサポートされていない操作の診断。 |
| reportWildcardImportFromLibrary | 外部ライブラリからのワイルドカードインポートの診断。 |
AutoComplete 設定
| 設定 (python.autoComplete.) |
既定値 | 説明 | 関連項目 |
|---|---|---|---|
| extraPaths | [] |
オートコンプリートデータをロードする追加パッケージの場所を指定します。 | 編集 |
定義済み変数
Python 拡張機能の設定は、定義済み変数をサポートしています。一般的な VS Code 設定と同様に、変数は ${variableName} 構文を使用します。特に、この拡張機能は以下の変数をサポートしています。
-
${cwd} - タスクランナーの起動時の現在の作業ディレクトリ
-
${workspaceFolder} - VS Code で開かれているフォルダーのパス
-
${workspaceRootFolderName} - スラッシュ (/) なしで VS Code で開かれているフォルダーの名前
-
${workspaceFolderBasename} - スラッシュ (/) なしで VS Code で開かれているフォルダーの名前
-
${file} - 現在開いているファイル
-
${relativeFile} -
workspaceFolderに対する現在開いているファイルの相対パス -
${relativeFileDirname} -
workspaceFolderに対する現在開いているファイルのディレクトリ名の相対パス -
${fileBasename} - 現在開いているファイルのベースネーム
-
${fileBasenameNoExtension} - ファイル拡張子なしの現在開いているファイルのベースネーム
-
${fileDirname} - 現在開いているファイルのディレクトリ名
-
${fileExtname} - 現在開いているファイルの拡張子
-
${lineNumber} - アクティブなファイルで現在選択されている行番号
-
${selectedText} - アクティブなファイルで現在選択されているテキスト
-
${execPath} - 実行中の VS Code 実行可能ファイルへのパス
定義済み変数と使用例に関する追加情報については、一般的な VS Code ドキュメントの「変数リファレンス」を参照してください。