@intlify/vue-i18n-extensions 6.0.5 → 6.1.0

package/dist/index.cjs

@@ -205,11 +205,12 @@ function createContentBuilder(options = {}) {
   };
 }
 
+const GLOBAL_TRANSLATE_SIGNATURE = "$t";
 function transformVTDirective(options = {}) {
   const i18nInstance = options.i18n;
   const mode = shared.isString(options.mode) && ["composition", "legacy"].includes(options.mode) ? options.mode : "composition";
-  const translationSignatures = shared.isString(options.translationSignatures) ? [options.translationSignatures] : shared.isArray(options.translationSignatures) ? options.translationSignatures : ["t"];
-  translationSignatures.push(`$t`);
+  const translationSignatures = shared.isString(options.translationSignatures) || shared.isFunction(options.translationSignatures) ? [options.translationSignatures] : shared.isArray(options.translationSignatures) ? options.translationSignatures : ["t"];
+  translationSignatures.push(GLOBAL_TRANSLATE_SIGNATURE);
   return (dir, node, context) => {
     const { exp, loc } = dir;
     if (!exp) {
@@ -393,11 +394,17 @@ function generateTranslationCode(context, mode, params, translationSignatures) {
   return mode === "composition" ? generateComposableCode(context, params, translationSignatures) : generateLegacyCode(context, params);
 }
 function generateTranslationCallableSignatures(context, translationSignatures) {
-  const { prefixIdentifiers, bindingMetadata } = context;
-  return translationSignatures.map((signature) => {
-    const type = shared.hasOwn(bindingMetadata, signature) && bindingMetadata[signature];
+  const { prefixIdentifiers, bindingMetadata, inline } = context;
+  return translationSignatures.map((signatureOrResolver) => {
+    if (shared.isFunction(signatureOrResolver)) {
+      return signatureOrResolver(context);
+    }
+    if (inline && signatureOrResolver !== GLOBAL_TRANSLATE_SIGNATURE) {
+      return signatureOrResolver;
+    }
+    const type = shared.hasOwn(bindingMetadata, signatureOrResolver) && bindingMetadata[signatureOrResolver];
     const bindingContext = prefixIdentifiers ? type && type.startsWith("setup") || type === compilerDom.BindingTypes.LITERAL_CONST ? "$setup." : "_ctx." : "";
-    return `${bindingContext}${signature}`;
+    return `${bindingContext}${signatureOrResolver}`;
   }).join(" || ");
 }
 function generateComposableCode(context, params, translationSignatures) {

package/dist/index.d.cts

@@ -1,6 +1,40 @@
-import { DirectiveTransform } from '@vue/compiler-dom';
+import { DirectiveTransform, TransformContext } from '@vue/compiler-dom';
 import { I18n, I18nMode } from 'vue-i18n';
 
+/**
+ * Translation signature resolver
+ *
+ * @remarks
+ * This resolver is used at {@link TransformVTDirectiveOptions | 'translationSignatures' option}
+ *
+ * @example
+ * ```js
+ * import { compile } from '@vue/compiler-dom'
+ * import { transformVTDirective } from '@intlify/vue-i18n-extensions'
+ *
+ * // the below is just an example, you can use your own signature resolver
+ * const signatureMap = new Map()
+ *
+ * const transformVT = transformVTDirective({
+ *   translationSignatures: (context) => {
+ *     const { prefixIdentifiers, bindingMetadata, inline, filename } = context
+ *     let signature = ''
+ *
+ *     // something logic to resolve signature like using `signatureMap`
+ *     // signature = signatureMap.get(filename)
+ *     // ...
+ *
+ *     return signature
+ *   }
+ * })
+ *
+ * const { code } = compile(`<p v-t="'hello'"></p>`, {
+ *   // ...
+ *   directiveTransforms: { t: transformVT }
+ * })
+ * ```
+ */
+type TranslationSignatureResolver = (context: TransformContext) => string;
 /**
  * Transform options for `v-t` custom directive
  *
@@ -37,7 +71,7 @@ Legacy extends boolean = true> {
      * If each Vue component has a different signature for the translation function, you can specify several in an array for safe SSR.
      * This option value is `undefined` and the signature attached to the binding context is `t`.
      */
-    translationSignatures?: string | string[];
+    translationSignatures?: string | TranslationSignatureResolver | string[] | TranslationSignatureResolver[] | (string | TranslationSignatureResolver)[];
 }
 /**
  * Transform `v-t` custom directive

package/dist/index.d.mts

@@ -1,6 +1,40 @@
-import { DirectiveTransform } from '@vue/compiler-dom';
+import { DirectiveTransform, TransformContext } from '@vue/compiler-dom';
 import { I18n, I18nMode } from 'vue-i18n';
 
+/**
+ * Translation signature resolver
+ *
+ * @remarks
+ * This resolver is used at {@link TransformVTDirectiveOptions | 'translationSignatures' option}
+ *
+ * @example
+ * ```js
+ * import { compile } from '@vue/compiler-dom'
+ * import { transformVTDirective } from '@intlify/vue-i18n-extensions'
+ *
+ * // the below is just an example, you can use your own signature resolver
+ * const signatureMap = new Map()
+ *
+ * const transformVT = transformVTDirective({
+ *   translationSignatures: (context) => {
+ *     const { prefixIdentifiers, bindingMetadata, inline, filename } = context
+ *     let signature = ''
+ *
+ *     // something logic to resolve signature like using `signatureMap`
+ *     // signature = signatureMap.get(filename)
+ *     // ...
+ *
+ *     return signature
+ *   }
+ * })
+ *
+ * const { code } = compile(`<p v-t="'hello'"></p>`, {
+ *   // ...
+ *   directiveTransforms: { t: transformVT }
+ * })
+ * ```
+ */
+type TranslationSignatureResolver = (context: TransformContext) => string;
 /**
  * Transform options for `v-t` custom directive
  *
@@ -37,7 +71,7 @@ Legacy extends boolean = true> {
      * If each Vue component has a different signature for the translation function, you can specify several in an array for safe SSR.
      * This option value is `undefined` and the signature attached to the binding context is `t`.
      */
-    translationSignatures?: string | string[];
+    translationSignatures?: string | TranslationSignatureResolver | string[] | TranslationSignatureResolver[] | (string | TranslationSignatureResolver)[];
 }
 /**
  * Transform `v-t` custom directive

package/dist/index.d.ts

@@ -1,6 +1,40 @@
-import { DirectiveTransform } from '@vue/compiler-dom';
+import { DirectiveTransform, TransformContext } from '@vue/compiler-dom';
 import { I18n, I18nMode } from 'vue-i18n';
 
+/**
+ * Translation signature resolver
+ *
+ * @remarks
+ * This resolver is used at {@link TransformVTDirectiveOptions | 'translationSignatures' option}
+ *
+ * @example
+ * ```js
+ * import { compile } from '@vue/compiler-dom'
+ * import { transformVTDirective } from '@intlify/vue-i18n-extensions'
+ *
+ * // the below is just an example, you can use your own signature resolver
+ * const signatureMap = new Map()
+ *
+ * const transformVT = transformVTDirective({
+ *   translationSignatures: (context) => {
+ *     const { prefixIdentifiers, bindingMetadata, inline, filename } = context
+ *     let signature = ''
+ *
+ *     // something logic to resolve signature like using `signatureMap`
+ *     // signature = signatureMap.get(filename)
+ *     // ...
+ *
+ *     return signature
+ *   }
+ * })
+ *
+ * const { code } = compile(`<p v-t="'hello'"></p>`, {
+ *   // ...
+ *   directiveTransforms: { t: transformVT }
+ * })
+ * ```
+ */
+type TranslationSignatureResolver = (context: TransformContext) => string;
 /**
  * Transform options for `v-t` custom directive
  *
@@ -37,7 +71,7 @@ Legacy extends boolean = true> {
      * If each Vue component has a different signature for the translation function, you can specify several in an array for safe SSR.
      * This option value is `undefined` and the signature attached to the binding context is `t`.
      */
-    translationSignatures?: string | string[];
+    translationSignatures?: string | TranslationSignatureResolver | string[] | TranslationSignatureResolver[] | (string | TranslationSignatureResolver)[];
 }
 /**
  * Transform `v-t` custom directive

package/dist/index.mjs

@@ -1,5 +1,5 @@
 import { NodeTypes, TO_DISPLAY_STRING, createCompoundExpression, createSimpleExpression, isText, BindingTypes } from '@vue/compiler-dom';
-import { isString, format, isNumber, isArray, isSymbol, isObject, toDisplayString, hasOwn } from '@intlify/shared';
+import { isString, format, isNumber, isFunction, isArray, isSymbol, isObject, toDisplayString, hasOwn } from '@intlify/shared';
 import { parse } from '@babel/parser';
 
 function evaluateValue(expression) {
@@ -203,11 +203,12 @@ function createContentBuilder(options = {}) {
   };
 }
 
+const GLOBAL_TRANSLATE_SIGNATURE = "$t";
 function transformVTDirective(options = {}) {
   const i18nInstance = options.i18n;
   const mode = isString(options.mode) && ["composition", "legacy"].includes(options.mode) ? options.mode : "composition";
-  const translationSignatures = isString(options.translationSignatures) ? [options.translationSignatures] : isArray(options.translationSignatures) ? options.translationSignatures : ["t"];
-  translationSignatures.push(`$t`);
+  const translationSignatures = isString(options.translationSignatures) || isFunction(options.translationSignatures) ? [options.translationSignatures] : isArray(options.translationSignatures) ? options.translationSignatures : ["t"];
+  translationSignatures.push(GLOBAL_TRANSLATE_SIGNATURE);
   return (dir, node, context) => {
     const { exp, loc } = dir;
     if (!exp) {
@@ -391,11 +392,17 @@ function generateTranslationCode(context, mode, params, translationSignatures) {
   return mode === "composition" ? generateComposableCode(context, params, translationSignatures) : generateLegacyCode(context, params);
 }
 function generateTranslationCallableSignatures(context, translationSignatures) {
-  const { prefixIdentifiers, bindingMetadata } = context;
-  return translationSignatures.map((signature) => {
-    const type = hasOwn(bindingMetadata, signature) && bindingMetadata[signature];
+  const { prefixIdentifiers, bindingMetadata, inline } = context;
+  return translationSignatures.map((signatureOrResolver) => {
+    if (isFunction(signatureOrResolver)) {
+      return signatureOrResolver(context);
+    }
+    if (inline && signatureOrResolver !== GLOBAL_TRANSLATE_SIGNATURE) {
+      return signatureOrResolver;
+    }
+    const type = hasOwn(bindingMetadata, signatureOrResolver) && bindingMetadata[signatureOrResolver];
     const bindingContext = prefixIdentifiers ? type && type.startsWith("setup") || type === BindingTypes.LITERAL_CONST ? "$setup." : "_ctx." : "";
-    return `${bindingContext}${signature}`;
+    return `${bindingContext}${signatureOrResolver}`;
   }).join(" || ");
 }
 function generateComposableCode(context, params, translationSignatures) {

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@intlify/vue-i18n-extensions",
   "description": "vue-i18n extensions",
-  "version": "6.0.5",
+  "version": "6.1.0",
   "author": {
     "name": "kazuya kawaguchi",
     "email": "kawakazu80@gmail.com"