Nuxt 翻译管理器
一个简单易用的 nuxt 和 nuxt-i18n 翻译管理器，允许从单个 CSV 文件管理翻译。
Nuxt v4 已就绪 ✨
对于 Nuxt V4 示例，您可以查看此使用 Nuxt V4 && nuxt-i18n 模块的启动器
特性
- 从单个 CSV 文件管理翻译
- 每当 csv 文件更新时热模块重载
快速设置
- 将
nuxt-translation-manager依赖项添加到您的项目
npx nuxi@latest module add translation-manager
手动安装
- 将
nuxt-translation-manager依赖项添加到您的项目
npm install -D nuxt-translation-manager
pnpm install -D nuxt-translation-manager
yarn add -D nuxt-translation-manager
- 将
nuxt-translation-manager添加到nuxt.config.ts的modules部分
export default defineNuxtConfig({
modules: ['nuxt-translation-manager']
})
就是这样！您现在可以在您的 Nuxt 应用程序中使用 Nuxt 翻译管理器了✨
用法
在您的 langDir 中创建 translations.csv 文件
echo 'Key,"en-US","es-ES","ca-ES"
login,"Login","Acceder","Accedir"' > path-to-your-langDir/translations.csv
# replace `path-to-your-langDir`
这将生成一个如下所示的 CSV 文件
| 键 | en-US | fr | de |
|---|---|---|---|
| hello | Hello | Bonjour | Hallo |
| goodbye | Goodbye | Au revoir | Auf Wiedersehen |
| thanks | Thanks | Merci | Danke |
请确保在标题行中使用 lang-code 格式，例如 es-ES
请确保在您的 csv 编辑器中设置适当的分隔符（默认为逗号） ,
您可以在 csv 文件中使用注释，使用 #
✨ 提示：您可以使用 VSCode 的 Edit CSV 扩展在 vscode 中管理您的 csv 文件
查看原始 csv 代码
Key,"English, en-US","French, fr","German, de"
hello,"Hello","Bonjour","Hallo"
goodbye,"Goodbye","Au revoir","Auf Wiedersehen"
thanks,"Thanks","Merci","Danke"
# COMMENTS TEST
comment-test,"Comment test","Test comentario","Test comentari"
### MULTILINE COMMENT ###
### ANOTHER COMMENT ####
comment-multi,"Comment test","Test comentario","Test comentari"
选项
// config key
export default defineNuxtConfig({
'translation-manager': {}
})
interface ModuleOptions {
/**
* nuxt-i18n lang dir
*
* @default 'locales'
*/
langDir?: string
/**
* csv file name without .csv file extension
*
* @default 'translations'
*/
translationFileName?: string
/**
* where to store json files
*
* @default 'langDir'
*/
outputDir?: string
/**
* csv separator character
*
* @default ','
*/
separator?: string
}
开发
# Install dependencies
pnpm install
# Generate type stubs
pnpm run dev:prepare
# Develop with the playground
pnpm run dev
# Build the playground
pnpm run dev:build
# Run ESLint
pnpm run lint
# Run Vitest
pnpm run test
pnpm run test:watch
# Release new version
pnpm run release