@knowark/loggarkjs 0.3.6 → 0.3.7

package/lib/index.d.ts

@@ -21,3 +21,15 @@ export declare class Logger {
 
   debug(...data: any[]): void
 }
+
+export declare class Translator {
+  static translate(key: string, options?: object): string
+
+  constructor (options?: object)
+
+  translate(key: string, options?: object): string
+
+  t(key: string, options?: object): string
+}
+
+export declare function t(key: string, options?: object): string

package/lib/index.js

@@ -1 +1,2 @@
 export { Logger } from './logger.js'
+export { Translator, t } from './translator.js'

package/lib/logger.test.js

@@ -1,7 +1,6 @@
-import { test, expect } from '@jest/globals'
+import { it, expect } from '@jest/globals'
 import { Logger } from './logger.js'
 
-
 function setup () {
   const mockGlobal = {
     console: {
@@ -15,17 +14,17 @@ function setup () {
   return {mockGlobal}
 }
 
-test('can be instantiated', () => {
+it('can be instantiated', () => {
   const logger = new Logger()
   expect(logger).toBeTruthy()
 })
 
-test('can be instantiated', () => {
+it('can be instantiated', () => {
   const logger = new Logger()
   expect(logger).toBeTruthy()
 })
 
-test('is disabled by default', () => {
+it('is disabled by default', () => {
   const { mockGlobal } = setup()
   const logger = new Logger({ global: mockGlobal })
 
@@ -45,7 +44,7 @@ test('is disabled by default', () => {
   expect(mockGlobal.debugArgs).toBeFalsy()
 })
 
-test('adds a prefix to the logging methods according to loglevel', () => {
+it('adds a prefix to the logging methods according to loglevel', () => {
   const { mockGlobal } = setup()
   mockGlobal.LOGLEVEL = 'debug'
   const logger = new Logger({ global: mockGlobal })
@@ -66,7 +65,7 @@ test('adds a prefix to the logging methods according to loglevel', () => {
   expect(mockGlobal.debugArgs).toEqual(['[DEBUG]', 'Logging something...'])
 })
 
-test('adds the provided logging context labels to its final output', () => {
+it('adds the provided logging context labels to its final output', () => {
   const { mockGlobal } = setup()
   mockGlobal.LOGLEVEL = 'debug'
   const context = { correlationId: 'ABCD1234', interactor: 'Informer' }
@@ -103,7 +102,7 @@ test('adds the provided logging context labels to its final output', () => {
     'Logging something...'])
 })
 
-test('supports including static context labels', () => {
+it('supports including static context labels', () => {
   Logger.context = () => {
     return { correlationId: 'ABCD1234' }
   }

package/lib/translator.js

@@ -0,0 +1,22 @@
+export class Translator {
+  static translate (key, _options) {
+    return key
+  }
+
+  #options = {}
+
+  constructor (options = {}) {
+    this.#options = options
+  }
+
+  translate (key, options) {
+    return this.constructor.translate(
+      key, { ...this.#options, ...options })
+  }
+
+  get t () {
+    return this.translate.bind(this)
+  }
+}
+
+export const t = (key, options) => Translator.translate(key, options)

package/lib/translator.test.js

@@ -0,0 +1,35 @@
+import { it, expect } from '@jest/globals'
+import { Translator, t } from './translator.js'
+
+it('can be instantiated', () => {
+  const translator = new Translator()
+  expect(translator).toBeTruthy()
+})
+
+it('defines a translate function with options', () => {
+  const translator = new Translator()
+
+  const result = translator.translate('any.key') 
+
+  expect(result).toBe('any.key')
+})
+
+it('defines a t shortcut for function translate', () => {
+  const t = new Translator().t
+
+  const result = t('any.key') 
+
+  expect(result).toBe('any.key')
+})
+
+it('defines a global t shortcut translate', () => {
+  const originalTranslate = Translator.translate
+  Translator.translate = (key, _options) => {
+    return `translated:${key}`
+  }
+
+  const result = t('any.key') 
+
+  expect(result).toBe('translated:any.key')
+  Translator.translate = originalTranslate
+})

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@knowark/loggarkjs",
-  "version": "0.3.6",
+  "version": "0.3.7",
   "description": "Utilitarian Logging Library",
   "main": "./lib/index.js",
   "type": "module",