x18n README

README проекта с github.com/x18n-dev/x18n. Одним файлом markdown: README.md.

x18n

x18n

Universal toolkits for linting, viewing and managing i18n for any frameworks.

x18n is the spiritual successor of i18n-ally, that generalizes its concepts into a framework-agnostic toolkit that runs everywhere with a more robust and extensible architecture.

Features

Works with your project

Keep it healthy

Built for agents and CI

Wherever you work

Usages

You can use the @x18n/cli package to check, analyze, and manage your i18n resources from the command line.

For example,

pnpx @x18n/cli

would output an overview of the i18n resources,

pnpx @x18n/cli check

would do the linting and checking of your i18n resources, reporting missing keys, or unused keys.

pnpx @x18n/cli usages nav.keys

would list all the usages of the specified key (nav.keys) across your project.

You can also run

pnpx @x18n/cli ui

to have an interactive UI in browser to manage your i18n resources easily.

Additionally, you can also install the VS Code extension for a rendering the translations directly within the editor, enabling inline translation previews, and providing rich "Go to Definition" and "Find References" support for your i18n keys.

For other editors, you can use the Language Server to enable similar features.

Packages

Package What it is
@x18n/core Engine that runs in Node and in the browser: domain model, plugin API, analysis, edits
@x18n/builtins Built-in plugins: formats, locale finders, usage scanners, checks, reporters, presets for popular i18n libraries
@x18n/node Node.js host: file system, config and plugin loading
@x18n/cli The CLI, with JSON output for CI and agents
@x18n/lsp Language server for any LSP editor
@x18n/ui devframe UI: local dev server, static report, in-browser workspace, VS Code panel, devtools panel
@x18n/devtools The UI as a panel in Vite DevTools, Nuxt DevTools and devframe hubs
x18n-vscode VS Code extension on top of the language server
x18n-zed Zed extension on top of the language server (Rust/WASM)

Credits

x18n builds on the ideas of i18n Ally and i18n Ally Next.

Sponsors

Sponsors

License

MIT License © Anthony Fu

x18n (x18n-dev/x18n)

Ищем в базе…

744 ·GitHub
Что это такое?x18n — универсальный набор инструментов для проверки, просмотра и управления ресурсами i18n (интернационализации) в любом веб-фреймворке. Это преемник i18n Ally, не привязанный к конкретному фреймворку.
Это один CLI-инструмент или несколько отдельных?Это монорепозиторий из пакетов, которые используют один общий движок: базовая библиотека, хост для Node, CLI, веб-интерфейс в браузере, расширение для VS Code и Language Server для других редакторов.
Как начать пользоваться этим в своём проекте?Установите пакет @x18n/cli и запустите его из своего проекта, чтобы проверять, анализировать и управлять ресурсами i18n. Для того же проекта также доступны расширение для VS Code и интерактивный веб-интерфейс в браузере.
Нужно ли что-то установить перед началом работы?Нужен только Node.js, так как инструмент распространяется и запускается как пакеты npm, например @x18n/cli. Ключи API и дополнительные сервисы не требуются.
Это зрелая замена i18n Ally, которую можно просто подставить вместо неё?Это проект, полностью переписанный с нуля, с новой и более расширяемой архитектурой. Есть отдельный путь миграции для переноса существующих настроек i18n Ally, но это не бесшовная замена.
В какие редакторы и сборщики его можно встроить?Помимо CLI, есть расширение для VS Code, поддержка любого редактора, который работает с LSP, и панели в Vite DevTools и Nuxt DevTools.
Какие фреймворки x18n распознаёт автоматически?В комплекте более 45 готовых пресетов, которые работают без настройки и автоматически определяют проекты на Vue, React, Angular, Svelte, Astro, Next.js, Nuxt, Flutter, Laravel, Rails и .NET.
Какие форматы файлов с переводами он умеет читать?Он читает файлы JSON, JSON5, YAML, PO, Fluent, INI, Properties, PHP и файлы ресурсов .NET.
Что именно находит этап lint/check?Он находит отсутствующие, неиспользуемые и некорректные ключи, несовпадения плейсхолдеров, нарушения глоссария и устаревшие переводы, исходный текст которых изменился после их написания.
Предназначен ли x18n для ИИ-агентов, которые пишут код?Да, для этого есть промпты для перевода и проверки и стабильный вывод CLI в формате --json, чтобы скрипты и ИИ-агенты могли управлять им в конвейерах CI.
Какие есть похожие проекты?graphiql, openpencil, ui-ux-pro-max-skill, formatjs, workflow_templates, fallow, blobatar, react-i18next
Автор
x18n-dev
Размер
14.2 MB
Звёзды
744
Возраст
1 мес
Коммиты · 90 дней