nuxt-ignis 0.3.2 → 0.3.3

package/test/features/default.txt

@@ -1,3 +1,3 @@
-Nuxt Ignis will start using following settings:
-Modules: @nuxt/eslint, @nuxt/fonts, @nuxt/image, @pinia/nuxt, @nuxt/scripts, nuxt-security, @vueuse/nuxt
-Nuxt: log-level=info[default]
+Nuxt Ignis will start using following settings:
+Modules: @nuxt/eslint, @nuxt/fonts, @nuxt/image, @nuxt/scripts, nuxt-security, @vueuse/nuxt, @pinia/nuxt
+Nuxt: log-level=info[default]

package/test/features/enable-all.txt

@@ -1,4 +1,4 @@
-Nuxt Ignis will start using following settings:
-Modules: @nuxt/eslint, @nuxt/fonts, @nuxt/image, @pinia/nuxt, @nuxt/scripts, nuxt-security, @vueuse/nuxt, @nuxt/ui, nuxt-neon, @nuxtjs/supabase, @nuxtjs/i18n, @vueform/nuxt, @formkit/nuxt, @nuxtjs/seo, @nuxt/content, nuxt-auth-utils
-Extras: Open Props CSS, elrh-pslo
-Nuxt: log-level=info[default]
+Nuxt Ignis will start using following settings:
+Modules: @nuxt/eslint, @nuxt/fonts, @nuxt/image, @nuxt/scripts, nuxt-security, @vueuse/nuxt, @pinia/nuxt, @nuxt/ui, nuxt-neon, @nuxtjs/supabase, @nuxtjs/i18n, @vueform/nuxt, @formkit/nuxt, @nuxtjs/seo, @nuxt/content, nuxt-auth-utils
+Extras: Open Props CSS, elrh-pslo
+Nuxt: log-level=info[default]

package/test/features/equipment.txt

@@ -0,0 +1,3 @@
+Nuxt Ignis will start using following settings:
+Modules: @nuxt/eslint, @nuxt/fonts, @nuxt/image, @nuxt/scripts, nuxt-security, @vueuse/nuxt, @pinia/nuxt, @maas/vue-equipment/nuxt
+Nuxt: log-level=info[default]

package/test/features/forms-formkit.txt

@@ -1,3 +1,3 @@
-Nuxt Ignis will start using following settings:
-Modules: @nuxt/eslint, @nuxt/fonts, @nuxt/image, @pinia/nuxt, @nuxt/scripts, nuxt-security, @vueuse/nuxt, @formkit/nuxt
-Nuxt: log-level=info[default]
+Nuxt Ignis will start using following settings:
+Modules: @nuxt/eslint, @nuxt/fonts, @nuxt/image, @nuxt/scripts, nuxt-security, @vueuse/nuxt, @pinia/nuxt, @formkit/nuxt
+Nuxt: log-level=info[default]

package/test/features/forms-off.txt

@@ -1,3 +1,3 @@
-Nuxt Ignis will start using following settings:
-Modules: @nuxt/eslint, @nuxt/fonts, @nuxt/image, @pinia/nuxt, @nuxt/scripts, nuxt-security, @vueuse/nuxt
-Nuxt: log-level=info[default]
+Nuxt Ignis will start using following settings:
+Modules: @nuxt/eslint, @nuxt/fonts, @nuxt/image, @nuxt/scripts, nuxt-security, @vueuse/nuxt, @pinia/nuxt
+Nuxt: log-level=info[default]

package/test/features/forms-vueform.txt

@@ -1,3 +1,3 @@
-Nuxt Ignis will start using following settings:
-Modules: @nuxt/eslint, @nuxt/fonts, @nuxt/image, @pinia/nuxt, @nuxt/scripts, nuxt-security, @vueuse/nuxt, @vueform/nuxt
-Nuxt: log-level=info[default]
+Nuxt Ignis will start using following settings:
+Modules: @nuxt/eslint, @nuxt/fonts, @nuxt/image, @nuxt/scripts, nuxt-security, @vueuse/nuxt, @pinia/nuxt, @vueform/nuxt
+Nuxt: log-level=info[default]

package/test/features/ui-nuxt-ui.txt

@@ -1,3 +1,3 @@
-Nuxt Ignis will start using following settings:
-Modules: @nuxt/eslint, @nuxt/fonts, @nuxt/image, @pinia/nuxt, @nuxt/scripts, nuxt-security, @vueuse/nuxt, @nuxt/ui
-Nuxt: log-level=info[default]
+Nuxt Ignis will start using following settings:
+Modules: @nuxt/eslint, @nuxt/fonts, @nuxt/image, @nuxt/scripts, nuxt-security, @vueuse/nuxt, @pinia/nuxt, @nuxt/ui
+Nuxt: log-level=info[default]

package/test/features/ui-off.txt

@@ -1,3 +1,3 @@
-Nuxt Ignis will start using following settings:
-Modules: @nuxt/eslint, @nuxt/fonts, @nuxt/image, @pinia/nuxt, @nuxt/scripts, nuxt-security, @vueuse/nuxt
-Nuxt: log-level=info[default]
+Nuxt Ignis will start using following settings:
+Modules: @nuxt/eslint, @nuxt/fonts, @nuxt/image, @nuxt/scripts, nuxt-security, @vueuse/nuxt, @pinia/nuxt
+Nuxt: log-level=info[default]

package/test/features/ui-tailwind.txt

@@ -1,4 +1,4 @@
-Nuxt Ignis will start using following settings:
-Modules: @nuxt/eslint, @nuxt/fonts, @nuxt/image, @pinia/nuxt, @nuxt/scripts, nuxt-security, @vueuse/nuxt
-Extras: Tailwind CSS
-Nuxt: log-level=info[default]
+Nuxt Ignis will start using following settings:
+Modules: @nuxt/eslint, @nuxt/fonts, @nuxt/image, @nuxt/scripts, nuxt-security, @vueuse/nuxt, @pinia/nuxt
+Extras: Tailwind CSS
+Nuxt: log-level=info[default]

package/test/features/validation-off.txt

@@ -0,0 +1,3 @@
+Nuxt Ignis will start using following settings:
+Modules: @nuxt/eslint, @nuxt/fonts, @nuxt/image, @nuxt/scripts, nuxt-security, @vueuse/nuxt, @pinia/nuxt
+Nuxt: log-level=info[default]

package/test/features/validation-valibot.txt

@@ -0,0 +1,4 @@
+Nuxt Ignis will start using following settings:
+Modules: @nuxt/eslint, @nuxt/fonts, @nuxt/image, @nuxt/scripts, nuxt-security, @vueuse/nuxt, @pinia/nuxt
+Extras: valibot
+Nuxt: log-level=info[default]

package/test/features/validation-zod.txt

@@ -0,0 +1,4 @@
+Nuxt Ignis will start using following settings:
+Modules: @nuxt/eslint, @nuxt/fonts, @nuxt/image, @nuxt/scripts, nuxt-security, @vueuse/nuxt, @pinia/nuxt
+Extras: zod
+Nuxt: log-level=info[default]

package/test/features.test.ts

@@ -158,6 +158,46 @@ describe('setFeatures() unit tests', () => {
     await expect(getConsoleOutput()).toMatchFileSnapshot('./features/forms-formkit.txt')
   })
 
+  // preset - validation
+
+  test('setFeatures() - validation preset - valibot', async () => {
+    process.env.NUXT_PUBLIC_IGNIS_PRESET_VALIDATION = 'valibot'
+    setFeatures()
+    await expect(getConsoleOutput()).toMatchFileSnapshot('./features/validation-valibot.txt')
+  })
+
+  test('setFeatures() - validation preset - zod', async () => {
+    process.env.NUXT_PUBLIC_IGNIS_PRESET_VALIDATION = 'zod'
+    setFeatures()
+    await expect(getConsoleOutput()).toMatchFileSnapshot('./features/validation-zod.txt')
+  })
+
+  test('setFeatures() - validation preset - off', async () => {
+    process.env.NUXT_PUBLIC_IGNIS_PRESET_VALIDATION = 'off'
+    setFeatures()
+    await expect(getConsoleOutput()).toMatchFileSnapshot('./features/validation-off.txt')
+  })
+
+  test('setFeatures() - validation preset - invalid', async () => {
+    process.env.NUXT_PUBLIC_IGNIS_PRESET_VALIDATION = 'invalid'
+    setFeatures()
+    await expect(getConsoleOutput()).toMatchFileSnapshot('./features/validation-off.txt')
+  })
+
+  // validation - set directly
+
+  test('setFeatures() - validation - valibot', async () => {
+    process.env.NUXT_PUBLIC_IGNIS_VALIBOT = 'true'
+    setFeatures()
+    await expect(getConsoleOutput()).toMatchFileSnapshot('./features/validation-valibot.txt')
+  })
+
+  test('setFeatures() - validation - zod', async () => {
+    process.env.NUXT_PUBLIC_IGNIS_ZOD = 'true'
+    setFeatures()
+    await expect(getConsoleOutput()).toMatchFileSnapshot('./features/validation-zod.txt')
+  })
+
   // disable "core" features
   test('setFeatures() - disable core features', async () => {
     process.env.NUXT_PUBLIC_IGNIS_CORE_ESLINT = 'false'
@@ -188,4 +228,12 @@ describe('setFeatures() unit tests', () => {
     setFeatures()
     await expect(getConsoleOutput()).toMatchFileSnapshot('./features/enable-all.txt')
   })
+
+  // Vue Equipment
+
+  test('setFeatures() - Vue Equipment - none', async () => {
+    process.env.NUXT_PUBLIC_IGNIS_EQUIPMENT_ENABLED = 'true'
+    setFeatures()
+    await expect(getConsoleOutput()).toMatchFileSnapshot('./features/equipment.txt')
+  })
 })

package/utils/config/content.ts

@@ -0,0 +1,35 @@
+// Nuxt Content requires its configuration to be injected and config exported
+// this normally happens in content.config.ts file in project root
+// however, it is not possible to transfer this config file when extending a layer
+// user only have to setup small custom config file in his own project
+// more info in the docs
+// TODO can this be changed? can layer's "auto-imports" be configured?
+
+import { defu } from 'defu'
+import { defineCollection, defineContentConfig } from '@nuxt/content'
+import { log } from '../consola'
+
+// re-export so it can be called in target apps without '@nuxt/content' dependency
+export function defineContentCollection(...args: Parameters<typeof defineCollection>) {
+  return defineCollection(...args)
+}
+
+// @ts-expect-error no-implicit-any
+// TODO set proper type for the object
+export function getContentConfig(userContentConfig) {
+  // only Nuxt Content is allowed
+  if (process.env.NUXT_PUBLIC_IGNIS_CONTENT === 'true') {
+  // defu-merge nuxt-ignis default with possible user values
+    return defu(userContentConfig, defineContentConfig({
+      collections: {
+        content: defineCollection({
+          source: '**',
+          type: 'page',
+        }),
+      },
+    }))
+  }
+  // otherwise throw warning and return just a dummy object
+  log.warn('loadContentConfig: @nuxt/content is not enabled, settings will take no effect')
+  return {}
+}

package/utils/config/vueform.ts

@@ -0,0 +1,25 @@
+// Vueform requires its configuration to be injected and config exported
+// this normally happens in vueform.config.ts file in project root
+// however, it is not possible to transfer this config file when extending a layer
+// user only have to setup small custom config file in his own project
+// more info in the docs
+// TODO can this be changed? can layer's "auto-imports" be configured?
+
+import { defu } from 'defu'
+
+import en from '@vueform/vueform/locales/en'
+import vueform from '@vueform/vueform/dist/vueform'
+import { defineConfig } from '@vueform/vueform'
+
+import '@vueform/vueform/types/index.d.ts'
+import '@vueform/vueform/dist/vueform.css'
+
+// @ts-expect-error no-implicit-any
+// TODO set proper type for the object
+export function getVueformConfig(userVueformConfig) {
+  return defu(userVueformConfig, defineConfig({
+    theme: vueform,
+    locales: { en },
+    locale: 'en',
+  }))
+}

package/utils/consola.ts

@@ -4,7 +4,7 @@
 import type { LogLevel, LogObject } from 'consola/core'
 import { LogLevels, createConsola } from 'consola/core'
 import { consola } from 'consola'
-import { useDateFormat } from '@vueuse/core'
+import { format } from 'date-fns'
 
 // default instance to write into browser's console
 const defaultReporter = consola
@@ -62,29 +62,39 @@ function getLogLevel(logLevel: string): LogLevel {
 }
 
 /**
- * Enhance received log object, which should be logged.
- * Add current date+time and trim irrelevant call-stack for warn/errors.
+ * Enhance received log object before it is logged.
+ * Add current date+time and trim irrelevant callstack for warn/errors.
  * @param logObj Object to be logged
- * @returns Enhanced object to be logged
+ * @returns Enhanced string to be logged
  */
 function transformLog(logObj: LogObject): string {
-  let logBody = logObj.args[0]
-  if (typeof logBody !== 'string') {
-    logBody = JSON.stringify(logBody)
+  const logData = logObj.args[0]
+
+  let logBody
+  if (typeof logData === 'string') {
+    logBody = logData
+  } else {
+    if ('message' in logData) {
+      logBody = logData.message
+    } else {
+      logBody = JSON.stringify(logData, null, 2)
+    }
   }
 
-  const timestamp = useDateFormat(new Date(), 'YYYY-MM-DD HH:mm:ss.SSS').value
+  // add timestamp to the log body
+  const timestamp = format(new Date(), 'yyyy-MM-dd HH:mm:ss.SSS')
   logBody = timestamp + '\n' + logBody
 
+  // for warns and errors the stack is parsed to display only relevant records
+  // (= coming from your own codebase)
   if (logObj.level <= LogLevels.warn) {
-    const fullStack = new Error(logBody).stack
+    const fullStack = logData.stack as string
     const filteredStack = fullStack?.split('\n    at ').filter(x => !x.includes('node_modules'))
-    const relevantStack = filteredStack?.slice(0, filteredStack.length - 3)
-    if (relevantStack?.length && logObj.level <= LogLevels.warn) {
+    if (filteredStack?.length && logObj.level <= LogLevels.warn) {
       if (logObj.level === LogLevels.warn) {
-        relevantStack[0] = relevantStack[0]!.replace('Error:', 'Warn:')
+        filteredStack[0] = filteredStack[0]!.replace('Error:', 'Warn:')
       }
-      logBody = timestamp + '\n' + relevantStack.join('\n\tat ')
+      logBody = timestamp + '\n' + filteredStack.join('\n\tat ')
     }
   }
 

package/utils/content.ts

@@ -1,31 +1,18 @@
-// this function adresses https://github.com/AloisSeckar/nuxt-ignis/issues/70
-// Nuxt Content requires its configuration to be injected and config exported
-// this normally happens in content.config.ts file in project root
-// however, it is not possible to transfer this config file when extending a layer
-// user only have to setup small custom config file in his own project
-// more info in the docs
-// TODO can this be changed? can layer's "auto-imports" be configured?
+// this functions shield configuration processing
+// when Nuxt Ignis' content.config.ts is presented
+// but the related module is not allowed by .env settings
 
-import { defu } from 'defu'
-import { defineCollection } from '@nuxt/content'
-import { log } from './consola'
-
-// re-export so it can be called in target apps without '@nuxt/content' dependency
-export function defineContentCollection(...args: Parameters<typeof defineCollection>) {
-  return defineCollection(...args)
-}
+import { getContentConfig } from './config/content'
 
 // @ts-expect-error no-implicit-any
-export async function loadContentConfig(userContentConfig) {
-  // only if content is allowed
+// TODO set proper type for the object
+export function loadContentConfig(userContentConfig) {
+  // only Nuxt Content is allowed
   if (process.env.NUXT_PUBLIC_IGNIS_CONTENT === 'true') {
-    // get nuxt-ignis default
-    const defaultContentConfig = await import('./config/content.config')
-    // merge with possible user values
-    const contentConfig = defu(userContentConfig, defaultContentConfig.default)
-    return contentConfig
+    // defu-merge nuxt-ignis default with possible user values
+    return getContentConfig(userContentConfig)
   }
-  // otherwise there is nothing to load
-  log.warn('@nuxt/content is not enabled, ensure you have NUXT_PUBLIC_IGNIS_CONTENT=true')
-  return null
+  // otherwise throw warning and return just a dummy object
+  log.warn('loadContentConfig: @nuxt/content is not enabled, settings will take no effect')
+  return {}
 }

package/utils/vueform.ts

@@ -1,16 +1,19 @@
-// this function adresses https://github.com/AloisSeckar/nuxt-ignis/issues/71
-// Vueform requires its configuration to be injected and config exported
-// this normally happens in vueform.config.ts file in project root
-// however, it is not possible to transfer this config file when extending a layer
-// user only have to setup small custom config file in his own project
-// more info in the docs
-// TODO can this be changed? can layer's "auto-imports" be configured?
+// this functions shield configuration processing
+// when Nuxt Ignis' vueform.config.ts is presented
+// but the related module is not allowed by .env settings
 
-export async function loadDefaultVueformConfig() {
+import { getVueformConfig } from './config/vueform'
+
+// @ts-expect-error no-implicit-any
+// TODO set proper type for the object
+export function loadVueformConfig(userVueformConfig) {
+  // only if Vueform is allowed
   const config = useRuntimeConfig().public.ignis
   if (config.preset.forms === 'vueform' || config.vueform === true) {
-    const vueformConfig = await import('./config/vueform.config')
-    return vueformConfig.default
+    // defu-merge nuxt-ignis default with possible user values
+    return getVueformConfig(userVueformConfig)
   }
-  return null
+  // otherwise throw warning and return just a dummy object
+  log.warn('loadVueformConfig: Vueform is not enabled, settings will take no effect')
+  return {}
 }

package/vueform.config.ts

@@ -1,8 +1,6 @@
 // minimal config for Vueform
 // currently required to be loaded like this...
 
-import { defineConfig } from '@vueform/vueform'
-
-const vueformConfig = await loadDefaultVueformConfig()
-
-export default defineConfig(vueformConfig!)
+export default loadVueformConfig({
+  // custom config here
+})

package/utils/config/content.config.ts

@@ -1,12 +0,0 @@
-import { defineCollection, defineContentConfig } from '@nuxt/content'
-
-export default defineContentConfig({
-  // while it is not strictily necessary to have a default config file
-  // it produces warning during startup when not presented
-  collections: {
-    content: defineCollection({
-      source: '**',
-      type: 'page',
-    }),
-  },
-})

package/utils/config/vueform.config.ts

@@ -1,20 +0,0 @@
-// this is basic "getting started" configuration example
-// for more options check:
-// https://vueform.com/docs/configuration
-
-import en from '@vueform/vueform/locales/en'
-import vueform from '@vueform/vueform/dist/vueform'
-import { defineConfig } from '@vueform/vueform'
-
-// add Vueform type definitions
-import '@vueform/vueform/types/index.d.ts'
-
-// add default CSS styles
-// can be placed anywhere else in your project
-import '@vueform/vueform/dist/vueform.css'
-
-export default defineConfig({
-  theme: vueform,
-  locales: { en },
-  locale: 'en',
-})