Nesta página, você encontra 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 dela.
pacotes
Pacotes a serem instalados no ambiente.
Você pode 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
nixpkgs a ser usado.
Esse canal define o conteúdo do argumento pkgs
.
Tipo: "stable-23.05", "stable-23.11", "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 para o servidor de visualização. Variáveis de ambiente podem ser especialmente úteis se o aplicativo exigir um conjunto específico de variáveis.
Exemplo:
{pkgs, ...}: {
env = {
HELLO = "world";
};
}
Type:o conjunto de atributos de qualquer item
Padrão:{ }
idx.extensions
As 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}
.
Encontre uma lista de extensões disponíveis em Open VSX Registry e insira-as no arquivo dev.nix
por ${publisherId}.${extensionId}
.
Tipo:lista de (caminho ou string não vazia)
Padrão:[ ]
idx.previews.enable
Defina como true
para ativar as visualizações do 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
Configurações de visualização.
Defina os comandos que o IDX executa no seu ambiente de desenvolvedor.
Exemplo:
{pkgs, ...}: {
idx.previews = {
enable = true;
previews = {
web = {
command = ["yes"];
cwd = "subfolder";
manager = "web";
env = {
HELLO = "world";
};
};
};
};
}
Tipo: conjunto de atributos de (submódulo)
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 strings
Padrão:{ }
idx.previews.previews.<name>.manager
Gerente
Tipo: "Web", "flutter"
idx.workspace.onCreate
Comandos a serem executados 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 o npm install
a ser executado:
{pkgs, ...}: {
idx.workspace.onCreate = {
npm-install = "npm install";
};
}
Tipo:conjunto de atributos de (caminho ou string)
Padrão:{ }
idx.workspace.onStart
Comandos a serem executados sempre que o espaço de trabalho é aberto.
Isso pode ser útil para começar a criar observadores. Por exemplo, aqui estamos especificando dois comandos a serem executados:
{pkgs, ...}: {
idx.workspace.onStart = {
npm-watch-fe = "npm run watch:frontend";
npm-watch-be = "npm run watch:backend";
};
}
Tipo:conjunto de atributos de (caminho ou string)
Padrão:{ }
services.docker.enable
Define se o Docker sem raiz será ativado.
Tipo: booleano
Padrão:false
Exemplo: true
.
services.mysql.enable
Define se o servidor MySQL será ativado.
O servidor é inicializado com uma raiz de usuário sem senha. Portanto, para criar mais usuários e bancos de dados, use mysql -u root
. .
Tipo: booleano
Padrão:false
Exemplo: true
.
services.mysql.package
o pacote MySQL a ser usado.
Tipo: pacote
Padrão:pkgs.mysql
Exemplo: pkgs.mysql80
.
services.postgres.enable
Define se o servidor PostgreSQL será ativado.
Tipo: booleano
Padrão:false
Exemplo: true
.
services.postgres.package
o pacote PostgreSQL a ser usado.
Tipo: pacote
Padrão:pkgs.postgresql
Exemplo: pkgs.postgresql_15
.
services.postgres.extensions
Extensões Postgres para instalar.
Type: list of (one of "age", "apache_datasketches", "cstore_fdw", "hypopg", "jsonb_deep_sum", "periods", "pg_auto_failover", "pg_ed25519", "pg_embed_embedding", "pg_hint_llm_folderg",
Padrão:[ ]
Exemplo: [ "pgvector" "postgis" ];
.
services.pubsub.enable
Define se o emulador do Google Pub/Sub será ativado.
Para mais documentação sobre como usar o emulador, acesse: https://cloud.google.com/pubsub/docs/emulator#using_the_emulator .
Tipo: booleano
Padrão:false
Exemplo: true
.
services.pubsub.port
Configura a porta que o Pub/Sub vai detectar.
Tipo:número inteiro não assinado de 16 bits, entre 0 e 65.535 (ambos 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 teste. 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 detecta apenas em /tmp/redis/redis.sock.
Tipo:número inteiro não assinado de 16 bits, entre 0 e 65.535 (ambos inclusive)
Padrão:0
services.spanner.enable
Define se o emulador do Google Cloud Spanner será ativado.
Tipo: booleano
Padrão:false
Exemplo: true
.
services.spanner.fault-injection
Define se a injeção de falha aleatória em transações será ativada.
Tipo: booleano
Padrão:false
Exemplo: true
.
services.spanner.grpc-port
A porta TCP a que o emulador precisa estar vinculado.
Tipo:número inteiro não assinado de 16 bits, entre 0 e 65.535 (ambos inclusive)
Padrão:9010
services.spanner.rest-port
A porta em que as solicitações REST são disponibilizadas
Tipo:número inteiro não assinado de 16 bits, entre 0 e 65.535 (ambos inclusive)
Padrão:9020