Add getFtlPath option to better control path to ftl files (#26)

Author: Demivan

__tests__/frameworks/vite/__snapshots__/external.spec.ts.snap

@@ -1,4 +1,4 @@
-import { resolve } from 'path'
+import { relative, resolve } from 'path'
 import { describe, expect, it } from 'vitest'
 
 import vue3base from '@vitejs/plugin-vue'
@@ -29,6 +29,27 @@ describe('Vite external', () => {
     }, '/fixtures/components/external.vue')
 
     // Assert
+    expect(code).toContain('external.vue.ftl')
+    expect(code).toMatchSnapshot()
+  })
+
+  it('getFtlPath', async () => {
+    // Arrange
+    // Act
+    const code = await compile({
+      plugins: [
+        vue3(),
+        ExternalFluentPlugin({
+          getFtlPath: (locale, vuePath) => {
+            return `${baseDir}/fixtures/ftl/${locale}/${relative(resolve(baseDir, 'fixtures'), vuePath)}.ftl`
+          },
+          locales: ['en', 'da'],
+        }),
+      ],
+    }, '/fixtures/components/external.vue')
+
+    // Assert
+    expect(code).toContain('external.vue.ftl')
     expect(code).toMatchSnapshot()
   })
 
@@ -47,6 +68,7 @@ describe('Vite external', () => {
     }, '/fixtures/components/external.setup.vue')
 
     // Assert
+    expect(code).toContain('external.setup.vue.ftl')
     expect(code).toMatchSnapshot()
   })
 })

__tests__/frameworks/vite/external.spec.ts

@@ -59,7 +59,20 @@ interface Dependency {
 }
 
 export const unplugin = createUnplugin((options: ExternalPluginOptions, meta) => {
-  options.checkSyntax = options.checkSyntax ?? false
+  const resolvedOptions = {
+    checkSyntax: true,
+    getFtlPath: undefined as ((locale: string, vuePath: string) => string) | undefined,
+    ...options,
+  }
+
+  if ('getFtlPath' in options) {
+    resolvedOptions.getFtlPath = options.getFtlPath
+  }
+  else {
+    resolvedOptions.getFtlPath = (locale: string, vuePath: string) => {
+      return join(options.ftlDir, locale, `${relative(options.baseDir, vuePath)}.ftl`)
+    }
+  }
 
   return {
     name: 'unplugin-fluent-vue-external',
@@ -73,11 +86,9 @@ export const unplugin = createUnplugin((options: ExternalPluginOptions, meta) =>
 
         const { insertPos, target } = getInsertInfo(source)
 
-        const relativePath = relative(options.baseDir, id)
-
         const dependencies: Dependency[] = []
         for (const locale of options.locales) {
-          const ftlPath = normalizePath(join(options.ftlDir, locale, `${relativePath}.ftl`))
+          const ftlPath = normalizePath(resolvedOptions.getFtlPath(locale, id))
           const ftlExists = await fileExists(ftlPath)
 
           if (ftlExists) {

src/plugins/external-plugin.ts

@@ -1,10 +1,19 @@
-export interface ExternalPluginOptions {
-  baseDir: string
-  ftlDir: string
+interface ExternalPluginOptionsBase {
   locales: string[]
   checkSyntax?: boolean
 }
 
+interface ExternalPluginOptionsFolder extends ExternalPluginOptionsBase {
+  baseDir: string
+  ftlDir: string
+}
+
+interface ExternalPluginOptionsFunction extends ExternalPluginOptionsBase {
+  getFtlPath: (locale: string, vuePath: string) => string
+}
+
+export type ExternalPluginOptions = ExternalPluginOptionsFolder | ExternalPluginOptionsFunction
+
 export interface SFCPluginOptions {
   blockType?: string
   checkSyntax?: boolean