chore: small improvements

Author: atinux

README.md

@@ -8,7 +8,7 @@ Add theme/extends support to Nuxt 2 projects!
 
 ## Features
 
-- Forward compatible with nuxt3 multi app
+- Forward compatible with Nuxt 3 multi Apps
 - Support nested `extends`
 - Smartly merge config and hooks
 - Allow theme development to be like a normal nuxt project
@@ -33,6 +33,7 @@ Update `nuxt.config` file:
 import { resolveConfig } from '@nuxt/theme'
 
 export default resolveConfig({
+  // Your actual Nuxt configuration
 })
 ```
 
@@ -50,20 +51,20 @@ export default resolveConfig({
 
 ### Theme Author
 
-- Update `nuxt.config` and ensure required `rootDir` and `name` properties are provided
+1. Update `nuxt.config` and ensure required `rootDir` and `name` properties are provided
 
 ```js
 import { resolveConfig } from '@nuxt/theme'
 
 export default resolveConfig({
-  rootDir: __direname,
+  rootDir: __dirname,
   name: 'myTheme',
 }
 ```
 
 **Note:** If you are extending another theme, `rootDir` should be ONLY provided if you want to also extend project.
 
-- Instead of using `~/` or `@/` aliases, use `~myTheme` or `@myTheme`
+2. Instead of using `~/` or `@/` aliases, use `~myTheme` or `@myTheme`
 
 ## License
 

src/index.ts

@@ -16,19 +16,18 @@ declare module '@nuxt/types' {
 export function resolveConfig (config: string | NuxtConfig, from: string = process.cwd(), level = 0): NuxtConfig {
   if (typeof config === 'string') {
     const jiti = require('jiti')(from)
-    const name = config
     const nuxtConfigFile = jiti.resolve(config)
     config = jiti(nuxtConfigFile) as NuxtConfig
+    config._file = nuxtConfigFile
 
     if (!config.rootDir) {
       config.rootDir = dirname(nuxtConfigFile)
     }
-
-    if (!config.name) {
-      config.name = name
-    }
   }
 
+  if (typeof config === 'function') {
+    throw new TypeError('@nuxt/theme does not support Nuxt config as function')
+  }
   if (!config.rootDir) {
     config.rootDir = from
   }
@@ -40,16 +39,19 @@ export function resolveConfig (config: string | NuxtConfig, from: string = proce
     config = extendConfig(config, _resolvedExtends)
   }
 
+  // delete tempory _file for error DX
+  delete config._file
+
   return config
 }
 
 export function extendConfig (target: NuxtConfig, base: NuxtConfig): NuxtConfig {
-  // Ensure base has require fileds
+  // Ensure base has required fields
   if (!base.name) {
-    throw new Error('Base config is missing `name` property')
+    throw new Error('Theme config is missing the `name` property' + (base._file ? `in ${base._file}` : ''))
   }
   if (!base.rootDir) {
-    throw new Error('Base config is missing `rootDir` property')
+    throw new Error('Theme config is missing the `rootDir` property')
   }
   if (!base.srcDir) {
     base.srcDir = base.rootDir

test/fixture/app/nuxt.config.cjs.js

@@ -1,3 +1 @@
 export default require('jiti')(__dirname)('./nuxt.config.ts')
-
-console.log(require('jiti')(__dirname)('./nuxt.config.ts').default.components)

test/index.test.ts

@@ -1,3 +1,5 @@
+import { resolve } from 'path'
+import { resolveConfig } from '../src'
 import config from './fixture/app/nuxt.config'
 
 const scrub = (input) => {
@@ -20,6 +22,11 @@ const scrub = (input) => {
   return input
 }
 
+it('fails on config being a function', () => {
+  const config = () => ({})
+  expect(() => resolveConfig(config)).toThrow('@nuxt/theme does not support Nuxt config as function')
+})
+
 it('matches snapshot', () => {
   expect(scrub(config)).toMatchSnapshot()
 })