プロジェクト IDX はベータ版です。ベータ版のプロダクトや機能では、サポートが制限されることがあります。また、ベータ版のプロダクトや機能の変更は、以前のバージョンと互換性がない可能性があります。

このページは Cloud Translation API によって翻訳されました。

IDX ワークスペースのカスタマイズ

Project IDX の目標は、できる限り開発者にとっての利便性を高めることです。IDX がこれを実現する方法の一つは、デベロッパーが特定のプロジェクトに適したツールをワークスペースにインストールし、ワークスペースが機能するように設定をカスタマイズする自由と柔軟性を持たせることです。

Nix + IDX

IDX は、Nix を使用して各ワークスペースの環境構成を定義します。Nix は純粋に機能するパッケージマネージャーであり、各依存関係に一意の識別子を割り当てます。つまり、最終的には、同じ依存関係の複数のバージョンを環境にシームレスに含めることができます。また、再現可能で宣言的です。IDX のコンテキストでは、ワークスペース間で Nix 構成ファイルを共有して、同じ環境構成を読み込むことができます。

IDX は、.idx/dev.nix ファイルを使用して、コードリポジトリから直接プレビュー環境とワークスペースパッケージの構成を定義します。このファイルで定義できる属性とパッケージライブラリは、Nix 属性セット構文に従います。

次の例は、プレビューを有効にする基本環境構成を示しています。

{ pkgs, ... }: {

  # Which nixpkgs channel to use.
  channel = "stable-23.11"; # or "unstable"

  # Use https://search.nixos.org/packages to find packages
  packages = [
    pkgs.nodejs_18
  ];

  # Sets environment variables in the workspace
  env = {
    SOME_ENV_VAR = "hello";
  };

  # Search for the extensions you want on https://open-vsx.org/ and use "publisher.id"
  idx.extensions = [
    "angular.ng-template"
  ];

  # Enable previews and customize configuration
  idx.previews = {
    enable = true;
    previews = {
      web = {
        command = [
          "npm"
          "run"
          "start"
          "--"
          "--port"
          "$PORT"
          "--host"
          "0.0.0.0"
          "--disable-host-check"
        ];
        manager = "web";
      };
    };
  };
}

Nix 属性とパッケージライブラリ

荷物

環境にインストールするパッケージ。

インストールするパッケージを選択するには、pkgs 引数を使用します（例: pkgs.python3）。pkgs の内容は、選択した channel チャンネルオプションによって異なります。

例:

{pkgs, ...}: {
  channel = "stable-23.11";
  packages = [pkgs.vim];
}

利用可能なパッケージは stable-23.11 または unstable で検索できます。

Type: パッケージのリスト

デフォルト: [ ]

チャンネル

使用することもできます。

このチャネルでは pkgs 引数の内容を定義します。

タイプ: "stable-23.05"、"stable-23.11"、"unstable" のいずれか

デフォルト: "stable-23.11"

env

開発環境内で設定される環境変数。

これらはすべてのシェルとプレビューサーバーに反映されます。環境変数は、アプリケーションで特定の変数セットが必要な場合に特に便利です。

例:

{pkgs, ...}: {
  env = {
    HELLO = "world";
  };
}

Type: 任意の属性セット

デフォルト: { }

idx.extensions

IDX ワークスペースにインストールするコード拡張機能。

これは完全修飾された拡張機能 ID のリストです（例: ${publisherId}.${extensionId}）。

利用可能な拡張機能のリストについては、Open VSX Registry をご覧ください。これらの拡張機能は、${publisherId}.${extensionId} までに dev.nix ファイルに入力します。

型: 空でない文字列またはパスのリスト

デフォルト: [ ]

idx.previews.enable

IDX プレビューを有効にするには、これを true に設定します。

この機能を使用すると、アプリの開発中に自動的に実行と再読み込みを行うことができます。

型: boolean

デフォルト: true

例: true

idx.previews.previews

プレビュー構成。

開発環境で IDX が実行するコマンドを定義します。

例:

{pkgs, ...}: {
  idx.previews = {
    enable = true;
    previews = {
      web = {
        command = ["yes"];
        cwd = "subfolder";
        manager = "web";
        env = {
          HELLO = "world";
        };
      };
    };
  };
}

Type: 属性セット（サブモジュール）

デフォルト: { }

idx.previews.previews.<name>.command

実行するコマンド

型: string のリスト

デフォルト: [ ]

idx.previews.previews.<name>.cwd

作業ディレクトリ

型: string

デフォルト: ""

idx.previews.previews.<name>.env

設定する環境変数。

Type: string の属性セット

デフォルト: { }

idx.previews.previews.<name>.manager

マネージャー

タイプ: 「web」、「flutter」のいずれか

idx.workspace.onCreate

ワークスペースを作成して初めて開いたときに実行されるコマンド。

これは開発環境の設定に役立ちます。たとえば、ここでは npm install を指定して実行します。

{pkgs, ...}: {
  idx.workspace.
    npm-install = "npm install";
  };
}

Type: 属性セット（path または string）

デフォルト: { }

idx.workspace.onStart

ワークスペースを開くたびに実行されるコマンド。

これはウォッチャーの構築を始めるのに役立ちます。たとえば、ここでは実行する 2 つのコマンドを指定しています。

{pkgs, ...}: {
  idx.workspace.
    npm-watch-fe = "npm run watch:frontend";
    npm-watch-be = "npm run watch:backend";
  };
}

Type: 属性セット（path または string）

デフォルト: { }

services.docker.enable

ルートレス Docker を有効にするかどうか。

型: boolean

デフォルト: false

例: true

services.mysql.enable

MySQL サーバーを有効にするかどうか。

サーバーはパスワードなしのユーザー root で初期化されます。したがって、追加のユーザーとデータベースを作成するには、mysql -u root を使用します。.

型: boolean

デフォルト: false

例: true

services.mysql.package

使用する MySQL パッケージ。

タイプ: package

デフォルト: pkgs.mysql

例: pkgs.mysql80

services.postgres.enable

PostgreSQL サーバーを有効にするかどうか。

型: boolean

デフォルト: false

例: true

services.postgres.package

使用する PostgreSQL パッケージ。

タイプ: package

デフォルト: pkgs.postgresql

例: pkgs.postgresql_15

services.postgres.extensions

インストールする Postgres 拡張機能。

タイプ:

デフォルト: [ ]

例: [ "pgvector" "postgis" ];

services.pubsub.enable

Google Pub/Sub エミュレータを有効にするかどうか。

エミュレータの使用方法については、https://cloud.google.com/pubsub/docs/emulator#using_the_emulator をご覧ください。

型: boolean

デフォルト: false

例: true

services.pubsub.port

Pub/Sub がリッスンするポートを構成します。

型: 0 ～ 65535（両端を含む）の 16 ビット符号なし整数

デフォルト: 8085

services.pubsub.project-id

Pub/Sub エミュレータの実行に使用するプロジェクト ID。このプロジェクトはテスト専用です。存在している必要はなく、ローカルでのみ使用されます。

型: [a-z][a-z0-9-]{5,29} のパターンに一致する文字列

デフォルト: "idx-pubsub-emulator"

services.redis.enable

Redis サーバーを有効にするかどうか。

型: boolean

デフォルト: false

例: true

services.redis.port

Redis がリッスンするポートを構成します。

デフォルトでは tcp は無効になっており、redis は /tmp/redis/redis.sock でのみリッスンします。

型: 0 ～ 65535（両端を含む）の 16 ビット符号なし整数

デフォルト: 0

services.spanner.enable

Google Cloud Spanner エミュレータを有効にするかどうか。

型: boolean

デフォルト: false

例: true

services.spanner.fault-injection

トランザクションへのランダムなフォールトインジェクションを有効にするかどうか。

型: boolean

デフォルト: false

例: true

services.spanner.grpc-port

エミュレータをバインドする TCP ポート。

型: 0 ～ 65535（両端を含む）の 16 ビット符号なし整数

デフォルト: 9010

services.spanner.rest-port

REST リクエストが処理されるポート

型: 0 ～ 65535（両端を含む）の 16 ビット符号なし整数

デフォルト: 9020

IDX ワークスペースのカスタマイズ

Nix + IDX

Nix 属性とパッケージ ライブラリ

荷物

チャンネル

env

idx.extensions

idx.previews.enable

idx.previews.previews

idx.previews.previews.<name>.command

idx.previews.previews.<name>.cwd

idx.previews.previews.<name>.env

idx.previews.previews.<name>.manager

idx.workspace.onCreate

idx.workspace.onStart

services.docker.enable

services.mysql.enable

services.mysql.package

services.postgres.enable

services.postgres.package

services.postgres.extensions

services.pubsub.enable

services.pubsub.port

services.pubsub.project-id

services.redis.enable

services.redis.port

services.spanner.enable

services.spanner.fault-injection

services.spanner.grpc-port

services.spanner.rest-port

Nix 属性とパッケージライブラリ