本页面包含有关工作区环境配置文件架构的详细信息,该文件应始终位于 .idx/dev.nix
。
如需了解 Nix 语言,请参阅官方 Nix 语言教程。
包裹
要在环境中安装的软件包。
您可以使用 pkgs
参数选择要安装的软件包,例如 pkgs.python3
。请注意,pkgs
的内容取决于所选的 channel
通道选项。
例如:
{pkgs, ...}: {
channel = "stable-23.11";
packages = [pkgs.vim];
}
您可以在此处搜索可用的软件包:stable-23.11 或 unstable。
类型:软件包列表
默认值:[ ]
频道
nixpkgs 渠道。
此渠道定义了 pkgs
参数的内容。
类型:“stable-23.05”、“stable-23.11”、“unstable”之一
默认值:"stable-23.11"
env
在开发者环境中设置的环境变量。
这些信息会传播到您的所有 shell 和预览服务器。如果您的应用需要一组特定的变量,则环境变量会特别有用。
例如:
{pkgs, ...}: {
env = {
HELLO = "world";
};
}
Type:任何属性集
默认值:{ }
idx.extensions
您要在 IDX 工作区中安装的代码扩展程序。
这是完全限定的扩展 ID 的列表,例如 ${publisherId}.${extensionId}
。
您可以在 Open VSX Registry 上找到可用扩展程序的列表,并通过 ${publisherId}.${extensionId}
将它们输入到 dev.nix
文件中。
类型:(非空字符串或路径)列表
默认值:[ ]
idx.previews.enable
将此项设为 true
即可启用 IDX 预览。
此功能提供了一种在您开发应用时自动运行和重新加载应用的方法。
类型:布尔值
默认值: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
要执行的命令
类型:字符串列表
默认值:[ ]
idx.previews.previews.<name>.cwd
工作目录
类型:字符串
默认值:""
idx.previews.previews.<name>.env
要设置的环境变量。
Type:字符串属性集
默认值:{ }
idx.previews.previews.<name>.manager
管理员
类型:“web”“flutter”之一
idx.workspace.onCreate
首次创建和打开工作区时要执行的命令。
这对于设置开发环境非常有用。例如,在这里我们指定 npm install
以运行:
{pkgs, ...}: {
idx.workspace.onCreate = {
npm-install = "npm install";
};
}
Type:属性集(路径或字符串)
默认值:{ }
idx.workspace.onStart
每次打开工作区时要执行的命令。
这对于开始构建 Watcher 很有用。例如,我们在这里指定要运行的 2 个命令:
{pkgs, ...}: {
idx.workspace.onStart = {
npm-watch-fe = "npm run watch:frontend";
npm-watch-be = "npm run watch:backend";
};
}
Type:属性集(路径或字符串)
默认值:{ }
services.docker.enable
是否启用无根 Docker。
类型:布尔值
默认值:false
示例:true
services.mysql.enable
是否启用 MySQL 服务器。
该服务器使用无密码用户根目录进行初始化。因此,如需创建其他用户并创建数据库,请使用 mysql -u root
。.
类型:布尔值
默认值:false
示例:true
services.mysql.package
要使用的 MySQL 软件包。
类型:package
默认值:pkgs.mysql
示例:pkgs.mysql80
services.postgres.enable
是否启用 PostgreSQL 服务器。
类型:布尔值
默认值:false
示例:true
services.postgres.package
要使用的 PostgreSQL 软件包。
类型:package
默认值:pkgs.postgresql
示例:pkgs.postgresql_15
services.postgres.extensions
要安装的 Postgres 扩展程序。
"Type:"
默认值:[ ]
示例:[ "pgvector" "postgis" ];
services.pubsub.enable
是否启用 Google Pub/Sub 模拟器。
如需了解有关如何使用模拟器的更多文档,请访问 https://cloud.google.com/pubsub/docs/emulator#using_the_emulator。
类型:布尔值
默认值:false
示例:true
services.pubsub.port
配置 Pub/Sub 将监听的端口。
类型:16 位无符号整数;介于 0 和 65535 之间(含 0 和 65535)
默认值:8085
services.pubsub.project-id
用于运行 Pub/Sub 模拟器的项目 ID。此项目仅用于测试,不一定存在,仅在本地使用。
类型:与模式 [a-z][a-z0-9-]{5,29} 匹配的字符串
默认值:"idx-pubsub-emulator"
services.redis.enable
是否启用 Redis 服务器。
类型:布尔值
默认值:false
示例:true
services.redis.port
配置 Redis 将监听的端口。
默认情况下,tcp 处于停用状态,redis 仅监听 /tmp/redis/redis.sock。
类型:16 位无符号整数;介于 0 和 65535 之间(含 0 和 65535)
默认值:0
services.spanner.enable
是否启用 Google Cloud Spanner 模拟器。
类型:布尔值
默认值:false
示例:true
services.spanner.fault-injection
是否启用随机故障注入到交易中。
类型:布尔值
默认值:false
示例:true
services.spanner.grpc-port
模拟器应绑定的 TCP 端口。
类型:16 位无符号整数;介于 0 和 65535 之间(含 0 和 65535)
默认值:9010
services.spanner.rest-port
处理 REST 请求的端口
类型:16 位无符号整数;介于 0 和 65535 之间(含 0 和 65535)
默认值:9020