ワークスペース設定ファイル

Info

このページは、Visual Studio Codeのワークスペース設定ファイルについて説明します。 本記事ではpythonプロジェクトのワークスペース設定ファイルの例を示します。

ワークスペース設定ファイルは、ワークスペースの設定を保存するためのファイルです。ワークスペース設定ファイルは、ワークスペースのフォルダー内に .code-workspace という名前で保存されます。

ワークスペース設定ファイルの作成

ワークスペース設定ファイルをプロジェクトのルートディレクトリに作成します。

{
    "folders": [
      {
        "path": "."
      }
    ],
    "settings": {
      "python.autoComplete.extraPaths": [
        "./",  // プロジェクトルートをPythonパスに追加
        "./config"  // Djangoプロジェクトのディレクトリ
      ],
      "python.analysis.extraPaths": [
        "./config" // 
      ],
    }
  }

ワークスペース設定ファイルの設定

設定項目	説明
folders	ワークスペースに含まれるフォルダーを指定します。
path	フォルダーのパスを指定します。
settings	ワークスペースの設定を指定します。
python.autoComplete.extraPaths	Pythonの自動補完機能で使用するパスを指定します。プロジェクトルートディレクトリを指定するといいでしょう。
python.analysis.extraPaths	Pythonの解析機能で使用するパスを指定します。

参考

• Visual Studio Codeのワークスペース設定ファイル

まとめ

この記事では、Visual Studio Codeのワークスペース設定ファイルについて説明しました。
普段は設定ファイルを作成することはほとんどなく、存在すら忘れていましたが、
ローカル開発環境が完全に崩壊し、リモートサーバでのみ開発可能という状況の案件に遭遇した際に、この設定ファイルが役立ちました。
Remote SSHなどでリモートサーバに接続して開発する際には、この設定ファイルが役立つかもしれません。

コメント