@coscom/vite-plugin-lang

vite-plugin-lang

Automatically fetch and generate translation files for multiple languages during Vite build.

Features

• 📤 Reads a base language file (e.g. de.json)
• 🌍 Translates it to multiple languages via your API
• 💾 Outputs language files to the specified directory
• ⚙️ Fully configurable

Installation

npm install @coscom/vite-plugin-lang --save-dev

Usage

In your vite.config.js or vite.config.ts:

import { defineConfig } from 'vite'
import fetchLangPlugin from 'vite-plugin-lang'

export default defineConfig({
  plugins: [
    fetchLangPlugin({
      inputLangPath: './public/translations/de.json',   // Source language file (e.g., German)
      outputLanguages: ['en', 'fr', 'it'],               // Languages to generate
      outputDir: './public/translations',                // Output folder for translated files
      apiUrl: 'http://localhost:5000/api/v1/strings',    // Your translation API
      indent: 2                                          // (Optional) JSON indentation
    })
  ]
})

How It Works

During the Vite build, this plugin:

• Reads the base language file (de.json)
• Sends its contents to your translation API for each target language (en, fr, it, ...)
• Saves translated versions (e.g. en.json, fr.json, ...) to the output directory

API Requirements

Your API should accept a POST request like:

POST /api/v1/strings?targetLang=fr
Content-Type: application/json

{
  "KEY1": "Wert 1",
  "KEY2": "Wert 2"
}

And return:

{
  "data": {
    "KEY1": "Value 1",
    "KEY2": "Value 2"
  }
}

Testing

This plugin supports tests using Vitest.

npm test

Example File Structure

public/
├── translations/
│   └── de.json
└── translations/
    ├── en.json
    ├── fr.json
    └── it.json

Options

Option	Type	Default	Description
inputLangPath	string	'./translations/de.json'	Path to the source language file
outputLanguages	string[]	['en']	List of target languages
outputDir	string	'./public/translations'	Folder where translated files are saved
apiUrl	string	''	Endpoint of your translation API
indent	number	2	JSON indent spacing for output files

License

MIT

Credits

Built with ❤️ to simplify multilingual Vite projects.