Exemplos
Projetos executáveis em examples/ no GitHub — cada um com sua própria configuração, saídas de localidade confirmadas e README. Você pode explorar arquivos traduzidos sem uma chave de API; a reexecução da tradução requer uma chave de provedor (Provedores e modelos).
Executar de forma autônoma (npx degit)
Copie um exemplo sem clonar o repositório completo.
Exemplos de Node.js
Cada exemplo em Node.js declara um intervalo de versão (caret range) publicado de ai-i18n-tools que corresponde à versão atual do pacote e instala a CLI a partir do npm:
npx degit wsj-br/ai-i18n-tools/examples/<name> <name>
cd <name>
pnpm installExemplos em Python
python-streamlit, python-flask, python-fastapi e python-gettext não possuem package.json. Os comandos degit na tabela abaixo são válidos. Você também pode baixar ai-i18n-tools-python-examples.zip a partir do GitHub Release. Esse arquivo zip contém os mesmos quatro diretórios. Ele não faz parte do pacote npm e não está dentro do executável independente.
python-streamlit, python-flask e python-fastapi usam um virtualenv e pip install -r requirements.txt. python-gettext usa apenas a biblioteca padrão. Traduza com o executável independente.
npx degit wsj-br/ai-i18n-tools/examples/python-streamlit python-streamlit
cd python-streamlit
python3 -m venv .venv
source .venv/bin/activate
pip install -r requirements.txtNo Windows, ative .venv\Scripts\activate.
Se você clonou o repositório inteiro ai-i18n-tools, execute pnpm install e pnpm run build na raiz do repositório e, em seguida, cd examples/<name>. Os exemplos de Workspace (Node.js) usam a CLI local por meio de seus scripts pnpm run i18n:*, ou o ai-i18n-tools … puro após a configuração do PATH. Os exemplos em Python nesse checkout traduzem com node ../../bin/ai-i18n-tools.mjs após a compilação. Consulte Instalação — Monorepo clonado.
Exemplos .NET
dotnet-console e dotnet-resx não têm package.json. Os comandos degit na tabela abaixo são válidos. Você também pode baixar ai-i18n-tools-dotnet-examples.zip no Lançamento do GitHub. Esse arquivo zip contém os mesmos dois diretórios e assets/dotnet, que os projetos compilam através de ../../assets/dotnet. Não faz parte do pacote npm e não está dentro do executável autônomo. Lançamentos publicados antes desse zip não o incluem.
Ambos são projetos xUnit. dotnet-console verifica I18n.cs. dotnet-resx verifica I18nResx.cs e os satélites .resx. Nenhum deles chama uma API de tradução. Execute dotnet test no diretório. A partir de um clone completo, pnpm test:dotnet na raiz do repositório executa ambos e ignora quando dotnet não está em PATH.
Descompacte ai-i18n-tools-dotnet-examples.zip, então execute as verificações do diretório de exemplo. O arquivo mantém examples/ e assets/dotnet lado a lado, que é o caminho que os projetos compilam:
cd examples/dotnet-console
dotnet testdegit copia um diretório e não inclui assets/dotnet. Esses links de compilação são resolvidos em um clone completo, ou após descompactar o zip.
Qual exemplo corresponde ao meu projeto?
- Um aplicativo JS/TS: console-app (o menor) ou nextjs-app. Guia: Adicionar i18n a um aplicativo JS/TS.
- Um aplicativo Python: python-streamlit, python-flask, ou python-fastapi. Guia: Adicionar i18n a um aplicativo Python.
- Um aplicativo Django ou GNU gettext: python-gettext (uma ferramenta de linha de comando gettext; não há diretório de exemplo Django). Guia: Adicionar i18n a um aplicativo Django / Python gettext.
- Um auxiliar .NET: dotnet-console (
I18n.cs) ou dotnet-resx (I18nResx.cse satélites.resx). Guias: Adicionar i18n a um aplicativo .NET e Adicionar i18n a um aplicativo .NET ResourceManager. - Um site ou site de documentação: docusaurus-docs, vitepress-docs, astro-docs, nextra-docs, fumadocs-docs, astro-website, plain-html, ou plain-html-docs. Guia: Adicionar i18n a um site ou site de documentação.
- Um README de repositório ao lado de um aplicativo: console-app ou nextjs-app (o exemplo nextjs também tem um site de documentação). Guia: Adicionar i18n ao seu README e documentos Markdown.
- Outros: multi-provider, test-markdown, e intlayer-migration.
Lista de Exemplos
| Exemplo | Melhor para | Copiar com degit | Executar |
|---|---|---|---|
| console-app | Aplicativo funcional menor com strings de UI t() + tradução de README | npx degit wsj-br/ai-i18n-tools/examples/console-app console-app | pnpm start |
| nextjs-app | React / Next.js + plurais + painel; documentos Docusaurus aninhados + README simples + ativos SVG | npx degit wsj-br/ai-i18n-tools/examples/nextjs-app nextjs-app | pnpm dev (aplicativo :3030; cd docs-site && pnpm start para documentos :3040) |
| docusaurus-docs | Somente site de documentação Docusaurus (predefinição docusaurus) | npx degit wsj-br/ai-i18n-tools/examples/docusaurus-docs docusaurus-docs | pnpm start (:3100; compilação + serviço, menu de localidade funciona) |
| astro-website | Página de destino Astro: HTML de página inteira + híbrido t() | npx degit wsj-br/ai-i18n-tools/examples/astro-website astro-website | pnpm dev |
| astro-docs | Site de documentação Astro Starlight | npx degit wsj-br/ai-i18n-tools/examples/astro-docs astro-docs | pnpm dev (:3050) |
| vitepress-docs | Site de docs VitePress + tema JSON (pt-BR, zh-Hans) | npx degit wsj-br/ai-i18n-tools/examples/vitepress-docs vitepress-docs | pnpm run docs:dev (:3060) |
| nextra-docs | Nextra 4 MDX + shell _meta.ts / dicionário .ts, mais um componente de servidor t() (pt-BR, zh-Hans) | npx degit wsj-br/ai-i18n-tools/examples/nextra-docs nextra-docs | pnpm run dev (:3070) |
| fumadocs-docs | Fumadocs 4 MDX + meta.json / catálogo de interface do usuário (pt, zh, analisador de ponto) | npx degit wsj-br/ai-i18n-tools/examples/fumadocs-docs fumadocs-docs | pnpm run dev (:3080) |
| plain-html | HTML simples + marcadores data-i18n*; JSON de localidade estática (UI estilo painel) | npx degit wsj-br/ai-i18n-tools/examples/plain-html plain-html | pnpm dev (:3090) |
| plain-html-docs | HTML simples como documentos: uma página por localidade, imagens localizadas, hreflang | npx degit wsj-br/ai-i18n-tools/examples/plain-html-docs plain-html-docs | pnpm dev (:3092) |
| multi-provider | Escolha ou compare um provedor LLM (-P / --provider) | npx degit wsj-br/ai-i18n-tools/examples/multi-provider multi-provider | ai-i18n-tools translate-docs -P openai --force |
| test-markdown | Teste de regressão de markdown / tradução CJK (Devanagari, MDX) | npx degit wsj-br/ai-i18n-tools/examples/test-markdown test-markdown | pnpm build |
| intlayer-migration | Intlayer .content.ts → t() (migrate-intlayer, redefinição + relatório do agente de IA) | npx degit wsj-br/ai-i18n-tools/examples/intlayer-migration intlayer-migration | pnpm reset && pnpm dev (:3091) |
| intlayer-translate | Manter o Intlayer, preencher localidades ausentes no local (translate-intlayer; en + pt-BR incluídos, es + zh-Hans ausentes) | npx degit wsj-br/ai-i18n-tools/examples/intlayer-translate intlayer-translate | pnpm reset && pnpm translate (pnpm dev :3093) |
| python-streamlit | Dashboard do Streamlit, t() / _(), JSON de string de origem | npx degit wsj-br/ai-i18n-tools/examples/python-streamlit python-streamlit | python3 -m venv .venv && pip install -r requirements.txt && streamlit run app.py |
| python-flask | Flask + Jinja, t() / _(), JSON de string de origem | npx degit wsj-br/ai-i18n-tools/examples/python-flask python-flask | python3 -m venv .venv && pip install -r requirements.txt && flask --app app run |
| python-fastapi | FastAPI, localidade ContextVar, t() / _(), JSON de string de origem | npx degit wsj-br/ai-i18n-tools/examples/python-fastapi python-fastapi | python3 -m venv .venv && pip install -r requirements.txt && uvicorn app:app |
| python-gettext | CLI GNU gettext existente; extract / translate-ui atualiza .po e .mo | npx degit wsj-br/ai-i18n-tools/examples/python-gettext python-gettext | python3 app.py --lang es |
| dotnet-console | Verificações xUnit de I18n.cs: JSON incorporado, fallback de cultura, {0}, plurais e Configure | npx degit wsj-br/ai-i18n-tools/examples/dotnet-console dotnet-console | dotnet test |
| dotnet-resx | Verificações xUnit de I18nResx.cs e satélites .resx de string de origem | npx degit wsj-br/ai-i18n-tools/examples/dotnet-resx dotnet-resx | dotnet test |
Cada nome de Exemplo se vincula ao seu README do GitHub com configuração completa, comandos e layout do projeto — ou navegue pelo índice de exemplos no repositório.
Os exemplos Node.js instalam a CLI do npm após pnpm install. Os quatro exemplos Python usam venv e pip (python-gettext usa apenas a biblioteca padrão) e o executável autônomo para tradução. Os dois exemplos .NET são projetos xUnit. Execute-os com dotnet test. Eles também estão em ai-i18n-tools-dotnet-examples.zip no Lançamento do GitHub.
Aviso
Os nomes e ícones dos produtos pertencem aos seus respectivos proprietários e são usados apenas para fins de identificação. Este software não é afiliado nem endossado por essas marcas.