refactor(translation): use translation adapters #1

.env.example

@@ -1,3 +1,12 @@
+# ------------------
+# Translation driver
+# ------------------
+VUE_APP_TRANSLATION_DRIVER=none
+# VUE_APP_TRANSLATION_DRIVER=google
+
+# ---------------------------------------
+# Google translation driver configuration
+# ---------------------------------------
 VUE_APP_GOOGLE_TRANSLATE_API_KEY=
 
 # --------------
@@ -6,9 +15,9 @@ VUE_APP_GOOGLE_TRANSLATE_API_KEY=
 VUE_APP_STORAGE_DRIVER=localstorage
 # VUE_APP_STORAGE_DRIVER=firebase
 
-# -----------------------------
+# ----------------------------------
 # Local storage driver configuration
-# -----------------------------
+# ----------------------------------
 VUE_APP_LOCALSTORAGE_PROJECTS_KEY=translations
 VUE_APP_LOCALSTORAGE_PARAGRAPHS_KEY_PREFIX=translation-
 

README.md

@@ -4,6 +4,7 @@ An alternative for Google Translator Toolkit orphans.
 
 Supported translation APIs:
 
+* None (no automatic translation)
 * Google Translate
 
 Supported storage drivers:
@@ -37,8 +38,6 @@ yarn serve
 
 ```bash
 yarn build
-firebase deploy --only firestore:rules
-firebase deploy --only hosting
 ```
 
 ### Lints and fixes files

src/machine-translation/google-cloud.ts → src/machine-translation/google.ts

@@ -1,5 +1,5 @@
 import chunk from 'lodash.chunk'
-import { LanguageCode } from '@/types'
+import { TranslateFunc } from './types'
 
 const API_KEY = process.env.VUE_APP_GOOGLE_TRANSLATE_API_KEY
 const MAX_PARAGRAPHS_PER_REQUEST = 128
@@ -9,10 +9,10 @@ const sleep = (millis: number) => {
   return new Promise(resolve => setTimeout(resolve, millis))
 }
 
-const translate = async (
-  targetLanguage: LanguageCode,
-  sourceText: string,
-  sourceLanguage: LanguageCode,
+const translate: TranslateFunc = async (
+  targetLanguage,
+  sourceText,
+  sourceLanguage,
 ) => {
   const sourceParagraphs = sourceText.split('\n\n')
   const chunks = chunk(sourceParagraphs, MAX_PARAGRAPHS_PER_REQUEST)

src/machine-translation/index.ts

@@ -0,0 +1,16 @@
+import { TranslationDriverMap } from './types'
+
+import * as google from './google'
+import * as none from './none'
+
+const drivers: TranslationDriverMap = { google, none }
+const chosenDriver = process.env.VUE_APP_TRANSLATION_DRIVER || 'none'
+const driver = drivers[chosenDriver]
+
+if (!driver) {
+  throw new Error(`Invalid translation driver "${chosenDriver}"`)
+}
+
+const translate = driver.translate
+
+export { translate }

src/machine-translation/none.ts

@@ -0,0 +1,13 @@
+import { TranslateFunc } from './types'
+
+const translate: TranslateFunc = async (
+  targetLanguage,
+  sourceText,
+  sourceLanguage,
+) => {
+  return Promise.resolve().then(() => {
+    return sourceText
+  })
+}
+
+export { translate }

src/machine-translation/types.ts

@@ -0,0 +1,17 @@
+import { LanguageCode } from '@/types'
+
+export interface TranslateFunc {
+  (
+    targetLanguage: LanguageCode,
+    sourceText: string,
+    sourceLanguage: LanguageCode,
+  ): Promise<string>
+}
+
+export interface TranslationDriver {
+  translate: TranslateFunc
+}
+
+export interface TranslationDriverMap {
+  [key: string]: TranslationDriver
+}

src/storage/types.ts

@@ -1,4 +1,3 @@
-import { Store } from '@/store/store'
 import { TranslationProject } from '@/types'
 
 export interface ListTranslationsFunc {

src/views/NewTranslation.vue

@@ -35,7 +35,7 @@ import { reactive } from 'vue'
 import { editTranslation } from '@/helpers'
 import { storeTranslation } from '@/storage'
 import { v4 as uuid } from 'uuid'
-import { translate as machineTranslation } from '@/machine-translation/google-cloud'
+import { translate as machineTranslation } from '@/machine-translation'
 
 export default {
   components: {