Skip to content

Latest commit

 

History

History
66 lines (46 loc) · 1.61 KB

README.md

File metadata and controls

66 lines (46 loc) · 1.61 KB

@boergrp/vite-plugin-missing-locales

A Vite plugin that helps find missing locales in Vite projects.

Installation

npm install @boergrp/vite-plugin-missing-locales
yarn add @boergrp/vite-plugin-missing-locales
pnpm add @boergrp/vite-plugin-missing-locales

Usage

In your vite.config.js:

import viteMissingLocales from "@boergrp/vite-plugin-missing-locales";

export default {
  plugins: [viteMissingLocales({
    path: "./src/locales",
    wait: 300,
    hot: false
  })],
};

In shell:

vite-plugin-missing-locales [options]

API

  • wait - Type: number (optional, default is './src/locales'): the amount of time to wait in milliseconds before running the plugin after a change is detected. Defaults to 300.
  • path - Type: string (optional, default is './src/locales'): the path to the locales directory.
  • hot - Type: boolean (optional, default is './src/locales'): whether to run the plugin in hot mode. If true, the plugin will run after the specified wait time after any change is detected. If false, the plugin will run only if files in the locales path are changed. Defaults to false.

Output

Object containing the output string and the missing keys array.

[missing-locales/vite] en/main.json:
--> 'any.key1'
--> 'any.key2'
[missing-locales/vite] Total: 2

License

MIT

Links