nuxt-spec 0.4.0-alpha.2 → 0.4.0-alpha.3

package/config/templates/vitest.config.ts.template

@@ -1,5 +1,5 @@
-import { loadVitestConfig } from 'nuxt-spec/config'
-
-export default loadVitestConfig({
-  // custom config here
-})
+import { loadVitestConfig } from 'nuxt-spec/config'
+
+export default loadVitestConfig({
+  // custom config here
+})

package/config/utils/merge.mjs

@@ -1,43 +1,43 @@
-// custom merger function based on defu
-// allows working with the "projects" array properly
-// user-defined config overrides are merged by "name"
-
-// for consistent and predictable results, passing "include" or "browser.instances"
-// will result in OVERRIDE instead of merging with nuxt-spec defaults
-
-import { createDefu } from 'defu'
-
-// in real Vitest config, "name" is nested inside another "test" object
-const getProjectName = project => project?.name ?? project?.test?.name
-
-export const mergeConfig = createDefu((obj, key, value) => {
-  if (key === 'projects' && Array.isArray(obj[key]) && Array.isArray(value)) {
-    const defaults = obj[key]
-    const overrides = value
-
-    // override default values if user-defined config specifies them
-    obj[key] = defaults.map((defaultProject) => {
-      const override = overrides.find(o => getProjectName(o) === getProjectName(defaultProject))
-      return override ? mergeProject(override, defaultProject) : defaultProject
-    })
-
-    // add any user projects that don't exist in defaults
-    for (const override of overrides) {
-      if (!defaults.some(d => getProjectName(d) === getProjectName(override))) {
-        obj[key].push(override)
-      }
-    }
-
-    return true
-  }
-})
-
-// Keys where user value should fully replace the default, not merge
-const overrideKeys = new Set(['include', 'instances'])
-
-const mergeProject = createDefu((obj, key, value) => {
-  if (overrideKeys.has(key)) {
-    obj[key] = value
-    return true
-  }
-})
+// custom merger function based on defu
+// allows working with the "projects" array properly
+// user-defined config overrides are merged by "name"
+
+// for consistent and predictable results, passing "include" or "browser.instances"
+// will result in OVERRIDE instead of merging with nuxt-spec defaults
+
+import { createDefu } from 'defu'
+
+// in real Vitest config, "name" is nested inside another "test" object
+const getProjectName = project => project?.name ?? project?.test?.name
+
+export const mergeConfig = createDefu((obj, key, value) => {
+  if (key === 'projects' && Array.isArray(obj[key]) && Array.isArray(value)) {
+    const defaults = obj[key]
+    const overrides = value
+
+    // override default values if user-defined config specifies them
+    obj[key] = defaults.map((defaultProject) => {
+      const override = overrides.find(o => getProjectName(o) === getProjectName(defaultProject))
+      return override ? mergeProject(override, defaultProject) : defaultProject
+    })
+
+    // add any user projects that don't exist in defaults
+    for (const override of overrides) {
+      if (!defaults.some(d => getProjectName(d) === getProjectName(override))) {
+        obj[key].push(override)
+      }
+    }
+
+    return true
+  }
+})
+
+// Keys where user value should fully replace the default, not merge
+const overrideKeys = new Set(['include', 'instances'])
+
+const mergeProject = createDefu((obj, key, value) => {
+  if (overrideKeys.has(key)) {
+    obj[key] = value
+    return true
+  }
+})

package/config/utils/options.d.mts

@@ -1,59 +1,59 @@
-export type HtmlReportOpenMode = 'always' | 'failed' | 'never'
-
-/**
- * Nuxt Spec options set via `spec` key in nuxt.config.ts.
- * Each option can also be set via respective NUXT_SPEC_* env variable,
- * which takes precedence over the value from nuxt.config.ts.
- */
-export interface NuxtSpecOptions {
-  /**
-   * Include `@nuxt/hints` module.
-   * Env: `NUXT_SPEC_HINTS_ENABLED`
-   * @default true
-   */
-  hints?: boolean
-  /**
-   * WebSocket endpoint of an external Playwright server used by `e2e` and `browser` projects.
-   * Env: `NUXT_SPEC_EXTERNAL_PLAYWRIGHT`
-   */
-  externalPlaywright?: string
-  /** HTML test report settings */
-  htmlReport?: {
-    /**
-     * Generate HTML report after each test run.
-     * Env: `NUXT_SPEC_HTML_REPORT`
-     * @default true
-     */
-    enabled?: boolean
-    /**
-     * When to open the report in the default browser.
-     * Env: `NUXT_SPEC_HTML_REPORT_OPEN`
-     * @default 'failed'
-     */
-    open?: HtmlReportOpenMode
-  }
-  /**
-   * Plain text patterns of log messages that should be omitted.
-   * Env: `NUXT_SPEC_MESSAGE_FILTERS` (comma-separated, added to values from nuxt.config.ts)
-   */
-  messageFilters?: string[]
-}
-
-export interface ResolvedNuxtSpecOptions {
-  hints: boolean
-  externalPlaywright: string | undefined
-  htmlReport: {
-    enabled: boolean
-    open: HtmlReportOpenMode
-  }
-  messageFilters: string[]
-}
-
-export declare const NUXT_SPEC_DEFAULTS: ResolvedNuxtSpecOptions
-
-export declare function resolveSpecOptions(
-  fromConfig?: NuxtSpecOptions | false | null,
-  env?: Record<string, string | undefined>,
-): ResolvedNuxtSpecOptions
-
-export declare function loadSpecOptions(cwd?: string): Promise<ResolvedNuxtSpecOptions>
+export type HtmlReportOpenMode = 'always' | 'failed' | 'never'
+
+/**
+ * Nuxt Spec options set via `spec` key in nuxt.config.ts.
+ * Each option can also be set via respective NUXT_SPEC_* env variable,
+ * which takes precedence over the value from nuxt.config.ts.
+ */
+export interface NuxtSpecOptions {
+  /**
+   * Include `@nuxt/hints` module.
+   * Env: `NUXT_SPEC_HINTS_ENABLED`
+   * @default true
+   */
+  hints?: boolean
+  /**
+   * WebSocket endpoint of an external Playwright server used by `e2e` and `browser` projects.
+   * Env: `NUXT_SPEC_EXTERNAL_PLAYWRIGHT`
+   */
+  externalPlaywright?: string
+  /** HTML test report settings */
+  htmlReport?: {
+    /**
+     * Generate HTML report after each test run.
+     * Env: `NUXT_SPEC_HTML_REPORT`
+     * @default true
+     */
+    enabled?: boolean
+    /**
+     * When to open the report in the default browser.
+     * Env: `NUXT_SPEC_HTML_REPORT_OPEN`
+     * @default 'failed'
+     */
+    open?: HtmlReportOpenMode
+  }
+  /**
+   * Plain text patterns of log messages that should be omitted.
+   * Env: `NUXT_SPEC_MESSAGE_FILTERS` (comma-separated, added to values from nuxt.config.ts)
+   */
+  messageFilters?: string[]
+}
+
+export interface ResolvedNuxtSpecOptions {
+  hints: boolean
+  externalPlaywright: string | undefined
+  htmlReport: {
+    enabled: boolean
+    open: HtmlReportOpenMode
+  }
+  messageFilters: string[]
+}
+
+export declare const NUXT_SPEC_DEFAULTS: ResolvedNuxtSpecOptions
+
+export declare function resolveSpecOptions(
+  fromConfig?: NuxtSpecOptions | false | null,
+  env?: Record<string, string | undefined>,
+): ResolvedNuxtSpecOptions
+
+export declare function loadSpecOptions(cwd?: string): Promise<ResolvedNuxtSpecOptions>

package/config/utils/options.mjs

@@ -1,116 +1,116 @@
-// Nuxt Spec options resolution
-// - values can be set via `spec` key in nuxt.config.ts or via NUXT_SPEC_* env variables
-// - precedence: env variables > nuxt.config.ts > defaults
-
-import { loadNuxtConfig } from 'nuxt/kit'
-
-export const NUXT_SPEC_DEFAULTS = {
-  hints: true,
-  externalPlaywright: undefined,
-  htmlReport: {
-    enabled: true,
-    open: 'failed',
-  },
-  messageFilters: [],
-}
-
-const HTML_REPORT_OPEN_MODES = ['always', 'failed', 'never']
-
-// raw `spec` values per cwd - nuxt.config.ts is only loaded once
-const specCache = new Map()
-
-// options are resolved by both the Nuxt module and the Vitest config in the same process
-const reportedWarnings = new Set()
-
-/**
- * Resolve final Nuxt Spec options.
- * @param {import('./options.d.mts').NuxtSpecOptions | false | null} [fromConfig] - `spec` key from nuxt.config.ts
- * @param {Record<string, string | undefined>} [env] - env variables
- * @returns {import('./options.d.mts').ResolvedNuxtSpecOptions}
- */
-export function resolveSpecOptions(fromConfig, env = process.env) {
-  const config = isObject(fromConfig) ? fromConfig : {}
-  const htmlReport = checkType('htmlReport', config.htmlReport, 'object') ?? {}
-  return {
-    hints: toBoolean(env.NUXT_SPEC_HINTS_ENABLED)
-      ?? checkType('hints', config.hints, 'boolean')
-      ?? NUXT_SPEC_DEFAULTS.hints,
-    externalPlaywright: env.NUXT_SPEC_EXTERNAL_PLAYWRIGHT
-      || checkType('externalPlaywright', config.externalPlaywright, 'string')
-      || NUXT_SPEC_DEFAULTS.externalPlaywright,
-    htmlReport: {
-      enabled: toBoolean(env.NUXT_SPEC_HTML_REPORT)
-        ?? checkType('htmlReport.enabled', htmlReport.enabled, 'boolean')
-        ?? NUXT_SPEC_DEFAULTS.htmlReport.enabled,
-      open: env.NUXT_SPEC_HTML_REPORT_OPEN
-        ? toOpenMode('NUXT_SPEC_HTML_REPORT_OPEN', env.NUXT_SPEC_HTML_REPORT_OPEN)
-        : toOpenMode('htmlReport.open', htmlReport.open),
-    },
-    messageFilters: [
-      ...(checkType('messageFilters', config.messageFilters, 'array') ?? []),
-      ...(env.NUXT_SPEC_MESSAGE_FILTERS?.split(',') ?? []),
-    ]
-      .filter((f) => {
-        if (typeof f === 'string') return true
-        warnInvalid('messageFilters', f, 'string', 'Value is ignored.')
-        return false
-      })
-      .map(f => f.trim())
-      // empty pattern would match (and swallow) every message
-      .filter(Boolean),
-  }
-}
-
-/**
- * Load `spec` key from nuxt.config.ts (including extended layers)
- * and resolve final Nuxt Spec options.
- * @param {string} [cwd] - directory with nuxt.config.ts
- * @returns {Promise<import('./options.d.mts').ResolvedNuxtSpecOptions>}
- */
-export async function loadSpecOptions(cwd = process.cwd()) {
-  if (!specCache.has(cwd)) {
-    specCache.set(cwd, loadNuxtConfig({ cwd })
-      .then(config => config.spec)
-      .catch((error) => {
-        console.warn(`[Nuxt Spec] Failed to read \`spec\` options from nuxt.config: ${error?.message ?? error}`)
-        return undefined
-      }))
-  }
-  return resolveSpecOptions(await specCache.get(cwd))
-}
-
-function isObject(value) {
-  return typeof value === 'object' && value !== null && !Array.isArray(value)
-}
-
-// returns the value if it matches the expected type, otherwise warns and returns undefined
-function checkType(option, value, type) {
-  if (value === undefined) return undefined
-  const matches = type === 'object'
-    ? isObject(value)
-    : type === 'array' ? Array.isArray(value) : typeof value === type
-  if (matches) return value
-  warnInvalid(option, value, type)
-  return undefined
-}
-
-function toOpenMode(option, value) {
-  if (value === undefined) return NUXT_SPEC_DEFAULTS.htmlReport.open
-  const normalized = typeof value === 'string' ? value.trim().toLowerCase() : value
-  if (HTML_REPORT_OPEN_MODES.includes(normalized)) return normalized
-  warnInvalid(option, value, HTML_REPORT_OPEN_MODES.map(m => `'${m}'`).join(' | '))
-  return NUXT_SPEC_DEFAULTS.htmlReport.open
-}
-
-function warnInvalid(option, value, expected, outcome = 'Falling back to default.') {
-  const message = `[Nuxt Spec] Invalid value ${JSON.stringify(value) ?? String(value)} for \`${option}\` (expected ${expected}). ${outcome}`
-  if (reportedWarnings.has(message)) return
-  reportedWarnings.add(message)
-  console.warn(message)
-}
-
-// unset or empty = not defined, only explicit 'false' disables
-function toBoolean(value) {
-  if (value === undefined || value === '') return undefined
-  return value !== 'false'
-}
+// Nuxt Spec options resolution
+// - values can be set via `spec` key in nuxt.config.ts or via NUXT_SPEC_* env variables
+// - precedence: env variables > nuxt.config.ts > defaults
+
+import { loadNuxtConfig } from 'nuxt/kit'
+
+export const NUXT_SPEC_DEFAULTS = {
+  hints: true,
+  externalPlaywright: undefined,
+  htmlReport: {
+    enabled: true,
+    open: 'failed',
+  },
+  messageFilters: [],
+}
+
+const HTML_REPORT_OPEN_MODES = ['always', 'failed', 'never']
+
+// raw `spec` values per cwd - nuxt.config.ts is only loaded once
+const specCache = new Map()
+
+// options are resolved by both the Nuxt module and the Vitest config in the same process
+const reportedWarnings = new Set()
+
+/**
+ * Resolve final Nuxt Spec options.
+ * @param {import('./options.d.mts').NuxtSpecOptions | false | null} [fromConfig] - `spec` key from nuxt.config.ts
+ * @param {Record<string, string | undefined>} [env] - env variables
+ * @returns {import('./options.d.mts').ResolvedNuxtSpecOptions}
+ */
+export function resolveSpecOptions(fromConfig, env = process.env) {
+  const config = isObject(fromConfig) ? fromConfig : {}
+  const htmlReport = checkType('htmlReport', config.htmlReport, 'object') ?? {}
+  return {
+    hints: toBoolean(env.NUXT_SPEC_HINTS_ENABLED)
+      ?? checkType('hints', config.hints, 'boolean')
+      ?? NUXT_SPEC_DEFAULTS.hints,
+    externalPlaywright: env.NUXT_SPEC_EXTERNAL_PLAYWRIGHT
+      || checkType('externalPlaywright', config.externalPlaywright, 'string')
+      || NUXT_SPEC_DEFAULTS.externalPlaywright,
+    htmlReport: {
+      enabled: toBoolean(env.NUXT_SPEC_HTML_REPORT)
+        ?? checkType('htmlReport.enabled', htmlReport.enabled, 'boolean')
+        ?? NUXT_SPEC_DEFAULTS.htmlReport.enabled,
+      open: env.NUXT_SPEC_HTML_REPORT_OPEN
+        ? toOpenMode('NUXT_SPEC_HTML_REPORT_OPEN', env.NUXT_SPEC_HTML_REPORT_OPEN)
+        : toOpenMode('htmlReport.open', htmlReport.open),
+    },
+    messageFilters: [
+      ...(checkType('messageFilters', config.messageFilters, 'array') ?? []),
+      ...(env.NUXT_SPEC_MESSAGE_FILTERS?.split(',') ?? []),
+    ]
+      .filter((f) => {
+        if (typeof f === 'string') return true
+        warnInvalid('messageFilters', f, 'string', 'Value is ignored.')
+        return false
+      })
+      .map(f => f.trim())
+      // empty pattern would match (and swallow) every message
+      .filter(Boolean),
+  }
+}
+
+/**
+ * Load `spec` key from nuxt.config.ts (including extended layers)
+ * and resolve final Nuxt Spec options.
+ * @param {string} [cwd] - directory with nuxt.config.ts
+ * @returns {Promise<import('./options.d.mts').ResolvedNuxtSpecOptions>}
+ */
+export async function loadSpecOptions(cwd = process.cwd()) {
+  if (!specCache.has(cwd)) {
+    specCache.set(cwd, loadNuxtConfig({ cwd })
+      .then(config => config.spec)
+      .catch((error) => {
+        console.warn(`[Nuxt Spec] Failed to read \`spec\` options from nuxt.config: ${error?.message ?? error}`)
+        return undefined
+      }))
+  }
+  return resolveSpecOptions(await specCache.get(cwd))
+}
+
+function isObject(value) {
+  return typeof value === 'object' && value !== null && !Array.isArray(value)
+}
+
+// returns the value if it matches the expected type, otherwise warns and returns undefined
+function checkType(option, value, type) {
+  if (value === undefined) return undefined
+  const matches = type === 'object'
+    ? isObject(value)
+    : type === 'array' ? Array.isArray(value) : typeof value === type
+  if (matches) return value
+  warnInvalid(option, value, type)
+  return undefined
+}
+
+function toOpenMode(option, value) {
+  if (value === undefined) return NUXT_SPEC_DEFAULTS.htmlReport.open
+  const normalized = typeof value === 'string' ? value.trim().toLowerCase() : value
+  if (HTML_REPORT_OPEN_MODES.includes(normalized)) return normalized
+  warnInvalid(option, value, HTML_REPORT_OPEN_MODES.map(m => `'${m}'`).join(' | '))
+  return NUXT_SPEC_DEFAULTS.htmlReport.open
+}
+
+function warnInvalid(option, value, expected, outcome = 'Falling back to default.') {
+  const message = `[Nuxt Spec] Invalid value ${JSON.stringify(value) ?? String(value)} for \`${option}\` (expected ${expected}). ${outcome}`
+  if (reportedWarnings.has(message)) return
+  reportedWarnings.add(message)
+  console.warn(message)
+}
+
+// unset or empty = not defined, only explicit 'false' disables
+function toBoolean(value) {
+  if (value === undefined || value === '') return undefined
+  return value !== 'false'
+}