refactor: improve error reporting on wrong configuration when using lazy

Resolves #1101
nuxt-modules · Mar 9, 2021 · 5a8b1d9 · 5a8b1d9
1 parent 3ea3d4d
commit 5a8b1d9
Show file tree

Hide file tree

Showing 4 changed files with 15 additions and 11 deletions.
diff --git a/src/core/hooks.js b/src/core/hooks.js
@@ -1,4 +1,4 @@
-import { MODULE_NAME, STRATEGIES } from '../helpers/constants'
+import { MODULE_NAME, STRATEGIES, LOCALE_FILE_KEY } from '../helpers/constants'
 
 export function createExtendRoutesHook (moduleContainer, options) {
   const nuxtOptions = moduleContainer.options
@@ -29,10 +29,19 @@ export function createExtendRoutesHook (moduleContainer, options) {
 }
 
 export function buildHook (moduleContainer, options) {
-  if (options.langDir) {
+  if (options.lazy) {
+    if (!options.langDir) {
+      throw new Error(`[${MODULE_NAME}] When using the "lazy" option you must also set the "langDir" option.`)
+    }
     if (!options.locales.length || typeof options.locales[0] === 'string') {
-      console.error('[' + MODULE_NAME + '] When using "langDir" option, the "locales" option must be a list of objects')
+      throw new Error(`[${MODULE_NAME}] When using the "langDir" option the "locales" option must be a list of objects.`)
+    }
+    for (const locale of options.locales) {
+      if (!locale[LOCALE_FILE_KEY]) {
+        throw new Error(`[${MODULE_NAME}] All locale objects must have the "file" property set when using "lazy".\nFound none in:\n${JSON.stringify(locale, null, 2)}.`)
+      }
     }
+    options.langDir = moduleContainer.nuxt.resolver.resolveAlias(options.langDir)
   }
 
   if (options.strategy === STRATEGIES.NO_PREFIX && options.differentDomains) {

diff --git a/src/index.js b/src/index.js
@@ -21,11 +21,6 @@ export default function (userOptions) {
     return
   }
 
-  // Resolve langDir
-  if (options.langDir) {
-    options.langDir = this.nuxt.resolver.resolveAlias(options.langDir)
-  }
-
   // Templates (including plugins).
   // This is done here rather than in the build hook to ensure the order the plugins are added
   // is predictable between different modules.

diff --git a/src/templates/options.js b/src/templates/options.js
@@ -18,7 +18,7 @@ for (const [key, value] of Object.entries(options)) {
 }
 %>
 
-<% if (options.langDir) { %>
+<% if (options.lazy && options.langDir) { %>
 export const ASYNC_LOCALES = {
   <%= Array.from(
         new Set(options.locales.map(l => `'${l.file}': () => import('../${relativeToBuild(options.langDir, l.file)}' /* webpackChunkName: "lang-${l.file}" */)`))

diff --git a/src/templates/utils.js b/src/templates/utils.js
@@ -1,7 +1,7 @@
 import {
   LOCALE_CODE_KEY,
   LOCALE_FILE_KEY,
-  MODULE_NAME/* <% if (options.langDir) { %> */,
+  MODULE_NAME/* <% if (options.lazy && options.langDir) { %> */,
   ASYNC_LOCALES/* <% } %> */
 } from './options'
 
@@ -22,7 +22,7 @@ export async function loadLanguageAsync (context, locale) {
     if (localeObject) {
       const file = localeObject[LOCALE_FILE_KEY]
       if (file) {
-        /* <% if (options.langDir) { %> */
+        /* <% if (options.lazy && options.langDir) { %> */
         let messages
         if (process.client) {
           const { nuxtState } = context