Docs/Comandos e configuração

CLI

O binário é nx (também instalado como nexy). uvx nexy new cria um projeto (uvx vem com uv). Execute todos os outros comandos dentro do ambiente virtual do projeto, ou através de uv run, por exemplo uv run nexy dev: é onde estão seus próprios pacotes.

Comandos

Bandeiras

Saída

Etapas longas (instalação de pacotes, compilação, empacotamento) mostram um botão giratório com o tempo decorrido e deixam uma linha atrás: ✔ uv sync .venv 1.4s. Um grupo de etapas (as instalações de nx new) mostra uma barra de progresso com o número de etapas concluídas, ━━━━──── 2/5; um único passo (nx add) mostra uma barra que pulsa enquanto é executada. Os logs de desenvolvimento são lidos GET » /about 200 in 12ms para solicitações e vite » ... para Vite. Uma etapa com falha imprime as últimas linhas da saída do comando em vez de ocultá-la. Terminais que não podem renderizar Unicode obtêm + e x.

Erros durante a execução de nx dev

Salvar um arquivo quebrado nunca para o servidor. Um arquivo .py com erro de sintaxe é relatado com seu arquivo e linha, e o servidor continua servindo a última versão funcional até que você o corrija:

  nexy » error  src/routes/users.py:3  SyntaxError: invalid syntax     1 | import json    2 |  > 3 | def GET(:                ^    4 |     x = 1    5 |     return {"v": 2}   Fix it and save: the server keeps its last working version.

Um arquivo que analisa, mas falha quando o aplicativo é carregado (uma importação ausente, um erro no nível do módulo) é relatado da mesma maneira e nx dev aguarda seu próximo salvamento; nada é servido até que o aplicativo seja carregado novamente. Um salvamento válido lê nexy » update <file> enquanto o servidor é recarregado. Markdown arquivos fora de src/routes, como README.md, não são páginas e não acionam nada. nx start é mais rigoroso: sai com o código 1 e não inicia nada, se um arquivo de rota não puder ser carregado.

Perguntas de nx new

nx new pergunta, nesta ordem: roteador baseado em arquivo, tipo de projeto (web ou API), roteamento do lado do cliente, estrutura do cliente, como estilizar o aplicativo, alias de importação, ORM, banco de dados e URL do banco de dados. Cada opção possui uma breve descrição e a atual é destacada. As perguntas que não se aplicam são ignoradas (um projeto de API não tem estrutura ou estilo; escolha Sem banco de dados pois o ORM ignora o banco de dados e a URL). Mova-se com as setas (ou j/k, ou um número), confirme com enter, volte à pergunta anterior com ← ou esc, saia com ctrl+c.

O driver de banco de dados para o ORM escolhido é instalado com ele (psycopg, pymysql, asyncpg ou aiomysql), e a URL é gravada em .env.

Antes de instalar os pacotes, nx new verifica a conexão. Sem ele, ele ignora as instalações e solicita que você execute uv sync e a instalação do seu gerenciador de pacotes mais tarde. Com um, ele imprime a latência e velocidade de download, e avisa quando a conexão está lenta (acima de 400 ms, ou abaixo de 100 KB/s). Cada linha de instalação nomeia a ferramenta e a pasta que ela preenche, por exemplo pnpm install node_modules ou uv sync .venv.

O que dev, build e start criam

Antes de serem executados, os três comandos criam um __init__.py vazio em src/ e em cada pasta abaixo dele que contém um arquivo .py ou .nexy, então uma rota como src/routes/users.py importa da mesma maneira em todos eles. Os arquivos existentes nunca são tocados e nx dev faz o mesmo novamente quando você adiciona uma pasta. O bytecode Python vai para __nexy__/__pycache__, então nenhuma pasta __pycache__ aparece ao lado de suas fontes.

Idioma

A linha de comando fala inglês, chinês, hindi, espanhol, português, francês, alemão, japonês, russo, coreano, indonésio e árabe. Ele usa o primeiro deles que suporta:

1. a variável de ambiente NEXY_LANG (NEXY_LANG=ja nx dev);
2. as variáveis ​​de localidade do seu shell (LC_ALL, LC_MESSAGES, LANG, então LANGUAGE);
3. o idioma do seu sistema operacional.

Qualquer outra coisa é inglês, assim como qualquer mensagem que um idioma ainda não tenha. Somente o que nx imprime é traduzido: erros do compilador, tracebacks e a saída das ferramentas que ele executa permanecem como estão. As traduções ainda não foram revisadas por falantes nativos: correções são bem-vindas como pull requests para nexy/modules/i18n/<language>.json.

Comportamento de construção

nx build compila as rotas e agrupa o cliente quando useVite está ativado.

Trabalhando no próprio Nexy

Dentro deste repositório os portões são:

python scripts/verify.py             # lint, format, typecheck, testspython scripts/audit_dependencies.py # supply-chain audit against the lock

Próximas etapas

• Primeiros passos: primeiro projeto
• Testando: o que nx test é executado
• Implantar: build e start em produção

Copiar a página como Markdown Editar no GitHub