Esta página inclui detalhes sobre o esquema do arquivo de configuração do ambiente do espaço de trabalho, que precisa estar sempre localizado em .idx/dev.nix.
Para saber mais sobre a linguagem Nix, consulte o tutorial oficial da linguagem Nix.
pacotes
Pacotes a serem instalados no ambiente.
É possível usar o argumento pkgs para selecionar pacotes a serem instalados, por exemplo,
pkgs.python3. O conteúdo de pkgs depende da opção de canal
channel selecionada.
Exemplo:
{pkgs, ...}: {
channel = "stable-23.11";
packages = [pkgs.vim];
}
Pesquise os pacotes disponíveis aqui: stable-23.11 ou unstable.
Tipo:lista de pacotes
Padrão:[ ]
canal
canal nixpkgs a ser usado.
Esse canal define o conteúdo do argumento pkgs.
Tipo: "stable-23.05", "stable-23.11", "stable-24.05", "unstable"
Padrão:"stable-23.11"
env
Variáveis de ambiente definidas no ambiente do desenvolvedor.
Elas são propagadas para todos os shells e o servidor de visualização. As variáveis de ambiente podem ser especialmente úteis se o aplicativo exigir um conjunto específico de variáveis.
O valor de cada variável pode ser uma string ou uma lista de strings. O último é concatenado, intercalado com caracteres de dois-pontos.
PATH precisa ser uma lista, já que ela é sempre estendida e nunca substituída completamente.
Exemplo:
{pkgs, ...}: {
env = {
HELLO = "world";
# append an entry to PATH
PATH = ["/some/path/bin"];
};
}
Type:conjunto de atributos de ((lista de strings) ou qualquer coisa)
Padrão:{ }
idx.extensions
Extensões de código que você quer instalar no espaço de trabalho do IDX.
Esta é uma lista de IDs de extensão totalmente qualificados, por exemplo,
${publisherId}.${extensionId}.
Você pode encontrar uma lista de extensões disponíveis no
Open VSX Registry e inseri-las no arquivo dev.nix
por ${publisherId}.${extensionId}.
Tipo:lista de (string ou caminho não vazio)
Padrão:[ ]
idx.previews.enable
Defina como true para ativar as visualizações de IDX.
Esse recurso oferece uma maneira de executar e recarregar seus apps automaticamente durante o desenvolvimento.
Tipo: booleano
Padrão:true
Exemplo: true.
idx.previews.previews
Visualizar as configurações.
Defina os comandos que o IDX executa no seu ambiente de desenvolvimento.
Exemplo:
{pkgs, ...}: {
idx.previews = {
enable = true;
previews = {
web = {
command = ["yes"];
cwd = "subfolder";
manager = "web";
env = {
HELLO = "world";
};
};
};
};
}
Type:conjunto de atributos de (submódulo)
Padrão:{ }
idx.previews.previews.<name>.activity
Atividade de inicialização do Android
Tipo: string
Padrão:""
idx.previews.previews.<name>.command
Comando a ser executado
Tipo:lista de strings
Padrão:[ ]
idx.previews.previews.<name>.cwd
Diretório de trabalho
Tipo: string
Padrão:""
idx.previews.previews.<name>.env
Variáveis de ambiente a serem definidas.
Tipo:conjunto de atributos de string
Padrão:{ }
idx.previews.previews.<name>.manager
Gerente
Type:um dos valores "web", "flutter", "android", "gradle"
idx.workspace.onCreate
Comandos para executar quando o espaço de trabalho é criado e aberto pela primeira vez.
Isso pode ser útil para configurar o ambiente de desenvolvimento. Por exemplo, aqui estamos
especificando npm install para execução:
{pkgs, ...}: {
idx.workspace.onCreate = {
npm-install = "npm install";
# files to open when the workspace is first opened.
default.openFiles = [ "src/index.ts" ];
};
}
Tipo:conjunto de atributos de (caminho ou string ou ({ openFiles = [ string ];})
Padrão:{ }
idx.workspace.onStart
Comandos para executar sempre que o espaço de trabalho for aberto.
Isso pode ser útil para iniciar os observadores de build. Por exemplo, aqui estamos especificando dois comandos para execução:
{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" ];
};
}
Tipo:conjunto de atributos de (caminho ou string ou ({ openFiles = [ string ];})
Padrão:{ }
Serviços de IDX
Serviços comuns a serem ativados quando o espaço de trabalho for aberto.
Por exemplo, para ativar o Postgres e usar a extensão pgvector, adicione o
seguinte a dev.nix:
services.postgres = {
extensions = ["pgvector"];
enable = true;
};
As seções a seguir listam todos os serviços com suporte e as opções configuráveis deles.
services.docker.enable
Define se o Docker sem raiz será ativado.
Tipo: booleano
Padrão:false
Exemplo: true.
services.mongodb.enable
Se o servidor do MongoDB precisa ser ativado.
Tipo: booleano
Padrão:false
Exemplo: true.
services.mongodb.package
Pacote do MongoDB a ser usado.
Tipo:pacote
Padrão:<derivation mongodb-6.0.11>
services.mongodb.port
Configura a porta que o MongoDB vai detectar.
Por padrão, o TCP está desativado e o mongod só detecta em /tmp/mongodb/mongodb.sock. Para se conectar, use a string de conexão "mongodb://%2Ftmp%2Fmongodb%2Fmongodb.sock".
Tipo:número inteiro não assinado de 16 bits; entre 0 e 65.535 (inclusive)
Padrão:0
services.mysql.enable
Se o servidor MySQL deve ser ativado.
O servidor é inicializado com um usuário raiz sem senha. Portanto, para criar outros
usuários e criar bancos de dados, use mysql -u root. .
Tipo: booleano
Padrão:false
Exemplo: true.
services.mysql.package
Pacote MySQL a ser usado.
Tipo:pacote
Padrão:pkgs.mysql
Exemplo: pkgs.mysql80.
services.postgres.enable
Se o servidor PostgreSQL deve ser ativado.
Tipo: booleano
Padrão:false
Exemplo: true.
services.postgres.enableTcp
Define se o Postgres vai detectar no TCP.
Tipo: booleano
Padrão:true
Exemplo: true.
services.postgres.package
Pacote do PostgreSQL a ser usado.
Tipo:pacote
Padrão:pkgs.postgresql
Exemplo: pkgs.postgresql_15.
services.postgres.extensions
Extensões do Postgres para instalar.
Tipo: lista de (um dos valores "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")
Padrão:[ ]
Exemplo: [ "pgvector" "postgis" ];.
services.pubsub.enable
Se o emulador do Google Pub/Sub precisa ser ativado.
Confira mais documentação sobre o uso do emulador aqui: https://cloud.google.com/pubsub/docs/emulator#using_the_emulator .
Tipo: booleano
Padrão:false
Exemplo: true.
services.pubsub.port
Configura a porta em que o Pub/Sub vai detectar.
Tipo:número inteiro não assinado de 16 bits; entre 0 e 65.535 (inclusive)
Padrão:8085
services.pubsub.project-id
ID do projeto a ser usado para executar o emulador do Pub/Sub. Esse projeto é apenas para testes, ele não precisa existir e é usado apenas localmente.
Tipo:string que corresponde ao padrão [a-z][a-z0-9-]{5,29}
Padrão:"idx-pubsub-emulator"
services.redis.enable
Define se o servidor Redis será ativado.
Tipo: booleano
Padrão:false
Exemplo: true.
services.redis.port
Configura a porta que o Redis vai detectar.
Por padrão, o TCP está desativado e o Redis só detecta /tmp/redis/redis.sock.
Tipo:número inteiro não assinado de 16 bits; entre 0 e 65.535 (inclusive)
Padrão:0
services.spanner.enable
Se o emulador do Google Cloud Spanner deve ser ativado.
Tipo: booleano
Padrão:false
Exemplo: true.
services.spanner.fault-injection
Define se a injeção de falhas aleatórias será ativada nas transações.
Tipo: booleano
Padrão:false
Exemplo: true.
services.spanner.grpc-port
A porta TCP a que o emulador precisa ser vinculado.
Tipo:número inteiro não assinado de 16 bits; entre 0 e 65.535 (inclusive)
Padrão:9010
services.spanner.rest-port
A porta em que as solicitações REST são atendidas
Tipo:número inteiro não assinado de 16 bits; entre 0 e 65.535 (inclusive)
Padrão:9020