refactor: override typings for $t and remove string casting

jellyfin · Dec 30, 2020 · 7c559ab · 7c559ab
1 parent 8e05e3c
commit 7c559ab
Show file tree

Hide file tree

Showing 13 changed files with 49 additions and 26 deletions.
diff --git a/components/Buttons/TypeButton.vue b/components/Buttons/TypeButton.vue
@@ -49,24 +49,24 @@ export default Vue.extend({
       switch (this.type) {
         case 'movies':
           return [
-            { name: this.$t('movies').toString(), value: 'Movie' },
-            { name: this.$t('collections').toString(), value: 'BoxSet' },
-            { name: this.$t('actors').toString(), value: 'Actor' },
-            { name: this.$t('genres').toString(), value: 'Genre' },
-            { name: this.$t('studios').toString(), value: 'Studio' }
+            { name: this.$t('movies'), value: 'Movie' },
+            { name: this.$t('collections'), value: 'BoxSet' },
+            { name: this.$t('actors'), value: 'Actor' },
+            { name: this.$t('genres'), value: 'Genre' },
+            { name: this.$t('studios'), value: 'Studio' }
           ];
         case 'music':
           return [
-            { name: this.$t('albums').toString(), value: 'MusicAlbum' },
-            { name: this.$t('artists').toString(), value: 'MusicArtist' },
-            { name: this.$t('genres').toString(), value: 'MusicGenre' }
+            { name: this.$t('albums'), value: 'MusicAlbum' },
+            { name: this.$t('artists'), value: 'MusicArtist' },
+            { name: this.$t('genres'), value: 'MusicGenre' }
           ];
         case 'tvshows':
           return [
-            { name: this.$t('series').toString(), value: 'Series' },
-            { name: this.$t('actors').toString(), value: 'Actor' },
-            { name: this.$t('genres').toString(), value: 'Genre' },
-            { name: this.$t('networks').toString(), value: 'Studio' }
+            { name: this.$t('series'), value: 'Series' },
+            { name: this.$t('actors'), value: 'Actor' },
+            { name: this.$t('genres'), value: 'Genre' },
+            { name: this.$t('networks'), value: 'Studio' }
           ];
         default:
           return [];

diff --git a/components/Item/ItemMenu.vue b/components/Item/ItemMenu.vue
@@ -50,7 +50,7 @@ export default Vue.extend({
         const menuItems = [] as MenuItem[];
         if (this.$auth.$state.user.Policy.IsAdministrator) {
           menuItems.push({
-            title: this.$t('editMetadata') as string,
+            title: this.$t('editMetadata'),
             action: () => {
               this.dialog = true;
             }

diff --git a/components/Item/MediaInfo.vue b/components/Item/MediaInfo.vue
@@ -82,7 +82,7 @@ export default Vue.extend({
       // TODO: Use a Date object
       return this.$t('endsAt', {
         time: endTimeShort
-      }).toString();
+      });
     }
   }
 });

diff --git a/components/Item/Metadata/MetadataEditor.vue b/components/Item/Metadata/MetadataEditor.vue
@@ -360,7 +360,7 @@ export default Vue.extend({
         }
 
         this.$store.dispatch('snackbar/display', {
-          message: errorMessage.toString(),
+          message: errorMessage,
           color: 'error'
         });
       }

diff --git a/components/Layout/HomeHeader/HomeHeader.vue b/components/Layout/HomeHeader/HomeHeader.vue
@@ -74,9 +74,9 @@ export default Vue.extend({
     }
 
     if (this.items.length === 0) {
-      this.extraText = this.$t('homeHeader.welcome.noItems').toString();
+      this.extraText = this.$t('homeHeader.welcome.noItems');
     } else {
-      this.extraText = this.$t('homeHeader.welcome.checkNewItems').toString();
+      this.extraText = this.$t('homeHeader.welcome.checkNewItems');
     }
     window.setTimeout(this.hideWelcomeMessage, 1500);
   },

diff --git a/components/Players/VideoPlayer.vue b/components/Players/VideoPlayer.vue
@@ -112,7 +112,7 @@ export default Vue.extend({
         });
       } else {
         this.$nuxt.error({
-          message: this.$t('browserNotSupported') as string
+          message: this.$t('browserNotSupported')
         });
       }
     } catch (error) {

diff --git a/components/Users/UserCard.vue b/components/Users/UserCard.vue
@@ -48,7 +48,7 @@ export default Vue.extend({
           locale: this.getDfnsLocale()
         });
       } else {
-        return this.$t('never').toString();
+        return this.$t('never');
       }
     }
   }

diff --git a/layouts/default.vue b/layouts/default.vue
@@ -147,7 +147,7 @@ export default Vue.extend({
       return [
         {
           icon: 'mdi-home',
-          title: this.$t('home').toString(),
+          title: this.$t('home'),
           to: '/'
         }
       ];
@@ -156,12 +156,12 @@ export default Vue.extend({
       return [
         {
           icon: 'mdi-pencil-outline',
-          title: this.$t('metadata').toString(),
+          title: this.$t('metadata'),
           to: '/metadata'
         },
         {
           icon: 'mdi-cog',
-          title: this.$t('settings').toString(),
+          title: this.$t('settings'),
           to: '/settings'
         }
       ];

diff --git a/nuxt-i18n.d.ts b/nuxt-i18n.d.ts
@@ -0,0 +1,23 @@
+import VueI18n, { Path, Values } from 'vue-i18n/types';
+
+/**
+ * Overloads VueI18n interface to avoid needing to cast return value to string.
+ * See https://github.com/kazupon/vue-i18n/issues/410
+ */
+declare module 'vue-i18n/types' {
+  export default class VueI18n {
+    t(key: Path, values?: Values): string;
+  }
+}
+
+declare module 'vue/types/vue' {
+  interface Vue {
+    $t: typeof VueI18n.prototype.t;
+  }
+
+  interface VueConstructor {
+    i18n: typeof VueI18n.prototype;
+  }
+}
+
+export default VueI18n;
diff --git a/pages/genre/_itemId/index.vue b/pages/genre/_itemId/index.vue
@@ -99,7 +99,7 @@ export default Vue.extend({
       // Can't get given library ID
       this.$nuxt.error({
         statusCode: 404,
-        message: this.$t('libraryNotFound') as string
+        message: this.$t('libraryNotFound')
       });
     }
   },

diff --git a/pages/item/_itemId/index.vue b/pages/item/_itemId/index.vue
@@ -425,7 +425,7 @@ export default Vue.extend({
     ...mapActions('backdrop', ['setBackdrop', 'clearBackdrop']),
     getLanguageName(code?: string): string {
       if (!code) {
-        return this.$t('undefined').toString();
+        return this.$t('undefined');
       }
       return langs.where('2B', code).name;
     },

diff --git a/pages/library/_viewId.vue b/pages/library/_viewId.vue
@@ -166,7 +166,7 @@ export default Vue.extend({
       // Can't get given library ID
       this.$nuxt.error({
         statusCode: 404,
-        message: this.$t('libraryNotFound') as string
+        message: this.$t('libraryNotFound')
       });
     }
   },

diff --git a/plugins/veeValidate.ts b/plugins/veeValidate.ts
@@ -13,7 +13,7 @@ const veeValidate: Plugin = ({ app }) => {
   configure({
     defaultMessage: (_field, values) => {
       // values._field_ = app.i18n.t(`fields.${field}`);
-      return app.i18n.t(`validation.${values._rule_}`, values).toString();
+      return app.i18n.t(`validation.${values._rule_}`, values);
     }
   });
 };