O objetivo do Project IDX é ser o mais útil possível para os desenvolvedores. A IDX faz isso oferecendo aos desenvolvedores a liberdade e a flexibilidade de instalar as ferramentas certas para qualquer projeto no espaço de trabalho e personalizar configurações para que os espaços de trabalho funcionem para eles.
Nix + IDX
O IDX usa o Nix para definir a configuração do ambiente para cada espaço de trabalho. O Nix é um gerenciador de pacotes puramente funcional e atribui identificadores exclusivos a cada dependência, o que significa que seu ambiente pode conter várias versões da mesma dependência perfeitamente. Ele também é reproduzível e declarativo. No contexto do IDX, isso significa que é possível compartilhar seu arquivo de configuração Nix em vários espaços de trabalho para carregar a mesma configuração de ambiente.
O IDX define o ambiente de visualização e as configurações do pacote do espaço de trabalho
diretamente do repositório do código com o arquivo .idx/dev.nix
.
Os atributos e as bibliotecas de pacotes que podem ser definidos nesse arquivo seguem a
sintaxe do conjunto de atributos do Nix (link em inglês).
O exemplo a seguir mostra uma configuração básica de ambiente que permite visualizações:
{ pkgs, ... }: {
# Which nixpkgs channel to use.
channel = "stable-23.11"; # or "unstable"
# Use https://search.nixos.org/packages to find packages
packages = [
pkgs.nodejs_18
];
# Sets environment variables in the workspace
env = {
SOME_ENV_VAR = "hello";
};
# Search for the extensions you want on https://open-vsx.org/ and use "publisher.id"
idx.extensions = [
"angular.ng-template"
];
# Enable previews and customize configuration
idx.previews = {
enable = true;
previews = {
web = {
command = [
"npm"
"run"
"start"
"--"
"--port"
"$PORT"
"--host"
"0.0.0.0"
"--disable-host-check"
];
manager = "web";
};
};
};
}
Atributos Nix e bibliotecas de pacotes
pacotes
Pacotes a serem instalados no ambiente.
Você pode usar o argumento pkgs
para selecionar pacotes a serem instalados, ou seja, pkgs.python3
.
O conteúdo de pkgs
depende da opção de canal channel
selecionada.
Exemplo:
{pkgs, ...}: {
channel = "stable-23.11";
packages = [pkgs.vim];
}
Você pode pesquisar os pacotes disponíveis aqui: stable-23.11 ou unstable.
Tipo:lista de pacotes
Padrão:
[ ]
canal
o canal nixpkgs será usado.
Esse canal define o conteúdo do argumento pkgs
.
Tipo: "stable-23.05", "stable-23.11" ou "instable"
Padrão:
"stable-23.11"
env
Variáveis de ambiente definidas no ambiente do desenvolvedor.
Eles são propagados para todos os shells e para o servidor de visualização. As variáveis de ambiente são especialmente úteis se o aplicativo precisar de um conjunto específico de variáveis.
Exemplo:
{pkgs, ...}: {
env = {
HELLO = "world";
};
}
Tipo:conjunto de atributos de 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, ou seja, ${publisherId}.${extensionId}
.
É possível encontrar uma lista de extensões disponíveis no Open VSX Registry
e inseri-las no arquivo dev.nix
até ${publisherId}.${extensionId}
.
Tipo:lista de (string ou caminho não vazio)
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 aplicativos automaticamente à medida que eles são desenvolvidos.
Tipo: booleano
Padrão:
true
Exemplo:
true
idx.previews.previews
Visualizar configurações.
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.*.command
Comando a ser executado
Tipo: lista de strings
Padrão:
[ ]
idx.previews.previews.*.cwd
Diretório de trabalho
Tipo: string
Padrão:
""
idx.previews.previews.*.env
Variáveis de ambiente a serem definidas.
Tipo:conjunto de atributos de string
Padrão:
{ }
idx.previews.previews.*.manager
Gerente
Tipo:
um de 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 npm install
para 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 for aberto.
Isso pode ser útil para iniciar observadores de compilação. Por exemplo, aqui estamos especificando dois comandos para 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