Ta strona zawiera informacje o schemacie pliku konfiguracji środowiska obszaru roboczego, który powinien znajdować się w katalogu .idx/dev.nix.
Aby dowiedzieć się więcej o języku Nix, zapoznaj się z oficjalnym samouczkiem.
przesyłki
Pakiety do zainstalowania w środowisku.
Argument pkgs umożliwia wybranie pakietów do zainstalowania, np. pkgs.python3. Pamiętaj, że zawartość elementu pkgs zależy od wybranej opcji kanału channel.
Przykład:
{pkgs, ...}: {
channel = "stable-23.11";
packages = [pkgs.vim];
}
Dostępne pakiety możesz wyszukać tutaj: stable-23.11 lub unstable.
Typ: lista pakietów
Domyślnie: [ ]
kanał
kanał nixpkgs, którego chcesz użyć.
Ten kanał określa zawartość argumentu pkgs.
Typ: „stable-23.05”, „stable-23.11”, „stable-24.05”, „unstable”.
Domyślnie: "stable-23.11"
env
Zmienne środowiskowe ustawione w środowisku programisty.
Są one propagowane do wszystkich powłok i na serwer podglądu. Zmienne środowiska mogą być szczególnie przydatne, jeśli aplikacja wymaga określonego zestawu zmiennych.
Wartością każdej zmiennej może być ciąg znaków lub lista ciągów znaków. Ten drugi jest złączany i przeplatany znakami dwukropka.
PATH musi być listą, ponieważ jest zawsze rozszerzana i nigdy nie jest całkowicie zastępowana.
Przykład:
{pkgs, ...}: {
env = {
HELLO = "world";
# append an entry to PATH
PATH = ["/some/path/bin"];
};
}
Typ: zbiór atrybutów ((lista ciągów znaków) lub dowolny element)
Domyślnie: { }
idx.extensions
rozszerzenia kodu, które chcesz zainstalować w obszarze roboczym IDX.
Oto lista w pełni kwalifikowanych identyfikatorów rozszerzeń, np. ${publisherId}.${extensionId}.
Listę dostępnych rozszerzeń znajdziesz w Open VSX Registry. Wpisz je w pliku dev.nix za pomocą ${publisherId}.${extensionId}.
Typ: lista (niepusty ciąg znaków lub ścieżka)
Domyślnie: [ ]
idx.previews.enable
Aby włączyć podgląd IDX, ustaw tę opcję na true.
Ta funkcja umożliwia automatyczne uruchamianie i ponownie wczytywanie aplikacji podczas ich tworzenia.
Typ: wartość logiczna
Domyślnie: true
Przykład: true.
idx.previews.previews
wyświetlać konfiguracje podglądu.
Określ polecenia, które IDX ma wykonywać w Twoim środowisku programistycznym.
Przykład:
{pkgs, ...}: {
idx.previews = {
enable = true;
previews = {
web = {
command = ["yes"];
cwd = "subfolder";
manager = "web";
env = {
HELLO = "world";
};
};
};
};
}
Typ: zbiór atrybutów (podmoduł)
Domyślnie: { }
idx.previews.previews.<name>.activity
Aktywność uruchamiania w Androidzie
Typ: ciąg znaków
Domyślnie: ""
idx.previews.previews.<name>.command
Polecenie do wykonania
Typ: lista ciągów znaków
Domyślnie: [ ]
idx.previews.previews.<name>.cwd
Katalog roboczy
Typ: ciąg znaków
Domyślnie: ""
idx.previews.previews.<name>.env
Zmienne środowiskowe do ustawienia.
Typ: zbiór atrybutów typu ciąg znaków
Domyślnie: { }
idx.previews.previews.<name>.manager
Menedżer
Typ: „web”, „flutter”, „android”, „gradle”.
idx.workspace.onCreate
Polecenia do wykonania po utworzeniu i pierwszym otwarciu Workspace.
Może to być przydatne podczas konfigurowania środowiska programistycznego. Na przykład tutaj określamy parametr npm install:
{pkgs, ...}: {
idx.workspace.onCreate = {
npm-install = "npm install";
# files to open when the workspace is first opened.
default.openFiles = [ "src/index.ts" ];
};
}
Typ: zbiór atrybutów (ścieżka lub ciąg znaków lub ({ openFiles = [ string ];})).
Domyślnie: { }
idx.workspace.onStart
Polecenia do wykonania za każdym razem, gdy otwierasz obszar roboczy.
Może to być przydatne do uruchamiania obserwatorów kompilacji. Na przykład tutaj określamy 2 polecenia do wykonania:
{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" ];
};
}
Typ: zbiór atrybutów (ścieżka lub ciąg znaków lub ({ openFiles = [ string ];})).
Domyślnie: { }
Usługi IDX
Typowe usługi do włączenia po otwarciu workspace.
Aby na przykład włączyć Postgres i użyć rozszerzenia pgvector, dodaj do pliku dev.nix następujące polecenie:
services.postgres = {
extensions = ["pgvector"];
enable = true;
};
W następnych sekcjach znajdziesz listę wszystkich obsługiwanych usług i ich opcji konfiguracyjnych.
services.docker.enable
Czy włączyć bezrootowy Docker.
Typ: wartość logiczna
Domyślnie: false
Przykład: true.
services.mongodb.enable
Czy włączyć serwer MongoDB.
Typ: wartość logiczna
Domyślnie: false
Przykład: true.
services.mongodb.package
pakiet MongoDB do użycia.
Typ: pakiet
Domyślnie: <derivation mongodb-6.0.11>
services.mongodb.port
Konfiguruje port, na którym będzie nasłuchiwać MongoDB.
Domyślnie protokół TCP jest wyłączony, a Mongod nasłuchuje tylko na /tmp/mongodb/mongodb.sock. Aby nawiązać połączenie, użyj ciągu połączenia „mongodb://%2Ftmp%2Fmongodb%2Fmongodb.sock”.
Typ: 16-bitowa liczba bez znaku; z zakresu od 0 do 65 535 (włącznie).
Domyślnie: 0
services.mysql.enable
Czy włączyć serwer MySQL.
Serwer jest inicjowany za pomocą użytkownika root bez hasła. Aby utworzyć dodatkowych użytkowników i bazy danych, użyj polecenia mysql -u root. .
Typ: wartość logiczna
Domyślnie: false
Przykład: true.
services.mysql.package
Pakiet MySQL do użycia.
Typ: pakiet
Domyślnie: pkgs.mysql
Przykład: pkgs.mysql80.
services.postgres.enable
Czy włączyć serwer PostgreSQL.
Typ: wartość logiczna
Domyślnie: false
Przykład: true.
services.postgres.enableTcp
Czy włączyć Postgres do nasłuchiwania w TCP.
Typ: wartość logiczna
Domyślnie: true
Przykład: true.
services.postgres.package
pakiet PostgreSQL do użycia.
Typ: pakiet
Domyślnie: pkgs.postgresql
Przykład: pkgs.postgresql_15.
services.postgres.extensions
rozszerzenia Postgres do zainstalowania.
Typ: lista (jeden z tych elementów: „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”)
Domyślnie: [ ]
Przykład: [ "pgvector" "postgis" ];.
services.pubsub.enable
Określa, czy włączyć emulator Google Pub/Sub.
Więcej informacji o używaniu emulatora znajdziesz tutaj: https://cloud.google.com/pubsub/docs/emulator#using_the_emulator .
Typ: wartość logiczna
Domyślnie: false
Przykład: true.
services.pubsub.port
Konfiguruje port, na którym Pub/Sub będzie nasłuchiwać.
Typ: 16-bitowa liczba bez znaku; z zakresu od 0 do 65 535 (włącznie).
Domyślnie: 8085
services.pubsub.project-id
Identyfikator projektu, którego chcesz używać do uruchamiania emulatora Pub/Sub. Ten projekt służy tylko do testowania. Nie musi on istnieć i jest używany tylko lokalnie.
Typ: ciąg znaków pasujący do wzorca [a-z][a-z0-9-]{5,29}
Domyślnie: "idx-pubsub-emulator"
services.redis.enable
Czy włączyć serwer Redis.
Typ: wartość logiczna
Domyślnie: false
Przykład: true.
services.redis.port
Konfiguruje port, na którym Redis będzie nasłuchiwać.
Domyślnie protokół TCP jest wyłączony, a redis nasłuchuje tylko na /tmp/redis/redis.sock.
Typ: 16-bitowa liczba bez znaku; z zakresu od 0 do 65 535 (włącznie).
Domyślnie: 0
services.spanner.enable
Określa, czy włączyć emulator Google Cloud Spanner.
Typ: wartość logiczna
Domyślnie: false
Przykład: true.
services.spanner.fault-injection
Czy włączyć losowe wstrzykiwanie błędów do transakcji.
Typ: wartość logiczna
Domyślnie: false
Przykład: true.
services.spanner.grpc-port
Port TCP, do którego ma być przypisany emulator.
Typ: 16-bitowa liczba bez znaku; z zakresu od 0 do 65 535 (włącznie).
Domyślnie: 9010
services.spanner.rest-port
Port, na którym są obsługiwane żądania REST
Typ: 16-bitowa liczba bez znaku; z zakresu od 0 do 65 535 (włącznie).
Domyślnie: 9020