Vite plugin options (#144)

* updating docs

* addition vite plugin options

* Using one param

* adding tests

* Updating docs

* Updating the docs

* formatting

---------

Co-authored-by: Francisco Madeira <[email protected]>

Author: Fa-BRAIK

README.md

@@ -86,6 +86,35 @@ export default defineConfig({
 });
 ```
 
+#### Vite plugin options
+
+In addition to that, you can use this `Vite` plugin with additional paths to load from, this is usefull when you are using a package that let's you override your translations, or in case you are getting your application's lang files from different paths. 
+
+Note that if one key found in two paths, priority will be given to the last given path between these two (In this example translation key will be loaded from `public/locales`)
+
+```js
+// vite.config.js
+import i18n from 'laravel-vue-i18n/vite';
+
+export default defineConfig({
+    plugins: [
+        laravel([
+            'resources/css/app.css'
+            'resources/js/app.js',
+        ]),
+        vue(),
+
+        i18n({
+            // you can also change your langPath here
+            // langPath: 'locales' 
+            additionalLangPaths: [
+                'public/locales' // Load translations from this path too! 
+            ]
+        }),
+    ],
+});
+```
+
 > During the `npm run dev` execution time, the plugin will create some files like this `php_{lang}.json` on your lang folder.
 > And to avoid that to be commited to your code base, I suggest to your `.gitignore` this like:
 

package-lock.json

@@ -6,3 +6,8 @@ import { OptionsInterface } from './options'
 export interface PluginOptionsInterface extends OptionsInterface {
   shared?: boolean
 }
+
+export interface VitePluginOptionsInterface {
+  langPath?: string
+  additionalLangPaths?: string[]
+}

src/interfaces/plugin-options.ts

@@ -147,6 +147,9 @@ export const readThroughDir = (dir) => {
   return data
 }
 
+export const prepareExtendedParsedLangFiles = (langPaths: string[]) =>
+  langPaths.reduce((acc, langPath) => [...acc, ...parseAll(langPath)], new Array<ParsedLangFileInterface>())
+
 export const generateFiles = (langPath: string, data: ParsedLangFileInterface[]): ParsedLangFileInterface[] => {
   data = mergeData(data)
 

src/loader.ts

@@ -1,12 +1,16 @@
 import path from 'path'
-import { existsSync, writeFileSync, unlinkSync, readdirSync, rmdirSync } from 'fs'
-import { parseAll, hasPhpTranslations, generateFiles } from './loader'
+import { existsSync, unlinkSync, readdirSync, rmdirSync } from 'fs'
+import { hasPhpTranslations, generateFiles, prepareExtendedParsedLangFiles } from './loader'
 import { ParsedLangFileInterface } from './interfaces/parsed-lang-file'
+import { VitePluginOptionsInterface } from './interfaces/plugin-options'
 import { Plugin } from 'vite'
 
-export default function i18n(langPath: string = 'lang'): Plugin {
+export default function i18n(options: string | VitePluginOptionsInterface = 'lang'): Plugin {
+  let langPath = typeof options === 'string' ? options : options.langPath ?? 'lang'
   langPath = langPath.replace(/[\\/]$/, '') + path.sep
 
+  const additionalLangPaths = typeof options === 'string' ? [] : options.additionalLangPaths ?? []
+
   const frameworkLangPath = 'vendor/laravel/framework/src/Illuminate/Translation/lang/'.replace('/', path.sep)
   let files: ParsedLangFileInterface[] = []
   let exitHandlersBound: boolean = false
@@ -40,11 +44,15 @@ export default function i18n(langPath: string = 'lang'): Plugin {
         return
       }
 
-      files = generateFiles(langPath, [...parseAll(frameworkLangPath), ...parseAll(langPath)])
+      const langPaths = prepareExtendedParsedLangFiles([frameworkLangPath, langPath, ...additionalLangPaths])
+
+      files = generateFiles(langPath, langPaths)
     },
     handleHotUpdate(ctx) {
       if (/lang\/.*\.php$/.test(ctx.file)) {
-        files = generateFiles(langPath, [...parseAll(frameworkLangPath), ...parseAll(langPath)])
+        const langPaths = prepareExtendedParsedLangFiles([frameworkLangPath, langPath, ...additionalLangPaths])
+
+        files = generateFiles(langPath, langPaths)
       }
     },
     configureServer(server) {

src/vite.ts

@@ -0,0 +1,6 @@
+<?php 
+
+return [
+    'failed' => 'These credentials are incorrect.',
+    'throttle' => 'Too many login attempts. Please try again in :seconds seconds.'
+];

test/fixtures/locales/en/auth.php

@@ -0,0 +1,5 @@
+<?php
+
+return [
+    'sub_dir_support_is_amazing' => 'Subdirectory override is amazing',
+];

test/fixtures/locales/en/domain/user.php

@@ -1,5 +1,5 @@
 import fs from 'fs';
-import { generateFiles, parseAll, parse, hasPhpTranslations, reset } from '../src/loader';
+import { generateFiles, parseAll, parse, hasPhpTranslations, reset, prepareExtendedParsedLangFiles } from '../src/loader';
 
 beforeEach(() => reset(__dirname + '/fixtures/lang/'));
 
@@ -41,6 +41,43 @@ it('includes .php lang file in nested subdirectory in .json', () => {
     expect(langEn['nested.cars.car.foo.level1.level2']).toBe('barpt');
 })
 
+it('inclues additional lang paths to load from', () => {
+    const langPath = __dirname + '/fixtures/lang/';
+    const additionalLangPaths = [
+        __dirname + '/fixtures/locales/'
+    ];
+
+    const langPaths = prepareExtendedParsedLangFiles([
+        langPath,
+        ...additionalLangPaths,
+    ]);
+
+    const files = generateFiles(langPath, langPaths);
+
+    const langEn = JSON.parse(fs.readFileSync(langPath + files[0].name).toString());
+
+    expect(langEn['auth.throttle']).toBe('Too many login attempts. Please try again in :seconds seconds.');
+});
+
+it('overwrites translations from additional lang paths', () => {
+    const langPath = __dirname + '/fixtures/lang/';
+    const additionalLangPaths = [
+        __dirname + '/fixtures/locales/'
+    ];
+
+    const langPaths = prepareExtendedParsedLangFiles([
+        langPath,
+        ...additionalLangPaths,
+    ]);
+
+    const files = generateFiles(langPath, langPaths);
+
+    const langEn = JSON.parse(fs.readFileSync(langPath + files[0].name).toString());
+
+    expect(langEn['auth.failed']).toBe('These credentials are incorrect.');
+    expect(langEn['domain.user.sub_dir_support_is_amazing']).toBe('Subdirectory override is amazing');
+});
+
 it('transforms .php lang to .json', () => {
     const lang = parse(fs.readFileSync(__dirname + '/fixtures/lang/en/auth.php').toString());