Merge pull request #109 from nextcloud/fix/only-log-in-debug-mode

Only log to console.warn when debug mode is active

lib/gettext.ts

@@ -6,6 +6,7 @@ class GettextBuilder {
 
     private locale?: string
     private translations = {}
+    private debug = false
 
     setLanguage(language: string): GettextBuilder {
         this.locale = language
@@ -21,8 +22,13 @@ class GettextBuilder {
         return this
     }
 
+    enableDebugMode(): GettextBuilder {
+        this.debug = true
+        return this
+    }
+
     build(): GettextWrapper {
-        return new GettextWrapper(this.locale || 'en', this.translations)
+        return new GettextWrapper(this.locale || 'en', this.translations, this.debug)
     }
 
 }
@@ -31,8 +37,10 @@ class GettextWrapper {
 
     private gt: GetText
 
-    constructor(locale: string, data: any) {
-        this.gt = new GetText()
+    constructor(locale: string, data: any, debug: boolean) {
+        this.gt = new GetText({
+            debug,
+        })
 
         for (let key in data) {
             this.gt.addTranslations(key, 'messages', data[key])

package.json

@@ -24,7 +24,7 @@
   },
   "dependencies": {
     "core-js": "^3.6.4",
-    "node-gettext": "^2.0.0"
+    "node-gettext": "^3.0.0"
   },
   "devDependencies": {
     "@babel/cli": "^7.8.4",

test/gettext.test.js

@@ -3,6 +3,15 @@ import { po } from 'gettext-parser'
 import { getGettextBuilder } from '../lib/gettext'
 
 describe('gettext', () => {
+
+    beforeEach(() => {
+        jest.spyOn(console, 'warn')
+    })
+
+    afterEach(() => {
+        console.warn.mockRestore()
+    })
+
     it('falls back to the original string', () => {
         const gt = getGettextBuilder()
             .setLanguage('de')
@@ -13,6 +22,27 @@ describe('gettext', () => {
         expect(translation).toEqual('Settings')
     })
 
+    it('does not log in production', () => {
+        const gt = getGettextBuilder()
+            .setLanguage('de')
+            .build()
+
+        gt.gettext('Settings')
+
+        expect(console.warn).not.toHaveBeenCalled()
+    })
+
+    it('has optional debug logs', () => {
+        const gt = getGettextBuilder()
+            .setLanguage('de')
+            .enableDebugMode()
+            .build()
+
+        gt.gettext('Settings')
+
+        expect(console.warn).toHaveBeenCalled()
+    })
+
     it('falls back to the original singular string', () => {
         const gt = getGettextBuilder()
             .setLanguage('en')