Trang này bao gồm thông tin chi tiết về giản đồ cho tệp cấu hình môi trường của không gian làm việc. Tệp này phải luôn nằm ở .idx/dev.nix.
Để tìm hiểu về ngôn ngữ Nix, hãy xem hướng dẫn chính thức về ngôn ngữ Nix.
gói hàng
Các gói cần cài đặt trong môi trường.
Bạn có thể sử dụng đối số pkgs để chọn các gói cần cài đặt, ví dụ: pkgs.python3. Xin lưu ý rằng nội dung của pkgs phụ thuộc vào tuỳ chọn kênh channel đã chọn.
Ví dụ:
{pkgs, ...}: {
channel = "stable-23.11";
packages = [pkgs.vim];
}
Bạn có thể tìm kiếm các gói có sẵn tại đây: stable-23.11 hoặc unstable.
Loại: danh sách gói
Mặc định: [ ]
kênh
kênh nixpkgs để sử dụng.
Kênh này xác định nội dung của đối số pkgs.
Loại: một trong các loại "stable-23.05", "stable-23.11", "stable-24.05", "unstable"
Mặc định: "stable-23.11"
env
Các biến môi trường được đặt bên trong môi trường dành cho nhà phát triển.
Các thay đổi này được truyền đến tất cả các màn hình shell và máy chủ xem trước. Biến môi trường có thể đặc biệt hữu ích nếu ứng dụng của bạn yêu cầu một tập hợp biến cụ thể.
Giá trị của mỗi biến có thể là một chuỗi hoặc một danh sách các chuỗi. Chuỗi này được nối với nhau, xen kẽ với các ký tự dấu hai chấm.
PATH phải là một danh sách, vì danh sách này luôn được mở rộng và không bao giờ được thay thế hoàn toàn.
Ví dụ:
{pkgs, ...}: {
env = {
HELLO = "world";
# append an entry to PATH
PATH = ["/some/path/bin"];
};
}
Loại: tập hợp thuộc tính của ((danh sách chuỗi) hoặc bất kỳ giá trị nào)
Mặc định: { }
idx.extensions
Các tiện ích mã bạn muốn cài đặt trong không gian làm việc IDX.
Đây là danh sách mã nhận dạng tiện ích đủ điều kiện, ví dụ: ${publisherId}.${extensionId}.
Bạn có thể tìm thấy danh sách các tiện ích có sẵn trên Open VSX Registry (Mở sổ đăng ký VSX) và nhập các tiện ích đó vào tệp dev.nix bằng ${publisherId}.${extensionId}.
Loại: danh sách (chuỗi hoặc đường dẫn không trống)
Mặc định: [ ]
idx.previews.enable
Đặt giá trị này thành true để bật tính năng Xem trước IDX.
Tính năng này cung cấp một cách để tự động chạy và tải lại ứng dụng khi bạn đang phát triển ứng dụng.
Loại: boolean
Mặc định: true
Ví dụ: true
idx.previews.previews
Xem trước cấu hình.
Xác định các lệnh mà IDX thực thi trong môi trường nhà phát triển.
Ví dụ:
{pkgs, ...}: {
idx.previews = {
enable = true;
previews = {
web = {
command = ["yes"];
cwd = "subfolder";
manager = "web";
env = {
HELLO = "world";
};
};
};
};
}
Loại: tập hợp thuộc tính của (thư viện con)
Mặc định: { }
idx.previews.previews.<name>.activity
Hoạt động khởi chạy Android
Loại: chuỗi
Mặc định: ""
idx.previews.previews.<name>.command
Lệnh để thực thi
Loại: danh sách chuỗi
Mặc định: [ ]
idx.previews.previews.<name>.cwd
Thư mục đang hoạt động
Loại: chuỗi
Mặc định: ""
idx.previews.previews.<name>.env
Các biến môi trường cần đặt.
Loại: tập hợp thuộc tính của chuỗi
Mặc định: { }
idx.previews.previews.<name>.manager
Người quản lý
Loại: một trong các loại "web", "flutter", "android", "gradle"
idx.workspace.onCreate
Các lệnh để thực thi khi không gian làm việc được tạo và mở lần đầu tiên.
Điều này có thể hữu ích khi thiết lập môi trường phát triển. Ví dụ: tại đây, chúng ta đang chỉ định npm install để chạy:
{pkgs, ...}: {
idx.workspace.onCreate = {
npm-install = "npm install";
# files to open when the workspace is first opened.
default.openFiles = [ "src/index.ts" ];
};
}
Loại: tập hợp thuộc tính của (đường dẫn hoặc chuỗi hoặc ({ openFiles = [ string ];}))
Mặc định: { }
idx.workspace.onStart
Các lệnh để thực thi bất cứ khi nào không gian làm việc được mở.
Điều này có thể hữu ích khi bắt đầu trình quan sát bản dựng. Ví dụ: tại đây, chúng ta sẽ chỉ định 2 lệnh để chạy:
{pkgs, ...}: {
idx.workspace.onStart = {
npm-watch-fe = "npm run watch:frontend";
npm-watch-be = "npm run watch:backend";
# files to open when the workspace is (re)opened.
default.openFiles = [ "src/index.ts" ];
};
}
Loại: tập hợp thuộc tính của (đường dẫn hoặc chuỗi hoặc ({ openFiles = [ string ];}))
Mặc định: { }
Dịch vụ IDX
Các dịch vụ phổ biến cần bật khi không gian làm việc mở ra.
Ví dụ: để bật Postgres và sử dụng tiện ích pgvector, hãy thêm nội dung sau vào dev.nix:
services.postgres = {
extensions = ["pgvector"];
enable = true;
};
Các phần sau đây liệt kê tất cả các dịch vụ được hỗ trợ và các tuỳ chọn có thể định cấu hình của các dịch vụ đó.
services.docker.enable
Có bật Docker không có quyền truy cập thư mục gốc hay không.
Loại: boolean
Mặc định: false
Ví dụ: true
services.mongodb.enable
Liệu có bật máy chủ MongoDB hay không.
Loại: boolean
Mặc định: false
Ví dụ: true
services.mongodb.package
Gói MongoDB để sử dụng.
Loại: gói
Mặc định: <derivation mongodb-6.0.11>
services.mongodb.port
Định cấu hình cổng mà Mongod sẽ nghe.
Theo mặc định, tcp bị tắt và Mongod chỉ nghe trên /tmp/mongodb/mongodb.sock. Để kết nối, hãy sử dụng chuỗi kết nối "mongodb://%2Ftmp%2Fmongodb%2Fmongodb.sock"
Loại: Số nguyên 16 bit chưa ký; từ 0 đến 65535 (bao gồm cả hai)
Mặc định: 0
services.mysql.enable
Có bật máy chủ MySQL hay không.
Máy chủ được khởi tạo bằng một người dùng gốc không có mật khẩu. Vì vậy, để tạo thêm người dùng và tạo cơ sở dữ liệu, hãy sử dụng mysql -u root. .
Loại: boolean
Mặc định: false
Ví dụ: true
services.mysql.package
Gói MySQL để sử dụng.
Loại: gói
Mặc định: pkgs.mysql
Ví dụ: pkgs.mysql80
services.postgres.enable
Có bật máy chủ PostgreSQL hay không.
Loại: boolean
Mặc định: false
Ví dụ: true
services.postgres.enableTcp
Có bật Postgres để nghe trên TCP hay không.
Loại: boolean
Mặc định: true
Ví dụ: true
services.postgres.package
Gói PostgreSQL cần sử dụng.
Loại: gói
Mặc định: pkgs.postgresql
Ví dụ: pkgs.postgresql_15
services.postgres.extensions
Các tiện ích Postgres cần cài đặt.
Loại: danh sách (một trong các "age", "apache_datasketches", "cstore_fdw", "hypopg", "jsonb_deep_sum", "periods", "pg_auto_failover", "pg_bigm", "pg_cron", "pg_ed25519", "pg_embedding", "pg_hint_plan", "pg_hll", "pg_ivm", "pg_net", "pg_partman", "pg_rational", "pg_relusage", "pg_repack", "pg_safeupdate", "pg_similarity", "pg_topn", "pg_uuidv7", "pgaudit", "pgjwt", "pgroonga", "pgrouting", "pgsql-http", "pgtap", "pgvector", "plpgsql_check", "plr", "plv8", "postgis", "promscale_extension", "repmgr", "rum", "smlar", "tds_fdw", "temporal_tables", "timescaledb", "timescaledb-apache", "timescaledb_toolkit", "tsearch_extras", "tsja", "wal2json")
Mặc định: [ ]
Ví dụ: [ "pgvector" "postgis" ];
services.pubsub.enable
Liệu có bật trình mô phỏng Google Pub/Sub hay không.
Bạn có thể xem thêm tài liệu về cách sử dụng trình mô phỏng tại đây: https://cloud.google.com/pubsub/docs/emulator#using_the_emulator .
Loại: boolean
Mặc định: false
Ví dụ: true
services.pubsub.port
Định cấu hình cổng mà Pub/Sub sẽ nghe.
Loại: Số nguyên 16 bit chưa ký; từ 0 đến 65535 (bao gồm cả hai)
Mặc định: 8085
services.pubsub.project-id
Mã dự án để chạy trình mô phỏng Pub/Sub. Dự án này chỉ dành cho mục đích kiểm thử, không nhất thiết phải tồn tại và chỉ được sử dụng cục bộ.
Loại: chuỗi khớp với mẫu [a-z][a-z0-9-]{5,29}
Mặc định: "idx-pubsub-emulator"
services.redis.enable
Có bật máy chủ Redis hay không.
Loại: boolean
Mặc định: false
Ví dụ: true
services.redis.port
Định cấu hình cổng mà Redis sẽ nghe.
Theo mặc định, tcp bị tắt và redis chỉ nghe trên /tmp/redis/redis.sock.
Loại: Số nguyên 16 bit chưa ký; từ 0 đến 65535 (bao gồm cả hai)
Mặc định: 0
services.spanner.enable
Liệu có bật Trình mô phỏng Google Cloud Spanner hay không.
Loại: boolean
Mặc định: false
Ví dụ: true
services.spanner.fault-injection
Có bật tính năng chèn lỗi ngẫu nhiên vào giao dịch hay không.
Loại: boolean
Mặc định: false
Ví dụ: true
services.spanner.grpc-port
Cổng TCP mà trình mô phỏng sẽ liên kết.
Loại: Số nguyên 16 bit chưa ký; từ 0 đến 65535 (bao gồm cả hai)
Mặc định: 9010
services.spanner.rest-port
Cổng mà các yêu cầu REST được phân phát
Loại: Số nguyên 16 bit chưa ký; từ 0 đến 65535 (bao gồm cả hai)
Mặc định: 9020