feat: add debug logs

src/debug.ts

@@ -0,0 +1,12 @@
+/*
+ * @adonisjs/i18n
+ *
+ * (c) AdonisJS
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+import { debuglog } from 'node:util'
+
+export default debuglog('adonisjs:i18n')

src/edge_plugin_i18n.ts

@@ -9,6 +9,7 @@
 
 import type { PluginFn } from 'edge.js/types'
 
+import debug from './debug.js'
 import type { I18n } from './i18n.js'
 import type { I18nManager } from './i18n_manager.js'
 
@@ -17,6 +18,8 @@ import type { I18nManager } from './i18n_manager.js'
  * flash messages
  */
 export const edgePluginI18n: (i18n: I18nManager) => PluginFn<undefined> = (i18n) => {
+  debug('registering edge helpers')
+
   return (edge) => {
     /**
      * Reference to i18n for the default locale. HTTP requests

src/i18n.ts

@@ -9,6 +9,7 @@
 
 import type { Emitter } from '@adonisjs/core/events'
 
+import debug from './debug.js'
 import type { I18nManager } from './i18n_manager.js'
 import { Formatter } from './formatters/values_formatter.js'
 import type { MissingTranslationEventPayload } from './types/main.js'
@@ -116,6 +117,8 @@ export class I18n extends Formatter {
    * Switch locale for the current instance
    */
   switchLocale(locale: string) {
+    debug('switching locale from "%s" to "%s"', this.locale, locale)
+
     super.switchLocale(locale)
     this.localeTranslations = this.#i18nManager.getTranslationsFor(this.locale)
     this.fallbackTranslations = this.#i18nManager.getTranslationsFor(this.fallbackLocale)

src/i18n_manager.ts

@@ -18,6 +18,7 @@ import type {
   MissingTranslationEventPayload,
 } from './types/main.js'
 
+import debug from './debug.js'
 import { I18n } from './i18n.js'
 import { FsLoader } from './loaders/fs_loader.js'
 import { IcuFormatter } from './formatters/icu_messages_formatter.js'
@@ -163,6 +164,8 @@ export class I18nManager {
    * Reload translations from the registered loaders
    */
   async reloadTranslations() {
+    debug('loading translations')
+
     const translationsStack = await Promise.all(
       Object.keys(this.#config.loaders)
         .filter((loader) => {
@@ -289,6 +292,8 @@ export class I18nManager {
     type: 'loader' | 'formatter',
     callback: ManagerLoaderFactory | ManagerFormatterFactory
   ): void {
+    debug('adding custom %s', type)
+
     if (type === 'loader') {
       this.#loaders[name] = callback as ManagerLoaderFactory
     } else {

src/loaders/fs_loader.ts

@@ -12,6 +12,8 @@ import { fileURLToPath } from 'node:url'
 import { join, extname } from 'node:path'
 import { readFile } from 'node:fs/promises'
 import { flatten, fsReadAll } from '@poppinss/utils'
+
+import debug from '../debug.js'
 import type { FsLoaderOptions, Translations, TranslationsLoaderContract } from '../types/main.js'
 
 /**
@@ -93,6 +95,8 @@ export class FsLoader implements TranslationsLoaderContract {
    * Processes the message inside a JSON file
    */
   async #processJSONFile(filePath: string, messagesBag: Record<string, any>) {
+    debug('loading translations from "%s"', filePath)
+
     const contents = await readFile(join(this.#storageBasePath, filePath), 'utf-8')
     const messages = this.#parseJSON(filePath, contents)
     this.#processFileTranslations(filePath, messages, messagesBag)
@@ -127,6 +131,8 @@ export class FsLoader implements TranslationsLoaderContract {
    * Processes the message inside a YAML file
    */
   async #processYamlFile(filePath: string, messagesBag: Record<string, any>) {
+    debug('loading translations from "%s"', filePath)
+
     const contents = await readFile(join(this.#storageBasePath, filePath), 'utf-8')
     const messages = this.#parseYaml(filePath, contents)
     this.#processFileTranslations(filePath, messages, messagesBag)